Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DockerIgnore ¶
type DockerIgnore struct {
machinery.TemplateMixin
}
DockerIgnore scaffolds a file that defines which files should be ignored by the containerized build process
func (*DockerIgnore) SetTemplateDefaults ¶
func (f *DockerIgnore) SetTemplateDefaults() error
SetTemplateDefaults implements file.Template
type Dockerfile ¶
type Dockerfile struct {
machinery.TemplateMixin
}
Dockerfile scaffolds a file that defines the containerized build process
func (*Dockerfile) SetTemplateDefaults ¶
func (f *Dockerfile) SetTemplateDefaults() error
SetTemplateDefaults implements file.Template
type GitIgnore ¶
type GitIgnore struct {
machinery.TemplateMixin
}
GitIgnore scaffolds a file that defines which files should be ignored by git
func (*GitIgnore) SetTemplateDefaults ¶
SetTemplateDefaults implements file.Template
type GoMod ¶
type GoMod struct {
machinery.TemplateMixin
machinery.RepositoryMixin
ControllerRuntimeVersion string
}
GoMod scaffolds a file that defines the project dependencies
func (*GoMod) SetTemplateDefaults ¶
SetTemplateDefaults implements file.Template
type Main ¶
type Main struct {
machinery.TemplateMixin
machinery.BoilerplateMixin
machinery.DomainMixin
machinery.RepositoryMixin
machinery.ComponentConfigMixin
}
Main scaffolds a file that defines the controller manager entry point
func (*Main) SetTemplateDefaults ¶
SetTemplateDefaults implements file.Template
type MainUpdater ¶
type MainUpdater struct {
machinery.RepositoryMixin
machinery.MultiGroupMixin
machinery.ResourceMixin
// Flags to indicate which parts need to be included when updating the file
WireResource, WireController, WireWebhook bool
}
MainUpdater updates main.go to run Controllers
func (*MainUpdater) GetCodeFragments ¶
func (f *MainUpdater) GetCodeFragments() machinery.CodeFragmentsMap
GetCodeFragments implements file.Inserter
func (*MainUpdater) GetIfExistsAction ¶
func (*MainUpdater) GetIfExistsAction() machinery.IfExistsAction
GetIfExistsAction implements file.Builder
func (*MainUpdater) GetMarkers ¶
func (f *MainUpdater) GetMarkers() []machinery.Marker
GetMarkers implements file.Inserter
type Makefile ¶
type Makefile struct {
machinery.TemplateMixin
machinery.ComponentConfigMixin
machinery.ProjectNameMixin
// Image is controller manager image name
Image string
// BoilerplatePath is the path to the boilerplate file
BoilerplatePath string
// Controller tools version to use in the project
ControllerToolsVersion string
// Kustomize version to use in the project
KustomizeVersion string
// ControllerRuntimeVersion version to be used to download the envtest setup script
ControllerRuntimeVersion string
}
Makefile scaffolds a file that defines project management CLI commands
func (*Makefile) SetTemplateDefaults ¶
SetTemplateDefaults implements file.Template
type Readme ¶ added in v3.4.0
type Readme struct {
machinery.TemplateMixin
machinery.BoilerplateMixin
machinery.ProjectNameMixin
License string
}
Readme scaffolds a README.md file
func (*Readme) SetTemplateDefaults ¶ added in v3.4.0
SetTemplateDefaults implements file.Template