ValidatingAdmissionPolicy [admissionregistration.k8s.io/v1] - extension APIs | API reference

Specification
API endpoints

Description: ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it.
Type: object

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the ReST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
`spec`	`object`	ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.
`status`	`object`	ValidatingAdmissionPolicyStatus represents the status of an admission validation policy.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the ReST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.

spec

object

ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.

status

object

ValidatingAdmissionPolicyStatus represents the status of an admission validation policy.

.spec

Description: ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.
Type: object

Property Type Description

Property	Type	Description
`auditAnnotations`	`array`	auditAnnotations contains CeL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.
`auditAnnotations[]`	`object`	AuditAnnotation describes how to produce an audit annotation for an API request.
`failurePolicy`	`string`	failurePolicy defines how to handle failures for the admission policy. Failures can occur from CeL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings. A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource. failurePolicy does not define how validations that evaluate to false are handled. When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced. Allowed values are Ignore or Fail. Defaults to Fail. Possible enum values: - `"Fail"` means that an error calling the webhook causes the admission to fail. - `"Ignore"` means that an error calling the webhook is ignored.
`matchConditions`	`array`	MatchConditions is a list of conditions that must be met for a request to be validated. 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. If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions. The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSe, the policy is skipped. 2. If ALL matchConditions evaluate to TRUe, the policy is evaluated. 3. If any matchCondition evaluates to an error (but none are FALSe): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the policy is skipped
`matchConditions[]`	`object`	MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.
`matchConstraints`	`object`	MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
`paramKind`	`object`	ParamKind is a tuple of Group Kind and Version.
`validations`	`array`	Validations contain CeL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
`validations[]`	`object`	Validation specifies the CeL expression which is used to apply the validation.
`variables`	`array`	Variables contain definitions of variables that can be used in composition of other expressions. each variable is defined as a named CeL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy. The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.
`variables[]`	`object`	Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.

auditAnnotations

array

auditAnnotations contains CeL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.

auditAnnotations[]

object

AuditAnnotation describes how to produce an audit annotation for an API request.

failurePolicy

string

failurePolicy defines how to handle failures for the admission policy. Failures can occur from CeL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings.

A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource.

failurePolicy does not define how validations that evaluate to false are handled.

When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced.

Allowed values are Ignore or Fail. Defaults to Fail.

Possible enum values: - "Fail" means that an error calling the webhook causes the admission to fail. - "Ignore" means that an error calling the webhook is ignored.

matchConditions

array

MatchConditions is a list of conditions that must be met for a request to be validated. 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.

If a parameter object is provided, it can be accessed via the params handle in the same manner as validation expressions.

The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSe, the policy is skipped. 2. If ALL matchConditions evaluate to TRUe, the policy is evaluated. 3. If any matchCondition evaluates to an error (but none are FALSe): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the policy is skipped

matchConditions[]

object

MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.

matchConstraints

object

MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)

paramKind

object

ParamKind is a tuple of Group Kind and Version.

validations

array

Validations contain CeL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.

validations[]

object

Validation specifies the CeL expression which is used to apply the validation.

variables

array

Variables contain definitions of variables that can be used in composition of other expressions. each variable is defined as a named CeL expression. The variables defined here will be available under variables in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy.

The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.

variables[]

object

Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.

.spec.auditAnnotations

Description: auditAnnotations contains CeL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.
Type: array

.spec.auditAnnotations[]

Description

AuditAnnotation describes how to produce an audit annotation for an API request.

Type

object

Required

key
valueexpression

Property Type Description

Property	Type	Description
`key`	`string`	key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length. The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}". If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded. Required.
`valueexpression`	`string`	valueexpression represents the expression which is evaluated by CeL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueexpression may be no longer than 5kb in length. If the result of the valueexpression is more than 10kb in length, it will be truncated to 10kb. If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueexpression will be evaluated for each binding. All unique values produced by the valueexpressions will be joined together in a comma-separated list. Required.

