project

Documentation

Index

• Constants
• type Boilerplate
  • func (c *Boilerplate) GetInput() (input.Input, error)
• type GitIgnore
  • func (c *GitIgnore) GetInput() (input.Input, error)
• type GopkgToml
  • func (g *GopkgToml) GetInput() (input.Input, error)
• type Kustomize
  • func (c *Kustomize) GetInput() (input.Input, error)
• type KustomizeImagePatch
  • func (c *KustomizeImagePatch) GetInput() (input.Input, error)
• type Makefile
  • func (c *Makefile) GetInput() (input.Input, error)
• type Project
  • func (c *Project) GetInput() (input.Input, error)
• type Stanza

Constants

const DefaultGopkgHeader = "# STANZAS BELOW ARE GENERATED AND MAY BE WRITTEN - DO NOT MODIFY BELOW THIS LINE."

DefaultGopkgHeader is the default header used to separate user managed lines and controller-manager managed lines

const DefaultGopkgUserContent = `` /* 870-byte string literal not displayed */

DefaultGopkgUserContent is the default user managed lines to provide.

Types

type Boilerplate

type Boilerplate struct {
	input.Input

	// License is the License type to write
	License string

	// Owner is the copyright owner - e.g. "The Kubernetes Authors"
	Owner string

	// Year is the copyright year
	Year string
}

Boilerplate scaffolds a boilerplate header file.

func (*Boilerplate) GetInput

func (c *Boilerplate) GetInput() (input.Input, error)

GetInput implements input.File

type GitIgnore

type GitIgnore struct {
	input.Input
}

GitIgnore scaffolds the .gitignore file

func (*GitIgnore) GetInput

func (c *GitIgnore) GetInput() (input.Input, error)

GetInput implements input.File

type GopkgToml

type GopkgToml struct {
	input.Input

	// ManagedHeader is the header to write after the user owned pieces and before the managed parts of the Gopkg.toml
	ManagedHeader string

	// DefaultGopkgUserContent is the default content to use for the user owned pieces
	DefaultUserContent string

	// UserContent is the content to use for the user owned pieces
	UserContent string

	// Stanzas are additional managed stanzas to add after the ManagedHeader
	Stanzas []Stanza
}

GopkgToml writes a templatefile for Gopkg.toml

func (*GopkgToml) GetInput

func (g *GopkgToml) GetInput() (input.Input, error)

GetInput implements input.File

type Kustomize

type Kustomize struct {
	input.Input

	// Prefix to use for name prefix customization
	Prefix string
}

Kustomize scaffolds the Kustomization file.

func (*Kustomize) GetInput

func (c *Kustomize) GetInput() (input.Input, error)

GetInput implements input.File

type KustomizeImagePatch

type KustomizeImagePatch struct {
	input.Input

	// ImageURL to use for controller image in manager's manifest.
	ImageURL string
}

KustomizeImagePatch scaffolds the patch file for customizing image URL manifest file for manager resource.

func (*KustomizeImagePatch) GetInput

func (c *KustomizeImagePatch) GetInput() (input.Input, error)

GetInput implements input.File

type Makefile

type Makefile struct {
	input.Input
	// Image is controller manager image name
	Image string

	// path for controller-tools pkg
	ControllerToolsPath string
}

Makefile scaffolds the Makefile

func (*Makefile) GetInput

func (c *Makefile) GetInput() (input.Input, error)

GetInput implements input.File

type Project

type Project struct {
	// Path is the output file location - defaults to PROJECT
	Path string

	input.ProjectFile
}

Project scaffolds the PROJECT file with project metadata

func (*Project) GetInput

func (c *Project) GetInput() (input.Input, error)

GetInput implements input.File

type Stanza

type Stanza struct {
	// Type will be between the'[[]]' e.g. override
	Type string

	// Name will appear after 'name=' and does not include quotes e.g. k8s.io/client-go
	Name string
	// Version will appear after 'version=' and does not include quotes
	Version string

	// Revision will appear after 'revsion=' and does not include quotes
	Revision string
}

Stanza is a single Gopkg.toml entry