com.pulumi.kubernetes.admissionregistration.v1.outputs.ValidatingWebhook Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kubernetes Show documentation
Show all versions of kubernetes Show documentation
A Pulumi package for creating and managing Kubernetes resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.kubernetes.admissionregistration.v1.outputs;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import com.pulumi.kubernetes.admissionregistration.v1.outputs.MatchCondition;
import com.pulumi.kubernetes.admissionregistration.v1.outputs.RuleWithOperations;
import com.pulumi.kubernetes.admissionregistration.v1.outputs.WebhookClientConfig;
import com.pulumi.kubernetes.meta.v1.outputs.LabelSelector;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
@CustomType
public final class ValidatingWebhook {
/**
* @return 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.
*
*/
private List admissionReviewVersions;
/**
* @return ClientConfig defines how to communicate with the hook. Required
*
*/
private WebhookClientConfig clientConfig;
/**
* @return FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
*
*/
private @Nullable String failurePolicy;
/**
* @return 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
*
*/
private @Nullable List matchConditions;
/**
* @return 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"
*
*/
private @Nullable String matchPolicy;
/**
* @return 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.
*
*/
private String name;
/**
* @return 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.
*
*/
private @Nullable LabelSelector namespaceSelector;
/**
* @return 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.
*
*/
private @Nullable LabelSelector objectSelector;
/**
* @return 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.
*
*/
private @Nullable List rules;
/**
* @return 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.
*
*/
private String sideEffects;
/**
* @return 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.
*
*/
private @Nullable Integer timeoutSeconds;
private ValidatingWebhook() {}
/**
* @return 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.
*
*/
public List admissionReviewVersions() {
return this.admissionReviewVersions;
}
/**
* @return ClientConfig defines how to communicate with the hook. Required
*
*/
public WebhookClientConfig clientConfig() {
return this.clientConfig;
}
/**
* @return FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
*
*/
public Optional failurePolicy() {
return Optional.ofNullable(this.failurePolicy);
}
/**
* @return 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
*
*/
public List matchConditions() {
return this.matchConditions == null ? List.of() : this.matchConditions;
}
/**
* @return 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"
*
*/
public Optional matchPolicy() {
return Optional.ofNullable(this.matchPolicy);
}
/**
* @return 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.
*
*/
public String name() {
return this.name;
}
/**
* @return 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.
*
*/
public Optional namespaceSelector() {
return Optional.ofNullable(this.namespaceSelector);
}
/**
* @return 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.
*
*/
public Optional objectSelector() {
return Optional.ofNullable(this.objectSelector);
}
/**
* @return 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.
*
*/
public List rules() {
return this.rules == null ? List.of() : this.rules;
}
/**
* @return 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.
*
*/
public String sideEffects() {
return this.sideEffects;
}
/**
* @return 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 Optional timeoutSeconds() {
return Optional.ofNullable(this.timeoutSeconds);
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ValidatingWebhook defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private List admissionReviewVersions;
private WebhookClientConfig clientConfig;
private @Nullable String failurePolicy;
private @Nullable List matchConditions;
private @Nullable String matchPolicy;
private String name;
private @Nullable LabelSelector namespaceSelector;
private @Nullable LabelSelector objectSelector;
private @Nullable List rules;
private String sideEffects;
private @Nullable Integer timeoutSeconds;
public Builder() {}
public Builder(ValidatingWebhook defaults) {
Objects.requireNonNull(defaults);
this.admissionReviewVersions = defaults.admissionReviewVersions;
this.clientConfig = defaults.clientConfig;
this.failurePolicy = defaults.failurePolicy;
this.matchConditions = defaults.matchConditions;
this.matchPolicy = defaults.matchPolicy;
this.name = defaults.name;
this.namespaceSelector = defaults.namespaceSelector;
this.objectSelector = defaults.objectSelector;
this.rules = defaults.rules;
this.sideEffects = defaults.sideEffects;
this.timeoutSeconds = defaults.timeoutSeconds;
}
@CustomType.Setter
public Builder admissionReviewVersions(List admissionReviewVersions) {
if (admissionReviewVersions == null) {
throw new MissingRequiredPropertyException("ValidatingWebhook", "admissionReviewVersions");
}
this.admissionReviewVersions = admissionReviewVersions;
return this;
}
public Builder admissionReviewVersions(String... admissionReviewVersions) {
return admissionReviewVersions(List.of(admissionReviewVersions));
}
@CustomType.Setter
public Builder clientConfig(WebhookClientConfig clientConfig) {
if (clientConfig == null) {
throw new MissingRequiredPropertyException("ValidatingWebhook", "clientConfig");
}
this.clientConfig = clientConfig;
return this;
}
@CustomType.Setter
public Builder failurePolicy(@Nullable String failurePolicy) {
this.failurePolicy = failurePolicy;
return this;
}
@CustomType.Setter
public Builder matchConditions(@Nullable List matchConditions) {
this.matchConditions = matchConditions;
return this;
}
public Builder matchConditions(MatchCondition... matchConditions) {
return matchConditions(List.of(matchConditions));
}
@CustomType.Setter
public Builder matchPolicy(@Nullable String matchPolicy) {
this.matchPolicy = matchPolicy;
return this;
}
@CustomType.Setter
public Builder name(String name) {
if (name == null) {
throw new MissingRequiredPropertyException("ValidatingWebhook", "name");
}
this.name = name;
return this;
}
@CustomType.Setter
public Builder namespaceSelector(@Nullable LabelSelector namespaceSelector) {
this.namespaceSelector = namespaceSelector;
return this;
}
@CustomType.Setter
public Builder objectSelector(@Nullable LabelSelector objectSelector) {
this.objectSelector = objectSelector;
return this;
}
@CustomType.Setter
public Builder rules(@Nullable List rules) {
this.rules = rules;
return this;
}
public Builder rules(RuleWithOperations... rules) {
return rules(List.of(rules));
}
@CustomType.Setter
public Builder sideEffects(String sideEffects) {
if (sideEffects == null) {
throw new MissingRequiredPropertyException("ValidatingWebhook", "sideEffects");
}
this.sideEffects = sideEffects;
return this;
}
@CustomType.Setter
public Builder timeoutSeconds(@Nullable Integer timeoutSeconds) {
this.timeoutSeconds = timeoutSeconds;
return this;
}
public ValidatingWebhook build() {
final var _resultValue = new ValidatingWebhook();
_resultValue.admissionReviewVersions = admissionReviewVersions;
_resultValue.clientConfig = clientConfig;
_resultValue.failurePolicy = failurePolicy;
_resultValue.matchConditions = matchConditions;
_resultValue.matchPolicy = matchPolicy;
_resultValue.name = name;
_resultValue.namespaceSelector = namespaceSelector;
_resultValue.objectSelector = objectSelector;
_resultValue.rules = rules;
_resultValue.sideEffects = sideEffects;
_resultValue.timeoutSeconds = timeoutSeconds;
return _resultValue;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy