import "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
Package admission provides implementation for admission webhook and methods to implement admission webhook handlers.
See examples/mutatingwebhook.go and examples/validatingwebhook.go for examples of admission webhooks.
decode.go defaulter.go doc.go http.go inject.go multi.go response.go validator.go webhook.go
InjectDecoderInto will set decoder on i and return the result if it implements Decoder. Returns false if i does not implement Decoder.
type Decoder struct {
// contains filtered or unexported fields
}Decoder knows how to decode the contents of an admission request into a concrete object.
NewDecoder creates a Decoder given the runtime.Scheme
Decode decodes the inlined object in the AdmissionRequest into the passed-in runtime.Object. If you want decode the OldObject in the AdmissionRequest, use DecodeRaw. It errors out if req.Object.Raw is empty i.e. containing 0 raw bytes.
DecodeRaw decodes a RawExtension object into the passed-in runtime.Object. It errors out if rawObj is empty i.e. containing 0 raw bytes.
DecoderInjector is used by the ControllerManager to inject decoder into webhook handlers.
Defaulter defines functions for setting defaults on resources
type Handler interface {
// Handle yields a response to an AdmissionRequest.
//
// The supplied context is extracted from the received http.Request, allowing wrapping
// http.Handlers to inject values into and control cancelation of downstream request processing.
Handle(context.Context, Request) Response
}Handler can handle an AdmissionRequest.
MultiMutatingHandler combines multiple mutating webhook handlers into a single mutating webhook handler. Handlers are called in sequential order, and the first `allowed: false` response may short-circuit the rest. Users must take care to ensure patches are disjoint.
MultiValidatingHandler combines multiple validating webhook handlers into a single validating webhook handler. Handlers are called in sequential order, and the first `allowed: false` response may short-circuit the rest.
HandlerFunc implements Handler interface using a single function.
Handle process the AdmissionRequest by invoking the underlying function.
type Request struct {
admissionv1beta1.AdmissionRequest
}Request defines the input for an admission handler. It contains information to identify the object in question (group, version, kind, resource, subresource, name, namespace), as well as the operation in question (e.g. Get, Create, etc), and the object itself.
type Response struct {
// Patches are the JSON patches for mutating webhooks.
// Using this instead of setting Response.Patch to minimize
// overhead of serialization and deserialization.
// Patches set here will override any patches in the response,
// so leave this empty if you want to set the patch response directly.
Patches []jsonpatch.JsonPatchOperation
// AdmissionResponse is the raw admission response.
// The Patch field in it will be overwritten by the listed patches.
admissionv1beta1.AdmissionResponse
}Response is the output of an admission handler. It contains a response indicating if a given operation is allowed, as well as a set of patches to mutate the object in the case of a mutating admission handler.
Allowed constructs a response indicating that the given operation is allowed (without any patches).
Denied constructs a response indicating that the given operation is not allowed.
Errored creates a new Response for error-handling a request.
PatchResponseFromRaw takes 2 byte arrays and returns a new response with json patch. The original object should be passed in as raw bytes to avoid the roundtripping problem described in https://github.com/kubernetes-sigs/kubebuilder/issues/510.
Patched constructs a response indicating that the given operation is allowed, and that the target object should be modified by the given JSONPatch operations.
ValidationResponse returns a response for admitting a request.
Complete populates any fields that are yet to be set in the underlying AdmissionResponse, It mutates the response.
WithWarnings adds the given warnings to the Response. If any warnings were already given, they will not be overwritten.
type Validator interface {
runtime.Object
ValidateCreate() error
ValidateUpdate(old runtime.Object) error
ValidateDelete() error
}Validator defines functions for validating an operation
type Webhook struct {
// Handler actually processes an admission request returning whether it was allowed or denied,
// and potentially patches to apply to the handler.
Handler Handler
// contains filtered or unexported fields
}Webhook represents each individual webhook.
DefaultingWebhookFor creates a new Webhook for Defaulting the provided type.
ValidatingWebhookFor creates a new Webhook for validating the provided type.
GetDecoder returns a decoder to decode the objects embedded in admission requests. It may be nil if we haven't received a scheme to use to determine object types yet.
Handle processes AdmissionRequest. If the webhook is mutating type, it delegates the AdmissionRequest to each handler and merge the patches. If the webhook is validating type, it delegates the AdmissionRequest to each handler and deny the request if anyone denies.
InjectFunc injects the field setter into the webhook.
InjectLogger gets a handle to a logging instance, hopefully with more info about this particular webhook.
InjectScheme injects a scheme into the webhook, in order to construct a Decoder.
Package admission imports 19 packages (graph) and is imported by 126 packages. Updated 2020-09-20. Refresh now. Tools for package owners.