mutating

Documentation

Overview

Package mutating delegates admission checks to dynamically configured mutating webhooks.

Package mutating makes calls to mutating webhooks during the admission process.

Index

• Constants
• func Register(plugins *admission.Plugins)
• type MutationAuditAnnotation
• type PatchAuditAnnotation
• type Plugin
  • func NewMutatingWebhook(configFile io.Reader) (*Plugin, error)
  • func (a *Plugin) Admit(ctx context.Context, attr admission.Attributes, o admission.ObjectInterfaces) error
  • func (a *Plugin) ValidateInitialization() error

Constants

const (
	// PatchAuditAnnotationPrefix is a prefix for persisting webhook patch in audit annotation.
	// Audit handler decides whether annotation with this prefix should be logged based on audit level.
	// Since mutating webhook patches the request body, audit level must be greater or equal to Request
	// for the annotation to be logged
	PatchAuditAnnotationPrefix = "patch.webhook.admission.k8s.io/"
	// MutationAuditAnnotationPrefix is a prefix for presisting webhook mutation existence in audit annotation.
	MutationAuditAnnotationPrefix = "mutation.webhook.admission.k8s.io/"
	// MutationAnnotationFailedOpenKeyPrefix in an annotation indicates
	// the mutating webhook failed open when the webhook backend connection
	// failed or returned an internal server error.
	MutationAuditAnnotationFailedOpenKeyPrefix string = "failed-open." + MutationAuditAnnotationPrefix
)

const (
	// PluginName indicates the name of admission plug-in
	PluginName = "MutatingAdmissionWebhook"
)

Functions

func Register

func Register(plugins *admission.Plugins)

Register registers a plugin

Types

type MutationAuditAnnotation

type MutationAuditAnnotation struct {
	Configuration string `json:"configuration"`
	Webhook       string `json:"webhook"`
	Mutated       bool   `json:"mutated"`
}

MutationAuditAnnotation logs if a webhook invocation mutated the request object

type PatchAuditAnnotation

type PatchAuditAnnotation struct {
	Configuration string      `json:"configuration"`
	Webhook       string      `json:"webhook"`
	Patch         interface{} `json:"patch,omitempty"`
	PatchType     string      `json:"patchType,omitempty"`
}

PatchAuditAnnotation logs a patch from a mutating webhook

type Plugin

type Plugin struct {
	*generic.Webhook
}

Plugin is an implementation of admission.Interface.

func NewMutatingWebhook

func NewMutatingWebhook(configFile io.Reader) (*Plugin, error)

NewMutatingWebhook returns a generic admission webhook plugin.

func (*Plugin) Admit

func (a *Plugin) Admit(ctx context.Context, attr admission.Attributes, o admission.ObjectInterfaces) error

Admit makes an admission decision based on the request attributes.

func (*Plugin) ValidateInitialization

func (a *Plugin) ValidateInitialization() error

ValidateInitialization implements the InitializationValidator interface.