ValidatingWebhookConfiguration

    apiVersion: admissionregistration.k8s.io/v1

    import "k8s.io/api/admissionregistration/v1"

    ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

    • apiVersion: admissionregistration.k8s.io/v1

    • kind: ValidatingWebhookConfiguration

    • metadata ()

      Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.

    • webhooks ([]ValidatingWebhook)

      Patch strategy: merge on key name

      Webhooks is a list of webhooks and the affected resources and operations.

      ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

      • webhooks.admissionReviewVersions ([]string), required

        AdmissionReviewVersions is an ordered list of preferred AdmissionReview versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.

      • webhooks.name (string), required

        The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where “imagepolicy” is the name of the webhook, and kubernetes.io is the name of the organization. Required.

      • webhooks.sideEffects (string), required

        SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.

      • webhooks.failurePolicy (string)

        FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.

      • webhooks.matchPolicy (string)

        matchPolicy defines how the “rules” list is used to match incoming requests. Allowed values are “Exact” or “Equivalent”.

        • Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but “rules” only included apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"], a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.

        • Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and “rules” only included apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"], a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.

        Defaults to “Equivalent”

      • webhooks.namespaceSelector ()

        NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook.

        For example, to run the webhook on any objects whose namespace is not associated with “runlevel” of “0” or “1”; you will set the selector as follows: “namespaceSelector”: { “matchExpressions”: [ { “key”: “runlevel”, “operator”: “NotIn”, “values”: [ “0”, “1” ] } ] }

        If instead you want to only run the webhook on any objects whose namespace is associated with the “environment” of “prod” or “staging”; you will set the selector as follows: “namespaceSelector”: { “matchExpressions”: [ { “key”: “environment”, “operator”: “In”, “values”: [ “prod”, “staging” ] } ] }

        See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors.

        Default to the empty LabelSelector, which matches everything.

      • webhooks.objectSelector ()

        ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.

      • webhooks.rules ([]RuleWithOperations)

        Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches any Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.

        RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.

        • webhooks.rules.apiGroups ([]string)

          Atomic: will be replaced during a merge

          APIGroups is the API groups the resources belong to. ‘‘ is all groups. If ‘‘ is present, the length of the slice must be one. Required.

        • webhooks.rules.apiVersions ([]string)

          Atomic: will be replaced during a merge

          APIVersions is the API versions the resources belong to. ‘‘ is all versions. If ‘‘ is present, the length of the slice must be one. Required.

        • webhooks.rules.operations ([]string)

          Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If ‘*‘ is present, the length of the slice must be one. Required.

        • webhooks.rules.resources ([]string)

          Atomic: will be replaced during a merge

          Resources is a list of resources this rule applies to.

          For example: ‘pods’ means pods. ‘pods/log’ means the log subresource of pods. ‘‘ means all resources, but not subresources. ‘pods/‘ means all subresources of pods. ‘/scale’ means all scale subresources. ‘/*‘ means all resources and their subresources.

          If wildcard is present, the validation rule will ensure resources do not overlap with each other.

          Depending on the enclosing object, subresources might not be allowed. Required.

        • webhooks.rules.scope (string)

          scope specifies the scope of this rule. Valid values are “Cluster”, “Namespaced”, and ““ “Cluster” means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. “Namespaced” means that only namespaced resources will match this rule. ““ means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is “*“.

      • webhooks.timeoutSeconds (int32)

        TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.

    ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.

    HTTP Request

    GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}

    Parameters

    • name (in path): string, required

      name of the ValidatingWebhookConfiguration

    • pretty (in query): string

      pretty

    Response

    200 (ValidatingWebhookConfiguration): OK

    401: Unauthorized

    list list or watch objects of kind ValidatingWebhookConfiguration

    HTTP Request

    GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations

    Parameters

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • watch (in query): boolean

      watch

    Response

    200 (ValidatingWebhookConfigurationList): OK

    401: Unauthorized

    HTTP Request

    POST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations

    Parameters

    Response

    200 (ValidatingWebhookConfiguration): OK

    201 (): Created

    202 (ValidatingWebhookConfiguration): Accepted

    401: Unauthorized

    update replace the specified ValidatingWebhookConfiguration

    HTTP Request

    PUT /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}

    Parameters

    Response

    200 (ValidatingWebhookConfiguration): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

    PATCH /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}

    Parameters

    • name (in path): string, required

      name of the ValidatingWebhookConfiguration

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (ValidatingWebhookConfiguration): OK

    201 (): Created

    401: Unauthorized

    delete delete a ValidatingWebhookConfiguration

    HTTP Request

    DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}

    Parameters

    • name (in path): string, required

      name of the ValidatingWebhookConfiguration

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (Status): Accepted

    401: Unauthorized

    HTTP Request

    DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations

    Parameters

    • body: DeleteOptions

    • continue (in query): string

    • dryRun (in query): string

      dryRun

    • fieldSelector (in query): string

    • gracePeriodSeconds (in query): integer

      gracePeriodSeconds

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • propagationPolicy (in query): string

      propagationPolicy

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    Response

    401: Unauthorized