controller-tools: sigs.k8s.io/controller-tools/pkg/webhook Index | Files

package webhook

import "sigs.k8s.io/controller-tools/pkg/webhook"

Package webhook contains libraries for generating webhookconfig manifests from markers in Go source files.

The markers take the form:

+kubebuilder:webhook:failurePolicy=<string>,matchPolicy=<string>,groups=<[]string>,resources=<[]string>,verbs=<[]string>,versions=<[]string>,name=<string>,path=<string>,mutating=<bool>,sideEffects=<string>

Index

Package Files

parser.go zz_generated.markerhelp.go

Variables

var (
    // ConfigDefinition s a marker for defining Webhook manifests.
    // Call ToWebhook on the value to get a Kubernetes Webhook.
    ConfigDefinition = markers.Must(markers.MakeDefinition("kubebuilder:webhook", markers.DescribesPackage, Config{}))
)

type Config Uses

type Config struct {
    // Mutating marks this as a mutating webhook (it's validating only if false)
    //
    // Mutating webhooks are allowed to change the object in their response,
    // and are called *before* all validating webhooks.  Mutating webhooks may
    // choose to reject an object, similarly to a validating webhook.
    Mutating bool
    // FailurePolicy specifies what should happen if the API server cannot reach the webhook.
    //
    // It may be either "ignore" (to skip the webhook and continue on) or "fail" (to reject
    // the object in question).
    FailurePolicy string
    // MatchPolicy defines how the "rules" list is used to match incoming requests.
    // Allowed values are "Exact" (match only if it exactly matches the specified rule)
    // or "Equivalent" (match a request if it modifies a resource listed in rules, even via another API group or version).
    MatchPolicy string `marker:",optional"`
    // SideEffects specify whether calling the webhook will have side effects.
    // This has an impact on dry runs and `kubectl diff`: if the sideEffect is "Unknown" (the default) or "Some", then
    // the API server will not call the webhook on a dry-run request and fails instead.
    // If the value is "None", then the webhook has no side effects and the API server will call it on dry-run.
    // If the value is "NoneOnDryRun", then the webhook is responsible for inspecting the "dryRun" property of the
    // AdmissionReview sent in the request, and avoiding side effects if that value is "true."
    SideEffects string `marker:",optional"`

    // Groups specifies the API groups that this webhook receives requests for.
    Groups []string
    // Resources specifies the API resources that this webhook receives requests for.
    Resources []string
    // Verbs specifies the Kubernetes API verbs that this webhook receives requests for.
    //
    // Only modification-like verbs may be specified.
    // May be "create", "update", "delete", "connect", or "*" (for all).
    Verbs []string
    // Versions specifies the API versions that this webhook receives requests for.
    Versions []string

    // Name indicates the name of this webhook configuration. Should be a domain with at least three segments separated by dots
    Name string

    // Path specifies that path that the API server should connect to this webhook on. Must be
    // prefixed with a '/validate-' or '/mutate-' depending on the type, and followed by
    // $GROUP-$VERSION-$KIND where all values are lower-cased and the periods in the group
    // are substituted for hyphens. For example, a validating webhook path for type
    // batch.tutorial.kubebuilder.io/v1,Kind=CronJob would be
    // /validate-batch-tutorial-kubebuilder-io-v1-cronjob
    Path string
}

Config specifies how a webhook should be served.

It specifies only the details that are intrinsic to the application serving it (e.g. the resources it can handle, or the path it serves on).

func (Config) Help Uses

func (Config) Help() *markers.DefinitionHelp

func (Config) ToMutatingWebhook Uses

func (c Config) ToMutatingWebhook() (admissionreg.MutatingWebhook, error)

ToMutatingWebhook converts this rule to its Kubernetes API form.

func (Config) ToValidatingWebhook Uses

func (c Config) ToValidatingWebhook() (admissionreg.ValidatingWebhook, error)

ToValidatingWebhook converts this rule to its Kubernetes API form.

type Generator Uses

type Generator struct{}

Generator generates (partial) {Mutating,Validating}WebhookConfiguration objects.

func (Generator) Generate Uses

func (Generator) Generate(ctx *genall.GenerationContext) error

func (Generator) Help Uses

func (Generator) Help() *markers.DefinitionHelp

func (Generator) RegisterMarkers Uses

func (Generator) RegisterMarkers(into *markers.Registry) error

Package webhook imports 6 packages (graph) and is imported by 2 packages. Updated 2020-04-30. Refresh now. Tools for package owners.