key

string

key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length.

The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}".

If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded.

Required.

valueexpression

string

valueexpression represents the expression which is evaluated by CeL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueexpression may be no longer than 5kb in length. If the result of the valueexpression is more than 10kb in length, it will be truncated to 10kb.

If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueexpression will be evaluated for each binding. All unique values produced by the valueexpressions will be joined together in a comma-separated list.

Required.

.spec.matchConditions

Description: MatchConditions is a list of conditions that must be met for a request to be validated. 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.

If a parameter object is provided, it can be accessed via the params handle in the same manner as validation expressions.

The exact matching logic is (in order): 1. If ANY matchCondition evaluates to FALSe, the policy is skipped. 2. If ALL matchConditions evaluate to TRUe, the policy is evaluated. 3. If any matchCondition evaluates to an error (but none are FALSe): - If failurePolicy=Fail, reject the request - If failurePolicy=Ignore, the policy is skipped
Type: array

.spec.matchConditions[]

Description

MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.

Type

object

Required

name
expression

Property Type Description

Property	Type	Description
`expression`	`string`	expression represents the expression which will be evaluated by CeL. Must evaluate to bool. CeL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CeL variables: 'object' - The object from the incoming request. The value is null for DeLeTe requests. 'oldObject' - The existing object. The value is null for CReATe requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CeL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz 'authorizer.requestResource' - A CeL ResourceCheck constructed from the 'authorizer' and configured with the request resource. Documentation on CeL: https://kubernetes.io/docs/reference/using-api/cel/ Required.
`name`	`string`	Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') Required.

expression

string

expression represents the expression which will be evaluated by CeL. Must evaluate to bool. CeL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CeL variables:

'object' - The object from the incoming request. The value is null for DeLeTe requests. 'oldObject' - The existing object. The value is null for CReATe requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CeL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz 'authorizer.requestResource' - A CeL ResourceCheck constructed from the 'authorizer' and configured with the request resource. Documentation on CeL: https://kubernetes.io/docs/reference/using-api/cel/

Required.

name

string

Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')

Required.

.spec.matchConstraints

Description: MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
Type: object

Property Type Description

Property	Type	Description
`excludeResourceRules`	`array`	excludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
`excludeResourceRules[]`	`object`	NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.
`matchPolicy`	`string`	matchPolicy defines how the "MatchResources" 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 ValidatingAdmissionPolicy. - 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 ValidatingAdmissionPolicy. Defaults to "equivalent" Possible enum values: - `"equivalent"` means requests should be sent to the webhook if they modify a resource listed in rules via another API group or version. - `"exact"` means requests should only be sent to the webhook if they exactly match a given rule.
`namespaceSelector`	`LabelSelector`	NamespaceSelector decides whether to run the admission control policy 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 policy. 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 policy 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.
`objectSelector`	`LabelSelector`	ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, 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.
`resourceRules`	`array`	ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches any Rule.
`resourceRules[]`	`object`	NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.

excludeResourceRules

array

excludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)

excludeResourceRules[]

object

NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.

matchPolicy

string

matchPolicy defines how the "MatchResources" 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 ValidatingAdmissionPolicy.

- 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 ValidatingAdmissionPolicy.

Defaults to "equivalent"

Possible enum values: - "equivalent" means requests should be sent to the webhook if they modify a resource listed in rules via another API group or version. - "exact" means requests should only be sent to the webhook if they exactly match a given rule.

namespaceSelector

LabelSelector

NamespaceSelector decides whether to run the admission control policy 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 policy.

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 policy 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.

objectSelector

LabelSelector

ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, 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.

resourceRules

array

ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches any Rule.

resourceRules[]

object

NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.

.spec.matchConstraints.excludeResourceRules

Description: excludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
Type: array

.spec.matchConstraints.excludeResourceRules[]

Description: NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.
Type: object

