Class ValidatingWebhook
- java.lang.Object
-
- com.marcnuri.yakc.model.io.k8s.api.admissionregistration.v1.ValidatingWebhook
-
- All Implemented Interfaces:
com.marcnuri.yakc.model.Model
public class ValidatingWebhook extends java.lang.Object implements com.marcnuri.yakc.model.Model
ValidatingWebhook describes an admission webhook and the resources and operations it applies to.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ValidatingWebhook.Builder
-
Constructor Summary
Constructors Constructor Description ValidatingWebhook()
ValidatingWebhook(@NonNull java.util.List<java.lang.String> admissionReviewVersions, @NonNull WebhookClientConfig clientConfig, java.lang.String failurePolicy, java.util.List<MatchCondition> matchConditions, java.lang.String matchPolicy, @NonNull java.lang.String name, LabelSelector namespaceSelector, LabelSelector objectSelector, java.util.List<RuleWithOperations> rules, @NonNull java.lang.String sideEffects, java.lang.Number timeoutSeconds)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ValidatingWebhook.Builder
builder()
protected boolean
canEqual(java.lang.Object other)
boolean
equals(java.lang.Object o)
@NonNull java.util.List<java.lang.String>
getAdmissionReviewVersions()
AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects.@NonNull WebhookClientConfig
getClientConfig()
java.lang.String
getFailurePolicy()
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail.java.util.List<MatchCondition>
getMatchConditions()
MatchConditions is a list of conditions that must be met for a request to be sent to this webhook.java.lang.String
getMatchPolicy()
matchPolicy defines how the "rules" list is used to match incoming requests.@NonNull java.lang.String
getName()
The name of the admission webhook.LabelSelector
getNamespaceSelector()
LabelSelector
getObjectSelector()
java.util.List<RuleWithOperations>
getRules()
Rules describes what operations on what resources/subresources the webhook cares about.@NonNull java.lang.String
getSideEffects()
SideEffects states whether this webhook has side effects.java.lang.Number
getTimeoutSeconds()
TimeoutSeconds specifies the timeout for this webhook.int
hashCode()
void
setAdmissionReviewVersions(@NonNull java.util.List<java.lang.String> admissionReviewVersions)
AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects.void
setClientConfig(@NonNull WebhookClientConfig clientConfig)
void
setFailurePolicy(java.lang.String failurePolicy)
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail.void
setMatchConditions(java.util.List<MatchCondition> matchConditions)
MatchConditions is a list of conditions that must be met for a request to be sent to this webhook.void
setMatchPolicy(java.lang.String matchPolicy)
matchPolicy defines how the "rules" list is used to match incoming requests.void
setName(@NonNull java.lang.String name)
The name of the admission webhook.void
setNamespaceSelector(LabelSelector namespaceSelector)
void
setObjectSelector(LabelSelector objectSelector)
void
setRules(java.util.List<RuleWithOperations> rules)
Rules describes what operations on what resources/subresources the webhook cares about.void
setSideEffects(@NonNull java.lang.String sideEffects)
SideEffects states whether this webhook has side effects.void
setTimeoutSeconds(java.lang.Number timeoutSeconds)
TimeoutSeconds specifies the timeout for this webhook.ValidatingWebhook.Builder
toBuilder()
java.lang.String
toString()
-
-
-
Constructor Detail
-
ValidatingWebhook
public ValidatingWebhook(@NonNull @NonNull java.util.List<java.lang.String> admissionReviewVersions, @NonNull @NonNull WebhookClientConfig clientConfig, java.lang.String failurePolicy, java.util.List<MatchCondition> matchConditions, java.lang.String matchPolicy, @NonNull @NonNull java.lang.String name, LabelSelector namespaceSelector, LabelSelector objectSelector, java.util.List<RuleWithOperations> rules, @NonNull @NonNull java.lang.String sideEffects, java.lang.Number timeoutSeconds)
-
ValidatingWebhook
public ValidatingWebhook()
-
-
Method Detail
-
builder
public static ValidatingWebhook.Builder builder()
-
toBuilder
public ValidatingWebhook.Builder toBuilder()
-
getAdmissionReviewVersions
@NonNull public @NonNull java.util.List<java.lang.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.
-
getClientConfig
@NonNull public @NonNull WebhookClientConfig getClientConfig()
-
getFailurePolicy
public java.lang.String getFailurePolicy()
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
-
getMatchConditions
public java.util.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
This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.
-
getMatchPolicy
public java.lang.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"
-
getName
@NonNull public @NonNull java.lang.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.
-
getNamespaceSelector
public LabelSelector getNamespaceSelector()
-
getObjectSelector
public LabelSelector getObjectSelector()
-
getRules
public java.util.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.
-
getSideEffects
@NonNull public @NonNull java.lang.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.
-
getTimeoutSeconds
public java.lang.Number 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.
-
setAdmissionReviewVersions
public void setAdmissionReviewVersions(@NonNull @NonNull java.util.List<java.lang.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.
-
setClientConfig
public void setClientConfig(@NonNull @NonNull WebhookClientConfig clientConfig)
-
setFailurePolicy
public void setFailurePolicy(java.lang.String failurePolicy)
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
-
setMatchConditions
public void setMatchConditions(java.util.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
This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.
-
setMatchPolicy
public void setMatchPolicy(java.lang.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"
-
setName
public void setName(@NonNull @NonNull java.lang.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.
-
setNamespaceSelector
public void setNamespaceSelector(LabelSelector namespaceSelector)
-
setObjectSelector
public void setObjectSelector(LabelSelector objectSelector)
-
setRules
public void setRules(java.util.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.
-
setSideEffects
public void setSideEffects(@NonNull @NonNull java.lang.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.
-
setTimeoutSeconds
public void setTimeoutSeconds(java.lang.Number 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.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-