golang

Documentation

Index

• Constants
• func FindCurrentRepo() (string, error)
• func ValidateGoVersion() error
• 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() error

ValidateGoVersion verifies that Go is installed and the current go version is supported by kubebuilder

Types

type Options

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

	// CRDVersion is the CustomResourceDefinition API version that will be used for the resource.
	CRDVersion string
	// WebhookVersion is the {Validating,Mutating}WebhookConfiguration API version that will be used for the resource.
	WebhookVersion 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