templates

Documentation

Index

• Variables
• type Dockerfile
  • func (f *Dockerfile) 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 (*MainUpdater) GetPath() string
• type Makefile
  • func (f *Makefile) SetTemplateDefaults() error
• type Readme
  • func (f *Readme) SetTemplateDefaults() error

Variables

var ErrInvalidImage = errors.New("invalid image")

Types

type Dockerfile

type Dockerfile struct {
	machinery.TemplateMixin

	GoVersion string
}

Dockerfile scaffolds a file that defines the containerized build process.

func (*Dockerfile) SetTemplateDefaults

func (f *Dockerfile) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template.

type GoMod

type GoMod struct {
	machinery.TemplateMixin
	machinery.RepositoryMixin

	GoVersionMinimum     string
	Dependencies         map[string]string
	IndirectDependencies map[string]string
}

GoMod scaffolds a file that defines the project dependencies.

func (*GoMod) SetTemplateDefaults

func (f *GoMod) SetTemplateDefaults() error

type Main

type Main struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.DomainMixin
	machinery.RepositoryMixin
	machinery.ComponentConfigMixin
}

Main adds API-specific scaffolding to main.go.

func (*Main) SetTemplateDefaults

func (f *Main) SetTemplateDefaults() error

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
}

func (*MainUpdater) GetCodeFragments

func (f *MainUpdater) GetCodeFragments() machinery.CodeFragmentsMap

func (*MainUpdater) GetIfExistsAction

func (*MainUpdater) GetIfExistsAction() machinery.IfExistsAction

func (*MainUpdater) GetMarkers

func (f *MainUpdater) GetMarkers() []machinery.Marker

func (*MainUpdater) GetPath

func (*MainUpdater) GetPath() string

type Makefile

type Makefile struct {
	machinery.TemplateMixin
	machinery.RepositoryMixin
	machinery.ProjectNameMixin
	machinery.DomainMixin

	RootCmdName   string
	CrdOptions    string
	ControllerImg string
	EnableOLM     bool

	ControllerToolsVersion   string
	KustomizeVersion         string
	OperatorSDKVersion       string
	ControllerRuntimeVersion string
	EnvtestVersion           string
	EnvtestK8SVersion        string
	GolangCILintVersion      string
}

Makefile scaffolds the project Makefile.

func (*Makefile) SetTemplateDefaults

func (f *Makefile) SetTemplateDefaults() error

type Readme

type Readme struct {
	machinery.TemplateMixin

	RootCmdName         string
	EnableOLM           bool
	ControllerImg       string
	ControllerBundleImg string
}

Readme scaffolds a file that defines the templated README.md instructions for a custom workload.

func (*Readme) SetTemplateDefaults

func (f *Readme) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template.