case class ValidatingWebhook(admissionReviewVersions: Vector[String], clientConfig: WebhookClientConfig, failurePolicy: Optional[String] = Optional.Absent, matchPolicy: Optional[String] = Optional.Absent, name: String, namespaceSelector: Optional[LabelSelector] = Optional.Absent, objectSelector: Optional[LabelSelector] = Optional.Absent, rules: Optional[Vector[RuleWithOperations]] = Optional.Absent, sideEffects: String, timeoutSeconds: Optional[Int] = Optional.Absent) extends Product with Serializable

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

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.

failurePolicy

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

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"

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.

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.

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.

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValidatingWebhook
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ValidatingWebhook(admissionReviewVersions: Vector[String], clientConfig: WebhookClientConfig, failurePolicy: Optional[String] = Optional.Absent, matchPolicy: Optional[String] = Optional.Absent, name: String, namespaceSelector: Optional[LabelSelector] = Optional.Absent, objectSelector: Optional[LabelSelector] = Optional.Absent, rules: Optional[Vector[RuleWithOperations]] = Optional.Absent, sideEffects: String, timeoutSeconds: Optional[Int] = Optional.Absent)

    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.

    failurePolicy

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

    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"

    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.

    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.

    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.

    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.

Value Members

  1. val admissionReviewVersions: Vector[String]
  2. val clientConfig: WebhookClientConfig
  3. val failurePolicy: Optional[String]
  4. def getAdmissionReviewVersions: IO[K8sFailure, Vector[String]]

    AdmissionReviewVersions is an ordered list of preferred AdmissionReview versions the Webhook expects.

    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.

    This effect always succeeds, it is safe to use the field admissionReviewVersions directly.

  5. def getClientConfig: IO[K8sFailure, WebhookClientConfig]

    Gets clientConfig.

    Gets clientConfig.

    This effect always succeeds, it is safe to use the field clientConfig directly.

  6. def getFailurePolicy: IO[K8sFailure, String]

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

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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  7. def getMatchPolicy: IO[K8sFailure, String]

    matchPolicy defines how the "rules" list is used to match incoming requests.

    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"

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  8. def getName: IO[K8sFailure, String]

    The name of the admission webhook.

    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.

    This effect always succeeds, it is safe to use the field name directly.

  9. def getNamespaceSelector: IO[K8sFailure, LabelSelector]

    Gets namespaceSelector.

    Gets namespaceSelector.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  10. def getObjectSelector: IO[K8sFailure, LabelSelector]

    Gets objectSelector.

    Gets objectSelector.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  11. def getRules: IO[K8sFailure, Vector[RuleWithOperations]]

    Rules describes what operations on what resources/subresources the webhook cares about.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  12. def getSideEffects: IO[K8sFailure, String]

    SideEffects states whether this webhook has side effects.

    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.

    This effect always succeeds, it is safe to use the field sideEffects directly.

  13. def getTimeoutSeconds: IO[K8sFailure, Int]

    TimeoutSeconds specifies the timeout for this webhook.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  14. val matchPolicy: Optional[String]
  15. val name: String
  16. val namespaceSelector: Optional[LabelSelector]
  17. val objectSelector: Optional[LabelSelector]
  18. val rules: Optional[Vector[RuleWithOperations]]
  19. val sideEffects: String
  20. val timeoutSeconds: Optional[Int]