Property Type Description

Property	Type	Description
`apiGroups`	`array (string)`	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`	`array (string)`	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`	`array (string)`	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.
`resourceNames`	`array (string)`	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources`	`array (string)`	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`	`string`	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 "*".

apiGroups

array (string)

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

array (string)

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

array (string)

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.

resourceNames

array (string)

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources

array (string)

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

string

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 "*".

.spec.matchConstraints.resourceRules

Description: ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches any Rule.
Type: array

.spec.matchConstraints.resourceRules[]

Description: NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.
Type: object

Property Type Description

Property	Type	Description
`apiGroups`	`array (string)`	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`	`array (string)`	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`	`array (string)`	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.
`resourceNames`	`array (string)`	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources`	`array (string)`	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`	`string`	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 "*".

apiGroups

array (string)

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

array (string)

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

array (string)

resourceNames

array (string)

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources

array (string)

Resources is a list of resources this rule applies to.

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

string

.spec.paramKind

Description: ParamKind is a tuple of Group Kind and Version.
Type: object

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion is the API group version the resources belong to. In format of "group/version". Required.
`kind`	`string`	Kind is the API kind the resources belong to. Required.

apiVersion

string

APIVersion is the API group version the resources belong to. In format of "group/version". Required.

kind

string

Kind is the API kind the resources belong to. Required.

.spec.validations

Description: Validations contain CeL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
Type: array

.spec.validations[]

Description

Validation specifies the CeL expression which is used to apply the validation.

Type

object

Required

expression

Property Type Description

Property	Type	Description
`expression`	`string`	expression represents the expression which will be evaluated by CeL. ref: https://github.com/google/cel-spec CeL expressions have access to the contents of the API request/response, organized into CeL variables as well as some other useful variables: - 'object' - The object from the incoming request. The value is null for DeLeTe requests. - 'oldObject' - The existing object. The value is null for CReATe requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named 'foo' can be accessed as 'variables.foo'. - 'authorizer' - A CeL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz - 'authorizer.requestResource' - A CeL ResourceCheck constructed from the 'authorizer' and configured with the request resource. The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible. Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to '*underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CeL ReSeRVeD keyword escape to '{keyword}'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". examples: - expression accessing a property named "namespace": {"expression": "object.namespace > 0"} - expression accessing a property named "x-prop": {"expression": "object.xdashprop > 0"} - expression accessing a property named "redactd": {"expression": "object.redactunderscoresd > 0"} equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and non-intersecting elements in `Y` are appended, retaining their partial order. - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. elements in `Y` with non-intersecting keys are appended, retaining their partial order. Required.
`message`	`string`	Message represents the message displayed when validation fails. The message is required if the expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed expression: {expression}".
`messageexpression`	`string`	messageexpression declares a CeL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageexpression is used as a failure message, it must evaluate to a string. If both message and messageexpression are present on a validation, then messageexpression will be used if validation fails. If messageexpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageexpression field were unset. If messageexpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageexpression field were unset, and the fact that messageexpression produced an empty string/string with only spaces/string with line breaks will be logged. messageexpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. example: "object.x must be less than max ("string(params.max)")"
`reason`	`string`	Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestentityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.

expression

string

expression represents the expression which will be evaluated by CeL. ref: https://github.com/google/cel-spec CeL expressions have access to the contents of the API request/response, organized into CeL variables as well as some other useful variables:

- 'object' - The object from the incoming request. The value is null for DeLeTe requests. - 'oldObject' - The existing object. The value is null for CReATe requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named 'foo' can be accessed as 'variables.foo'. - 'authorizer' - A CeL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz - 'authorizer.requestResource' - A CeL ResourceCheck constructed from the 'authorizer' and configured with the request resource.

The apiVersion, kind, metadata.name and metadata.generateName are always accessible from the root of the object. No other metadata properties are accessible.

