webhooks

Documentation

Index

• 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 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

	// Deprecated - The flag should be removed from go/v5
	// IsLegacyPath indicates if webhooks should be scaffolded under the API.
	// Webhooks are now decoupled from APIs based on controller-runtime updates and community feedback.
	// This flag ensures backward compatibility by allowing scaffolding in the legacy/deprecated path.
	IsLegacyPath 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

	// Deprecated - The flag should be removed from go/v5
	// IsLegacyPath indicates if webhooks should be scaffolded under the API.
	// Webhooks are now decoupled from APIs based on controller-runtime updates and community feedback.
	// This flag ensures backward compatibility by allowing scaffolding in the legacy/deprecated path.
	IsLegacyPath bool
}

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

	// Deprecated - The flag should be removed from go/v5
	// IsLegacyPath indicates if webhooks should be scaffolded under the API.
	// Webhooks are now decoupled from APIs based on controller-runtime updates and community feedback.
	// This flag ensures backward compatibility by allowing scaffolding in the legacy/deprecated path.
	IsLegacyPath bool
}

WebhookTest scaffolds the file that sets up the webhook unit tests

func (*WebhookTest) SetTemplateDefaults

func (f *WebhookTest) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template