package v1
- Alphabetic
- Public
- All
Type Members
-
case class
MutatingWebhook(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, reinvocationPolicy: Optional[String] = Optional.Absent, rules: Optional[Vector[RuleWithOperations]] = Optional.Absent, sideEffects: String, timeoutSeconds: Optional[Int] = Optional.Absent) extends Product with Serializable
MutatingWebhook describes an admission webhook and the resources and operations it applies to.
MutatingWebhook 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 includedapiGroups:["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.
- 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".
- 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.
-
case class
MutatingWebhookConfiguration(metadata: Optional[ObjectMeta] = Optional.Absent, webhooks: Optional[Vector[MutatingWebhook]] = Optional.Absent) extends Product with Serializable
MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.
MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.
- webhooks
Webhooks is a list of webhooks and the affected resources and operations.
- class MutatingWebhookConfigurationFields extends AnyRef
- class MutatingWebhookFields extends AnyRef
-
case class
RuleWithOperations(apiGroups: Optional[Vector[String]] = Optional.Absent, apiVersions: Optional[Vector[String]] = Optional.Absent, operations: Optional[Vector[String]] = Optional.Absent, resources: Optional[Vector[String]] = Optional.Absent, scope: Optional[String] = Optional.Absent) extends Product with Serializable
RuleWithOperations is a tuple of Operations and Resources.
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
- apiGroups
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- apiVersions
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- operations
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.
- resources
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.
- scope
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 "*".
- class RuleWithOperationsFields extends AnyRef
-
case class
ServiceReference(name: String, namespace: String, path: Optional[String] = Optional.Absent, port: Optional[Int] = Optional.Absent) extends Product with Serializable
ServiceReference holds a reference to Service.legacy.k8s.io
ServiceReference holds a reference to Service.legacy.k8s.io
- name
name
is the name of the service. Required- namespace
namespace
is the namespace of the service. Required- path
path
is an optional URL path which will be sent in any request to this service.- port
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility.
port
should be a valid port number (1-65535, inclusive).
- class ServiceReferenceFields extends AnyRef
-
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.
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 includedapiGroups:["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.
-
case class
ValidatingWebhookConfiguration(metadata: Optional[ObjectMeta] = Optional.Absent, webhooks: Optional[Vector[ValidatingWebhook]] = Optional.Absent) extends Product with Serializable
ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.
ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.
- webhooks
Webhooks is a list of webhooks and the affected resources and operations.
- class ValidatingWebhookConfigurationFields extends AnyRef
- class ValidatingWebhookFields extends AnyRef
-
case class
WebhookClientConfig(caBundle: Optional[Chunk[Byte]] = Optional.Absent, service: Optional[ServiceReference] = Optional.Absent, url: Optional[String] = Optional.Absent) extends Product with Serializable
WebhookClientConfig contains the information to make a TLS connection with the webhook
WebhookClientConfig contains the information to make a TLS connection with the webhook
- caBundle
caBundle
is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.- url
url
gives the location of the webhook, in standard URL form (scheme://host:port/path
). Exactly one ofurl
orservice
must be specified. Thehost
should not refer to a service running in the cluster; use theservice
field instead. The host might be resolved via external DNS in some apiservers (e.g.,kube-apiserver
cannot resolve in-cluster DNS as that would be a layering violation).host
may also be an IP address. Please note that usinglocalhost
or127.0.0.1
as ahost
is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- class WebhookClientConfigFields extends AnyRef
Value Members
- object MutatingWebhook extends MutatingWebhookFields with Serializable
- object MutatingWebhookConfiguration extends MutatingWebhookConfigurationFields with Serializable
- object RuleWithOperations extends RuleWithOperationsFields with Serializable
- object ServiceReference extends ServiceReferenceFields with Serializable
- object ValidatingWebhook extends ValidatingWebhookFields with Serializable
- object ValidatingWebhookConfiguration extends ValidatingWebhookConfigurationFields with Serializable
- object WebhookClientConfig extends WebhookClientConfigFields with Serializable