scaffold

Documentation

Overview

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

Index

• Constants
• type Scaffolder
  • func NewAPIScaffolder(config *config.Config, boilerplate string, res *resource.Resource, ...) Scaffolder
  • func NewEditScaffolder(config *config.Config, multigroup bool) Scaffolder
  • func NewInitScaffolder(config *config.Config, license, owner string) Scaffolder
  • func NewUpdateScaffolder(config *config.Config) Scaffolder
  • func NewV1WebhookScaffolder(config *config.Config, boilerplate string, resource *resource.Resource, ...) Scaffolder
  • func NewV2WebhookScaffolder(config *config.Config, boilerplate string, resource *resource.Resource, ...) Scaffolder

Constants

const (
	// ControllerRuntimeVersion is the kubernetes-sigs/controller-runtime version to be used in the project
	ControllerRuntimeVersion = "v0.5.0"
	// ControllerToolsVersion is the kubernetes-sigs/controller-tools version to be used in the project
	ControllerToolsVersion = "v0.2.5"
)

Types

type Scaffolder

type Scaffolder interface {
	// Scaffold performs the scaffolding
	Scaffold() error
}

Scaffolder interface creates files to set up a controller manager

func NewAPIScaffolder

func NewAPIScaffolder(
	config *config.Config,
	boilerplate string,
	res *resource.Resource,
	doResource, doController bool,
	plugins []model.Plugin,
) Scaffolder

NewAPIScaffolder returns a new Scaffolder for API/controller creation operations

func NewEditScaffolder

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

NewEditScaffolder returns a new Scaffolder for configuration edit operations

func NewInitScaffolder

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

NewInitScaffolder returns a new Scaffolder for project initialization operations

func NewUpdateScaffolder

func NewUpdateScaffolder(config *config.Config) Scaffolder

NewUpdateScaffolder returns a new Scaffolder for vendor update operations

func NewV1WebhookScaffolder

func NewV1WebhookScaffolder(
	config *config.Config,
	boilerplate string,
	resource *resource.Resource,
	server string,
	webhookType string,
	operations []string,
) Scaffolder

NewV1WebhookScaffolder returns a new Scaffolder for v1 webhook creation operations

func NewV2WebhookScaffolder

func NewV2WebhookScaffolder(
	config *config.Config,
	boilerplate string,
	resource *resource.Resource,
	defaulting bool,
	validation bool,
	conversion bool,
) Scaffolder

NewV2WebhookScaffolder returns a new Scaffolder for v2 webhook creation operations