golang

Documentation

Index

• Constants
• func FindCurrentRepo() (string, error)
• func ValidateGoVersion(min, max GoVersion) error
• type GoVersion
  • func MustParse(verStr string) (v GoVersion)
  • func (v GoVersion) Compare(other GoVersion) int
  • func (v GoVersion) String() string
• type Options
  • func (opts Options) UpdateResource(res *resource.Resource, c config.Config)

Constants

const DefaultNameQualifier = "go." + plugins.DefaultNameQualifier

DefaultNameQualifier is the suffix appended to all kubebuilder plugin names for Golang operators.

Functions

func FindCurrentRepo

func FindCurrentRepo() (string, error)

FindCurrentRepo attempts to determine the current repository though a combination of go/packages and `go mod` commands/tricks.

func ValidateGoVersion

func ValidateGoVersion(min, max GoVersion) error

ValidateGoVersion verifies that Go is installed and the current go version is supported by a plugin.

Types

type GoVersion

type GoVersion struct {
	// contains filtered or unexported fields
}

GoVersion describes a Go version.

func MustParse

func MustParse(verStr string) (v GoVersion)

MustParse will panic if verStr does not match the expected Go version string spec.

func (GoVersion) Compare

func (v GoVersion) Compare(other GoVersion) int

Compare returns -1, 0, or 1 if v < other, v == other, or v > other, respectively.

func (GoVersion) String

func (v GoVersion) String() string

type Options

type Options struct {
	// Plural is the resource's kind plural form.
	Plural string

	// ExternalAPIPath allows to inform a path for APIs not defined in the project
	ExternalAPIPath string

	// ExternalAPIPath allows to inform the resource domain to build the Qualified Group
	// to generate the RBAC markers
	ExternalAPIDomain string

	// Namespaced is true if the resource should be namespaced.
	Namespaced bool

	// Flags that define which parts should be scaffolded
	DoAPI        bool
	DoController bool
	DoDefaulting bool
	DoValidation bool
	DoConversion bool
}

Options contains the information required to build a new resource.Resource.

func (Options) UpdateResource

func (opts Options) UpdateResource(res *resource.Resource, c config.Config)

UpdateResource updates the provided resource with the options