templates

Documentation

Index

• type DockerIgnore
  • func (f *DockerIgnore) SetTemplateDefaults() error
• type Dockerfile
  • func (f *Dockerfile) SetTemplateDefaults() error
• type GitIgnore
  • func (f *GitIgnore) SetTemplateDefaults() error
• type GoMod
  • func (f *GoMod) SetTemplateDefaults() error
• type Main
  • func (f *Main) SetTemplateDefaults() error
• type MainUpdater
  • func (f *MainUpdater) GetCodeFragments() machinery.CodeFragmentsMap
  • func (*MainUpdater) GetIfExistsAction() machinery.IfExistsAction
  • func (f *MainUpdater) GetMarkers() []machinery.Marker
  • func (f *MainUpdater) GetPath() string
• type Makefile
  • func (f *Makefile) SetTemplateDefaults() error
• type Metadata
  • func (f *Metadata) SetTemplateDefaults() error
• type Readme
  • func (f *Readme) SetTemplateDefaults() error

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
	IsLegacyLayout bool
}

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

func (f *GitIgnore) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type GoMod

type GoMod struct {
	machinery.TemplateMixin
	machinery.RepositoryMixin

	ControllerRuntimeVersion   string
	EndpointOperatorLibVersion string
}

GoMod scaffolds a file that defines the project dependencies

func (*GoMod) SetTemplateDefaults

func (f *GoMod) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type Main

type Main struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.DomainMixin
	machinery.RepositoryMixin
	// IsLegacyLayout is added to ensure backwards compatibility and should
	// be removed when we remove the go/v3 plugin
	IsLegacyLayout bool
}

Main scaffolds a file that defines the controller manager entry point

func (*Main) SetTemplateDefaults

func (f *Main) SetTemplateDefaults() error

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
	// IsLegacyLayout is added to ensure backwards compatibility and should
	// be removed when we remove the go/v3 plugin
	IsLegacyLayout bool
}

MainUpdater updates cmd/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

func (*MainUpdater) GetPath

func (f *MainUpdater) GetPath() string

GetPath implements file.Builder

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
	// Helm version to use in the project
	HelmVersion string
	// ControllerRuntimeVersion version to be used to download the envtest setup script
	ControllerRuntimeVersion string
	// EndpointOperatorLibVersion version to be used to download the envtest setup script
	EndpointOperatorLibVersion string
	// ControllerToolsVersion4Helm version to be used to download the envtest setup script
	ControllerToolsVersion4Helm string
	//IsLegacyLayout indicates if the project is using the legacy layout
	IsLegacyLayout bool
	MainGO         string
}

Makefile scaffolds a file that defines project management CLI commands

func (*Makefile) SetTemplateDefaults

func (f *Makefile) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type Metadata

type Metadata struct {
	machinery.TemplateMixin
	IsLegacyLayout bool
}

Metadata scaffolds a file that defines which files should be ignored by git

func (*Metadata) SetTemplateDefaults

func (f *Metadata) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type Readme

type Readme struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.ProjectNameMixin

	License string
}

Readme scaffolds a README.md file

func (*Readme) SetTemplateDefaults

func (f *Readme) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template