Only property names of the form [a-zA-Z_.-/][a-zA-Z0-9_.-/]* are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CeL ReSeRVeD keyword escape to '{keyword}'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". examples: - expression accessing a property named "namespace": {"expression": "object.namespace > 0"} - expression accessing a property named "x-prop": {"expression": "object.xdashprop > 0"} - expression accessing a property named "redactd": {"expression": "object.redactunderscoresd > 0"}

equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - 'set': X + Y performs a union where the array positions of all elements in X are preserved and non-intersecting elements in Y are appended, retaining their partial order. - 'map': X + Y performs a merge where the array positions of all keys in X are preserved but the values are overwritten by values in Y when the key sets of X and Y intersect. elements in Y with non-intersecting keys are appended, retaining their partial order. Required.

message

string

Message represents the message displayed when validation fails. The message is required if the expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed expression: {expression}".

messageexpression

string

messageexpression declares a CeL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageexpression is used as a failure message, it must evaluate to a string. If both message and messageexpression are present on a validation, then messageexpression will be used if validation fails. If messageexpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageexpression field were unset. If messageexpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageexpression field were unset, and the fact that messageexpression produced an empty string/string with only spaces/string with line breaks will be logged. messageexpression has access to all the same variables as the expression except for 'authorizer' and 'authorizer.requestResource'. example: "object.x must be less than max ("string(params.max)")"

reason

string

Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestentityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.

.spec.variables

Description: Variables contain definitions of variables that can be used in composition of other expressions. each variable is defined as a named CeL expression. The variables defined here will be available under variables in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy.

The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.
Type: array

.spec.variables[]

Description

Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.

Type

object

Required

name
expression

Property Type Description

Property	Type	Description
`expression`	`string`	expression is the expression that will be evaluated as the value of the variable. The CeL expression has access to the same identifiers as the CeL expressions in Validation.
`name`	`string`	Name is the name of the variable. The name must be a valid CeL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo`

expression

string

expression is the expression that will be evaluated as the value of the variable. The CeL expression has access to the same identifiers as the CeL expressions in Validation.

name

string

Name is the name of the variable. The name must be a valid CeL identifier and unique among all variables. The variable can be accessed in other expressions through variables For example, if name is "foo", the variable will be available as variables.foo

.status

Description: ValidatingAdmissionPolicyStatus represents the status of an admission validation policy.
Type: object

Property Type Description

Property	Type	Description
`conditions`	`array (Condition)`	The conditions represent the latest available observations of a policy’s current state.
`observedGeneration`	`integer`	The generation observed by the controller.
`typeChecking`	`object`	TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy

conditions

array (Condition)

The conditions represent the latest available observations of a policy’s current state.

observedGeneration

integer

The generation observed by the controller.

typeChecking

object

TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy

.status.typeChecking

Description: TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy
Type: object

Property Type Description

Property	Type	Description
`expressionWarnings`	`array`	The type checking warnings for each expression.
`expressionWarnings[]`	`object`	expressionWarning is a warning information that targets a specific expression.

expressionWarnings

array

The type checking warnings for each expression.

expressionWarnings[]

object

expressionWarning is a warning information that targets a specific expression.

.status.typeChecking.expressionWarnings

Description: The type checking warnings for each expression.
Type: array

.status.typeChecking.expressionWarnings[]

Description

expressionWarning is a warning information that targets a specific expression.

Type

object

Required

fieldRef
warning

Property Type Description

Property	Type	Description
`fieldRef`	`string`	The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression"
`warning`	`string`	The content of type checking information in a human-readable form. each line of the warning contains the type that the expression is checked against, followed by the type check error from the compiler.

fieldRef

string

The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression"

warning

string

The content of type checking information in a human-readable form. each line of the warning contains the type that the expression is checked against, followed by the type check error from the compiler.

API endpoints

The following API endpoints are available:

/apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies
- DeLeTe: delete collection of ValidatingAdmissionPolicy
- GeT: list or watch objects of kind ValidatingAdmissionPolicy
- POST: create a ValidatingAdmissionPolicy
/apis/admissionregistration.k8s.io/v1/watch/validatingadmissionpolicies
- GeT: watch individual changes to a list of ValidatingAdmissionPolicy. deprecated: use the 'watch' parameter with a list operation instead.
/apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
- DeLeTe: delete a ValidatingAdmissionPolicy
- GeT: read the specified ValidatingAdmissionPolicy
- PATCH: partially update the specified ValidatingAdmissionPolicy
- PUT: replace the specified ValidatingAdmissionPolicy
/apis/admissionregistration.k8s.io/v1/watch/validatingadmissionpolicies/{name}
- GeT: watch changes to an object of kind ValidatingAdmissionPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
/apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status
- GeT: read status of the specified ValidatingAdmissionPolicy
- PATCH: partially update status of the specified ValidatingAdmissionPolicy
- PUT: replace status of the specified ValidatingAdmissionPolicy

/apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies

HTTP method: DeLeTe
Description: delete collection of ValidatingAdmissionPolicy

Table 1. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: list or watch objects of kind ValidatingAdmissionPolicy

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicyList` schema
401 - Unauthorized	empty

