scaffolds

Documentation

Overview

Package scaffolds contains libraries for scaffolding code to use with controller-runtime

Index

• Constants
• func NewAPIScaffolder(config config.Config, res resource.Resource, force bool) plugins.Scaffolder
• func NewEditScaffolder(config config.Config, multigroup bool) plugins.Scaffolder
• func NewInitScaffolder(config config.Config, license, owner string) plugins.Scaffolder
• func NewWebhookScaffolder(config config.Config, resource resource.Resource) plugins.Scaffolder

Constants

const (
	// ControllerRuntimeVersion is the kubernetes-sigs/controller-runtime version to be used in the project
	ControllerRuntimeVersion = "v0.6.4"
	// ControllerToolsVersion is the kubernetes-sigs/controller-tools version to be used in the project
	ControllerToolsVersion = "v0.3.0"
	// KustomizeVersion is the kubernetes-sigs/kustomize version to be used in the project
	// @Deprecate: KustomizeVersion came from the Kustomize plugin since go/v3
	// Go/v2 plugin exist only to ensure the backwards compatibility with the old scaffold
	// produced with kubebuilder >= 2.0.0 < 3.0.0. It does not take advantage of the plugin system
	// (see that the PROJECT file does not have the layout of the plugin and uses the old/legacy
	// version/schema.) This plugin will be deprecated with go/v4 and can be removed
	// when go/v4 stable is published.
	KustomizeVersion = "v3.5.4"
)

Functions

func NewAPIScaffolder

func NewAPIScaffolder(config config.Config, res resource.Resource, force bool) plugins.Scaffolder

NewAPIScaffolder returns a new Scaffolder for API/controller creation operations

func NewEditScaffolder

func NewEditScaffolder(config config.Config, multigroup bool) plugins.Scaffolder

NewEditScaffolder returns a new Scaffolder for configuration edit operations

func NewInitScaffolder

func NewInitScaffolder(config config.Config, license, owner string) plugins.Scaffolder

NewInitScaffolder returns a new Scaffolder for project initialization operations

func NewWebhookScaffolder

func NewWebhookScaffolder(config config.Config, resource resource.Resource) plugins.Scaffolder

NewWebhookScaffolder returns a new Scaffolder for v2 webhook creation operations