com.pulumi.kubernetes.admissionregistration.v1.kotlin.outputs.MutatingWebhookPatch.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-kubernetes-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.kubernetes.admissionregistration.v1.kotlin.outputs

import com.pulumi.kubernetes.meta.v1.kotlin.outputs.LabelSelectorPatch
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 * MutatingWebhook describes an admission webhook and the resources and operations it applies to.
 * @property 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.
 * @property clientConfig ClientConfig defines how to communicate with the hook. Required
 * @property failurePolicy FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
 * @property 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
 * @property 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"
 * @property 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.
 * @property 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.
 * @property 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.
 * @property 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".
 * @property 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.
 * @property 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.
 * @property 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.
 */
public data class MutatingWebhookPatch(
    public val admissionReviewVersions: List? = null,
    public val clientConfig: WebhookClientConfigPatch? = null,
    public val failurePolicy: String? = null,
    public val matchConditions: List? = null,
    public val matchPolicy: String? = null,
    public val name: String? = null,
    public val namespaceSelector: LabelSelectorPatch? = null,
    public val objectSelector: LabelSelectorPatch? = null,
    public val reinvocationPolicy: String? = null,
    public val rules: List? = null,
    public val sideEffects: String? = null,
    public val timeoutSeconds: Int? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.kubernetes.admissionregistration.v1.outputs.MutatingWebhookPatch): MutatingWebhookPatch = MutatingWebhookPatch(
            admissionReviewVersions = javaType.admissionReviewVersions().map({ args0 -> args0 }),
            clientConfig = javaType.clientConfig().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.kubernetes.admissionregistration.v1.kotlin.outputs.WebhookClientConfigPatch.Companion.toKotlin(args0)
                })
            }).orElse(null),
            failurePolicy = javaType.failurePolicy().map({ args0 -> args0 }).orElse(null),
            matchConditions = javaType.matchConditions().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.kubernetes.admissionregistration.v1.kotlin.outputs.MatchConditionPatch.Companion.toKotlin(args0)
                })
            }),
            matchPolicy = javaType.matchPolicy().map({ args0 -> args0 }).orElse(null),
            name = javaType.name().map({ args0 -> args0 }).orElse(null),
            namespaceSelector = javaType.namespaceSelector().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.kubernetes.meta.v1.kotlin.outputs.LabelSelectorPatch.Companion.toKotlin(args0)
                })
            }).orElse(null),
            objectSelector = javaType.objectSelector().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.kubernetes.meta.v1.kotlin.outputs.LabelSelectorPatch.Companion.toKotlin(args0)
                })
            }).orElse(null),
            reinvocationPolicy = javaType.reinvocationPolicy().map({ args0 -> args0 }).orElse(null),
            rules = javaType.rules().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.kubernetes.admissionregistration.v1.kotlin.outputs.RuleWithOperationsPatch.Companion.toKotlin(args0)
                })
            }),
            sideEffects = javaType.sideEffects().map({ args0 -> args0 }).orElse(null),
            timeoutSeconds = javaType.timeoutSeconds().map({ args0 -> args0 }).orElse(null),
        )
    }
}