README
¶
Testing
In order to run all tests in this package you must set the REMOTE_CLUSTER_CONTEXT env var to the name of a context in
your kubeconfig. To quickly provision two kind clusters for testing, run
./ci/setup-kind.sh <remote-context-name>. This will create two kind clusters, skv2-test-master and
<remote-context-name>, and set your current context to kind-skv2-test-master. To run the multicluster tests in this
package, you can then use REMOTE_CLUSTER_CONTEXT=kind-<remote-context-name> TEST_PKG=codegen/render make run-tests.
To cleanup the kind clusters, run ./ci/teardown-kind.sh.
Documentation
¶
Index ¶
- Variables
- func KubeCodegen(group Group) error
- func PrependMockgenDirective(files []OutFile)
- func SetVersionForObject(obj metav1.Object, version string)
- type BuildRenderer
- type ChartRenderer
- type Field
- type Group
- type KubeCodeRenderer
- type MakeResourceFunc
- type ManifestsRenderer
- type OutFile
- func RenderApiTypes(grp Group) ([]OutFile, error)
- func RenderBuild(build model.Build) ([]OutFile, error)
- func RenderChart(chart model.Chart) ([]OutFile, error)
- func RenderManifests(appName, manifestDir, protoDir string, protoOpts protoutil.Options, grp Group) ([]OutFile, error)
- func RenderProtoTypes(grp Group) ([]OutFile, error)
- type ProtoCodeRenderer
- type Resource
- type TemplateRenderer
Constants ¶
This section is empty.
Variables ¶
View Source
var ClientsTemplates = inputTemplates{
"code/types/clients.gotmpl": {
Path: "clients.go",
},
"code/types/type_helpers.gotmpl": {
Path: "type_helpers.go",
},
}
View Source
var ControllerTemplates = inputTemplates{
"code/controller/event_handlers.gotmpl": {
Path: "controller/event_handlers.go",
},
"code/controller/reconcilers.gotmpl": {
Path: "controller/reconcilers.go",
},
"code/controller/multicluster_reconcilers.gotmpl": {
Path: "controller/multicluster_reconcilers.go",
},
}
View Source
var DefaultTemplateRenderer = templateRenderer{
// contains filtered or unexported fields
}
View Source
var TypesTemplates = func(skipDeepCopy bool) inputTemplates {
tmpl := inputTemplates{
"code/types/types.gotmpl": {
Path: "types.go",
},
"code/types/register.gotmpl": {
Path: "register.go",
},
"code/types/doc.gotmpl": {
Path: "doc.go",
},
"code/types/zz_generated.deepcopy.gotmpl": {
Path: "zz_generated.deepcopy.go",
},
}
if skipDeepCopy {
delete(tmpl, "code/types/zz_generated.deepcopy.gotmpl")
}
return tmpl
}
Functions ¶
func KubeCodegen ¶
func KubeCodegen(group Group) error
runs kubernetes code-generator.sh cannot be used to write output to memory also generates deecopy code
func PrependMockgenDirective ¶ added in v0.7.17
func PrependMockgenDirective(files []OutFile)
func SetVersionForObject ¶ added in v0.19.1
func SetVersionForObject(obj metav1.Object, version string)
Types ¶
type BuildRenderer ¶
type BuildRenderer struct {
// contains filtered or unexported fields
}
renders files used to build the operator
func (BuildRenderer) RenderCustomTemplates ¶
func (r BuildRenderer) RenderCustomTemplates(customTemplates map[string]string, customFuncs template.FuncMap, data interface{}) ([]OutFile, error)
type ChartRenderer ¶
type ChartRenderer struct {
// contains filtered or unexported fields
}
func (ChartRenderer) RenderCustomTemplates ¶
func (r ChartRenderer) RenderCustomTemplates(customTemplates map[string]string, customFuncs template.FuncMap, data interface{}) ([]OutFile, error)
type KubeCodeRenderer ¶
type KubeCodeRenderer struct {
// the templates to use for rendering kube kypes
TypesTemplates inputTemplates
// the templates to use for rendering typed kube clients which use the underlying cache
ClientsTemplates inputTemplates
// the templates to use for rendering kube controllers
ControllerTemplates inputTemplates
// the go module of the project
GoModule string
// the relative path to the api dir
// types will render in the package <module>/<apiRoot>/<group>/<version>
ApiRoot string
// contains filtered or unexported fields
}
renders kubernetes from templates
func (KubeCodeRenderer) RenderCustomTemplates ¶
func (r KubeCodeRenderer) RenderCustomTemplates(customTemplates map[string]string, customFuncs template.FuncMap, data interface{}) ([]OutFile, error)
func (KubeCodeRenderer) RenderKubeCode ¶
func (r KubeCodeRenderer) RenderKubeCode(grp Group) ([]OutFile, error)
type MakeResourceFunc ¶
type MakeResourceFunc func(group Group) ([]metav1.Object, error)
creates a k8s resource for a group this gets turned into a k8s manifest file
type ManifestsRenderer ¶
type ManifestsRenderer struct {
AppName string // used for labeling
ResourceFuncs map[OutFile]MakeResourceFunc
ManifestDir string
ProtoDir string
}
renders kubernetes from templates
func (ManifestsRenderer) RenderManifests ¶
func (r ManifestsRenderer) RenderManifests(grp Group, protoOpts protoutil.Options) ([]OutFile, error)
type OutFile ¶
type OutFile struct {
Path string
Permission os.FileMode
Content string // set by Renderer
}
func RenderApiTypes ¶
func RenderApiTypes(grp Group) ([]OutFile, error)
func RenderBuild ¶
func RenderBuild(build model.Build) ([]OutFile, error)
func RenderChart ¶
func RenderChart(chart model.Chart) ([]OutFile, error)
func RenderManifests ¶
func RenderManifests(
appName, manifestDir, protoDir string,
protoOpts protoutil.Options,
grp Group,
) ([]OutFile, error)
func RenderProtoTypes ¶
func RenderProtoTypes(grp Group) ([]OutFile, error)
type ProtoCodeRenderer ¶
type ProtoCodeRenderer struct {
// the go module of the project
GoModule string
// the relative path to the api dir
// types will render in the package <module>/<apiRoot>/<group>/<version>
ApiRoot string
// contains filtered or unexported fields
}
renders kubernetes from templates
func (ProtoCodeRenderer) RenderCustomTemplates ¶
func (r ProtoCodeRenderer) RenderCustomTemplates(customTemplates map[string]string, customFuncs template.FuncMap, data interface{}) ([]OutFile, error)
func (ProtoCodeRenderer) RenderProtoHelpers ¶
func (r ProtoCodeRenderer) RenderProtoHelpers(grp Group) ([]OutFile, error)
type TemplateRenderer ¶
type TemplateRenderer interface {
RenderCustomTemplates(customTemplates map[string]string, customFuncs template.FuncMap, data interface{}) ([]OutFile, error)
}
exported interface for using to render templates
Source Files
Click to show internal directories.
Click to hide internal directories.