api

Documentation

Index

• type Group
  • func (f *Group) SetTemplateDefaults() error
• type Types
  • func (f *Types) SetTemplateDefaults() error
• type Webhook
  • func (f *Webhook) SetTemplateDefaults() error
• type WebhookSuite
  • func (f *WebhookSuite) GetCodeFragments() machinery.CodeFragmentsMap
  • func (f *WebhookSuite) GetMarkers() []machinery.Marker
  • func (f *WebhookSuite) SetTemplateDefaults() error
• type WebhookTest
  • func (f *WebhookTest) SetTemplateDefaults() error

Types

type Group

type Group struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin
}

Group scaffolds the file that defines the registration methods for a certain group and version

func (*Group) SetTemplateDefaults

func (f *Group) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type Types

type Types struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin

	Force bool
}

Types scaffolds the file that defines the schema for a CRD nolint:maligned

func (*Types) SetTemplateDefaults

func (f *Types) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type Webhook

type Webhook struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin

	// Is the Group domain for the Resource replacing '.' with '-'
	QualifiedGroupWithDash string

	// Define value for AdmissionReviewVersions marker
	AdmissionReviewVersions string

	Force bool
}

Webhook scaffolds the file that defines a webhook for a CRD or a builtin resource

func (*Webhook) SetTemplateDefaults

func (f *Webhook) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type WebhookSuite

type WebhookSuite struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin

	// todo: currently is not possible to know if an API was or not scaffolded. We can fix it when #1826 be addressed
	WireResource bool

	// K8SVersion define the k8s version used to do the scaffold
	// so that is possible retrieve the binaries
	K8SVersion string

	// BaseDirectoryRelativePath define the Path for the base directory when it is multigroup
	BaseDirectoryRelativePath string
}

WebhookSuite scaffolds the file that sets up the webhook tests

func (*WebhookSuite) GetCodeFragments

func (f *WebhookSuite) GetCodeFragments() machinery.CodeFragmentsMap

GetCodeFragments implements file.Inserter

func (*WebhookSuite) GetMarkers

func (f *WebhookSuite) GetMarkers() []machinery.Marker

GetMarkers implements file.Inserter

func (*WebhookSuite) SetTemplateDefaults

func (f *WebhookSuite) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template

type WebhookTest

type WebhookTest struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin

	Force bool
}

WebhookTest scaffolds the file that sets up the webhook unit tests

func (*WebhookTest) SetTemplateDefaults

func (f *WebhookTest) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template