Package io.fabric8.kubernetes.api.model.admissionregistration.v1

Class MutatingWebhook

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<MutatingWebhookBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class MutatingWebhook
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<MutatingWebhookBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    MutatingWebhook describes an admission webhook and the resources and operations it applies to.
    See Also:
    Serialized Form

    • Constructor Detail

      • MutatingWebhook

        public MutatingWebhook()
        No args constructor for use in serialization

    • Method Detail

      • getAdmissionReviewVersions

        public List<String> getAdmissionReviewVersions()
        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.

      • setAdmissionReviewVersions

        public void setAdmissionReviewVersions​(List<String> admissionReviewVersions)
        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.

      • getClientConfig

        public WebhookClientConfig getClientConfig()
        MutatingWebhook describes an admission webhook and the resources and operations it applies to.

      • setClientConfig

        public void setClientConfig​(WebhookClientConfig clientConfig)
        MutatingWebhook describes an admission webhook and the resources and operations it applies to.

      • getFailurePolicy

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

      • setFailurePolicy

        public void setFailurePolicy​(String failurePolicy)
        FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.

      • getMatchConditions

        public List<MatchCondition> getMatchConditions()
        MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.


        The exact matching logic is (in order):

        1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.

        2. If ALL matchConditions evaluate to TRUE, the webhook is called.

        3. If any matchCondition evaluates to an error (but none are FALSE):

        - If failurePolicy=Fail, reject the request

        - If failurePolicy=Ignore, the error is ignored and the webhook is skipped

      • setMatchConditions

        public void setMatchConditions​(List<MatchCondition> matchConditions)
        MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.


        The exact matching logic is (in order):

        1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.

        2. If ALL matchConditions evaluate to TRUE, the webhook is called.

        3. If any matchCondition evaluates to an error (but none are FALSE):

        - If failurePolicy=Fail, reject the request

        - If failurePolicy=Ignore, the error is ignored and the webhook is skipped

      • getMatchPolicy

        public String getMatchPolicy()
        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"

      • setMatchPolicy

        public void setMatchPolicy​(String matchPolicy)
        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"

      • getName

        public String getName()
        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.

      • setName

        public void setName​(String name)
        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.

      • getNamespaceSelector

        public io.fabric8.kubernetes.api.model.LabelSelector getNamespaceSelector()
        MutatingWebhook describes an admission webhook and the resources and operations it applies to.

      • setNamespaceSelector

        public void setNamespaceSelector​(io.fabric8.kubernetes.api.model.LabelSelector namespaceSelector)
        MutatingWebhook describes an admission webhook and the resources and operations it applies to.

      • getObjectSelector

        public io.fabric8.kubernetes.api.model.LabelSelector getObjectSelector()
        MutatingWebhook describes an admission webhook and the resources and operations it applies to.

      • setObjectSelector

        public void setObjectSelector​(io.fabric8.kubernetes.api.model.LabelSelector objectSelector)
        MutatingWebhook describes an admission webhook and the resources and operations it applies to.

      • getReinvocationPolicy

        public String getReinvocationPolicy()
        reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded".


        Never: the webhook will not be called more than once in a single admission evaluation.


        IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead.


        Defaults to "Never".

      • setReinvocationPolicy

        public void setReinvocationPolicy​(String reinvocationPolicy)
        reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded".


        Never: the webhook will not be called more than once in a single admission evaluation.


        IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead.


        Defaults to "Never".

      • getRules

        public List<RuleWithOperations> getRules()
        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.

      • setRules

        public void setRules​(List<RuleWithOperations> rules)
        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.

      • getSideEffects

        public String getSideEffects()
        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.

      • setSideEffects

        public void setSideEffects​(String sideEffects)
        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.

      • getTimeoutSeconds

        public Integer getTimeoutSeconds()
        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.

      • setTimeoutSeconds

        public void setTimeoutSeconds​(Integer timeoutSeconds)
        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.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)