HTTP method: POST
Description: create a ValidatingAdmissionPolicy

Table 4. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 5. Body parameters
Parameter	Type	Description
`body`	`ValidatingAdmissionPolicy` schema

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicy` schema
201 - Created	`ValidatingAdmissionPolicy` schema
202 - Accepted	`ValidatingAdmissionPolicy` schema
401 - Unauthorized	empty

/apis/admissionregistration.k8s.io/v1/watch/validatingadmissionpolicies

HTTP method: GeT
Description: watch individual changes to a list of ValidatingAdmissionPolicy. deprecated: use the 'watch' parameter with a list operation instead.

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`Watchevent` schema
401 - Unauthorized	empty

/apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ValidatingAdmissionPolicy

HTTP method: DeLeTe
Description: delete a ValidatingAdmissionPolicy

Table 9. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: read the specified ValidatingAdmissionPolicy

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicy` schema
401 - Unauthorized	empty

HTTP method: PATCH
Description: partially update the specified ValidatingAdmissionPolicy

Table 12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicy` schema
201 - Created	`ValidatingAdmissionPolicy` schema
401 - Unauthorized	empty

HTTP method: PUT
Description: replace the specified ValidatingAdmissionPolicy

Table 14. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 15. Body parameters
Parameter	Type	Description
`body`	`ValidatingAdmissionPolicy` schema

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicy` schema
201 - Created	`ValidatingAdmissionPolicy` schema
401 - Unauthorized	empty

/apis/admissionregistration.k8s.io/v1/watch/validatingadmissionpolicies/{name}

Table 17. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ValidatingAdmissionPolicy

HTTP method: GeT
Description: watch changes to an object of kind ValidatingAdmissionPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`Watchevent` schema
401 - Unauthorized	empty

/apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status

Table 19. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ValidatingAdmissionPolicy

HTTP method: GeT
Description: read status of the specified ValidatingAdmissionPolicy

Table 20. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicy` schema
401 - Unauthorized	empty

HTTP method: PATCH
Description: partially update status of the specified ValidatingAdmissionPolicy

Table 21. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 22. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicy` schema
201 - Created	`ValidatingAdmissionPolicy` schema
401 - Unauthorized	empty

HTTP method: PUT
Description: replace status of the specified ValidatingAdmissionPolicy

Table 23. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 24. Body parameters
Parameter	Type	Description
`body`	`ValidatingAdmissionPolicy` schema

Table 25. HTTP responses
HTTP code	Reponse body
200 - OK	`ValidatingAdmissionPolicy` schema
201 - Created	`ValidatingAdmissionPolicy` schema
401 - Unauthorized	empty