---
api_metadata:
apiVersion: "admissionregistration.k8s.io/v1"
import: "k8s.io/api/admissionregistration/v1"
kind: "ValidatingAdmissionPolicy"
content_type: "api_reference"
description: "ValidatingAdmissionPolicy 描述了一种准入验证策略的定义,这种策略接受或拒绝一个对象而不对其进行修改。"
title: "ValidatingAdmissionPolicy"
weight: 7
---
`apiVersion: admissionregistration.k8s.io/v1`
`import "k8s.io/api/admissionregistration/v1"`
## ValidatingAdmissionPolicy {#ValidatingAdmissionPolicy}
ValidatingAdmissionPolicy 描述了一种准入验证策略的定义,
这种策略用于接受或拒绝一个对象,而不对其进行修改。
- **apiVersion**: admissionregistration.k8s.io/v1
- **kind**: ValidatingAdmissionPolicy
- **metadata** (}}">ObjectMeta)
标准的对象元数据;更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- **spec** (ValidatingAdmissionPolicySpec)
ValidatingAdmissionPolicy 的期望行为规范。
**ValidatingAdmissionPolicySpec** 是 AdmissionPolicy 的期望行为规范。
- **spec.auditAnnotations** ([]AuditAnnotation)
**原子性:合并期间将被替换**
auditAnnotations 包含用于为 API 请求的审计事件生成审计注解的 CEL 表达式。
validations 和 auditAnnotations 不能同时为空;至少需要 validations 或 auditAnnotations 中的一个。
**AuditAnnotation** 描述了如何为 API 请求生成审计注解。
- **spec.auditAnnotations.key** (string),必需
key 指定了审计注解的键。ValidatingAdmissionPolicy 的审计注解键必须是唯一的。
键必须是一个合格的名字([A-Za-z0-9][-A-Za-z0-9_.]*),长度不超过 63 字节。
键与 ValidatingAdmissionPolicy 的资源名称组合以构建审计注解键:"{ValidatingAdmissionPolicy 名称}/{key}"。
如果一个准入 Webhook 使用与这个 ValidatingAdmissionPolicy 相同的资源名称和相同的审计注解键,
那么注解键将是相同的。在这种情况下,使用该键写入的第一个注解将包含在审计事件中,
并且所有后续使用相同键的注解将被丢弃。
必需。
- **spec.auditAnnotations.valueExpression** (string),必需
valueExpression 表示由 CEL 求值以生成审计注解值的表达式。该表达式求值结果为字符串或 null 值。
如果表达式计算为字符串,则包含带有字符串值的审计注解。如果表达式计算为 null 或空字符串,
则审计注解将被省略。valueExpression 的长度不得超过 5kb。如果 valueExpression
的结果长度超过 10KB,它将被截断为 10KB。
如果多个 ValidatingAdmissionPolicyBinding 资源匹配一个 API 请求,
则会为每个绑定计算 valueExpression。所有由 valueExpressions
产生的唯一值将以逗号分隔列表的形式连接在一起。
必需。
- **spec.failurePolicy** (string)
failurePolicy 定义了如何处理准入策略的失败。失败可能由 CEL
表达式解析错误、类型检查错误、运行时错误以及无效或配置错误的策略定义或绑定引起。
如果 spec.paramKind 引用了一个不存在的 Kind,则该策略无效。如果
spec.paramRef.name 引用了不存在的资源,则绑定无效。
failurePolicy 不定义如何处理计算为 false 的验证。
当 failurePolicy 设置为 Fail 时,ValidatingAdmissionPolicyBinding validationActions 定义如何处理失败。
允许的值有 Ignore 或 Fail。默认为 Fail。
- **spec.matchConditions** ([]MatchCondition)
**补丁策略:基于 `name` 键合并**
**映射:在合并期间,基于 name 键的唯一值将被保留**
matchConditions 是请求能够被验证时必须满足的一系列条件。匹配条件过滤已经由 rules、
namespaceSelector 和 objectSelector 匹配的请求。空的 matchConditions
列表匹配所有请求。最多允许有 64 个匹配条件。
如果提供了参数对象,可以通过 `params` 句柄以与验证表达式相同的方式访问它。
精确的匹配逻辑(按顺序):
1. 如果 matchConditions 中**任意一个**解析为 FALSE,则跳过该策略。
2. 如果 matchConditions 中**所有条件**都解析为 TRUE,则执行该策略。
3. 如果任何 matchCondition 解析出现错误(但没有解析为 FALSE):
- 如果 failurePolicy=Fail,拒绝请求
- 如果 failurePolicy=Ignore,则跳过该策略
**MatchCondition 表示将请求发送到 Webhook 时必须满足的条件。**
- **spec.matchConditions.expression** (string),必需
expression 表示由 CEL 处理的表达式。表达式求值结果必须为 Bool 类型。CEL 表达式可以访问
AdmissionRequest 和 Authorizer 的内容,这些内容被组织成 CEL 变量:
- 'object' - 来自传入请求的对象。对于 DELETE 请求,该值为 null。
- 'oldObject' - 现有对象。对于 CREATE 请求,该值为 null。
- 'request' - 准入请求的属性(/pkg/apis/admission/types.go#AdmissionRequest)。
- 'authorizer' - 一个 CEL 授权器。可用于对请求的主体(用户或服务账户)执行授权检查。
参见 https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
- 'authorizer.requestResource' - 由 'authorizer' 构建并配置了请求资源的 CEL ResourceCheck。
必需。
- **spec.matchConditions.name** (string),必需
name 是此匹配条件的标识符,用于 matchConditions 的策略性合并以及为日志记录提供标识符。
一个好的名称应该能够描述相关的表达式。名称必须是由字母数字字符、`-`、`_` 或 `.` 组成的合格名称,
并且必须以字母数字字符开头和结尾(例如 'MyName' 或 'my.name' 或 '123-abc',
用于验证的正则表达式是 '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]')
可以包含一个可选的 DNS 子域前缀和 '/' (例如 'example.com/MyName')。
必需。
- **spec.matchConstraints** (MatchResources)
matchConstraints 指定此策略设计用来验证的资源。仅当 AdmissionPolicy 匹配**所有**约束时,才会关注请求。
然而,为了避免集群进入无法通过 API 恢复的不稳定状态,ValidatingAdmissionPolicy 不能匹配 ValidatingAdmissionPolicy 和 ValidatingAdmissionPolicyBinding。
必需。
**matchResources 决定了是否根据对象是否符合匹配标准来运行准入控制策略。
排除规则优先于包含规则(如果一个资源同时匹配两者,则它被排除)**
- **spec.matchConstraints.excludeResourceRules** ([]NamedRuleWithOperations)
**原子性:在合并期间将被替换**
excludeResourceRules 描述 ValidatingAdmissionPolicy 不应关心的操作及其资源/子资源。
排除规则优先于包含规则(如果一个资源同时匹配两者,则它被排除)
**namedRuleWithOperations 是操作和资源及其资源名称的元组。**
- **spec.matchConstraints.excludeResourceRules.apiGroups** ([]string)
**原子性:在合并期间将被替换**
apiGroups 是资源所属的 API 组。`*` 表示所有组。
如果存在 `*`,切片的长度必须为一。必需。
- **spec.matchConstraints.excludeResourceRules.apiVersions** ([]string)
**原子性:在合并期间将被替换**
apiVersions 是资源所属的 API 版本。`*` 表示所有版本。
如果存在 `*`,切片的长度必须为一。必需。
- **spec.matchConstraints.excludeResourceRules.operations** ([]string)
**原子性:在合并期间将被替换**
operations 是准入钩子关心的操作 - CREATE、UPDATE、DELETE、CONNECT 或者 `*`
表示所有这些操作以及将来可能添加的任何准入操作。
如果存在 `*`,切片的长度必须为一。必需。
- **spec.matchConstraints.excludeResourceRules.resourceNames** ([]string)
**原子性:在合并期间将被替换**
resourceNames 是规则适用的名称白名单。空集表示允许所有。
- **spec.matchConstraints.excludeResourceRules.resources** ([]string)
**原子性:在合并期间将被替换**
resources 是此规则适用的资源列表。
例如:`pods` 表示 Pods。`pods/log` 表示 Pods 的日志子资源。
`*` 表示所有资源,但不包括子资源。`pods/*` 表示 Pods 的所有子资源。
`*/scale` 表示所有扩缩子资源。`*/*` 表示所有资源及其子资源。
如果通配符存在,验证规则将确保资源不会相互重叠。
根据封装对象的不同,可能不允许有子资源。必需。
- **spec.matchConstraints.excludeResourceRules.scope** (string)
scope 指定此规则的作用范围。有效值为 `Cluster`、`Namespaced` 和 `*`。
`Cluster` 表示仅集群作用域的资源匹配此规则。Namespace API 对象是集群作用域的。
`Namespaced` 表示仅命名空间资源匹配此规则。`*` 表示没有作用范围限制。
子资源匹配其父资源的作用范围。默认是 `*`。
- **spec.matchConstraints.matchPolicy** (string)
matchPolicy 定义了如何使用 "MatchResources" 列表来匹配传入的请求。允许的值为 "Exact" 或 "Equivalent"。
- Exact:仅当请求完全匹配指定规则时才匹配请求。
例如,如果 deployments 可以通过 apps/v1、apps/v1beta1 和 extensions/v1beta1 修改,
但 "rules" 仅包含 `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`,
则对 apps/v1beta1 或 extensions/v1beta1 的请求不会发送到 ValidatingAdmissionPolicy。
- Equivalent:如果请求修改了规则中列出的资源,即使通过另一个 API 组或版本,
也会匹配请求。例如,如果 deployments 可以通过 `apps/v1`、`apps/v1beta1` 和 `extensions/v1beta1` 修改,
并且 "rules" 仅包含 `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`,
则对 `apps/v1beta1` 或 `extensions/v1beta1` 的请求将被转换为 `apps/v1` 并发送到 ValidatingAdmissionPolicy。
默认为 "Equivalent"
- **spec.matchConstraints.namespaceSelector** (}}">LabelSelector)
namespaceSelector 决定了是否基于对象的命名空间是否匹配选择器来对该对象运行准入控制策略。
如果对象本身是一个命名空间,则匹配是针对 `object.metadata.labels` 执行的。
如果对象是另一个集群范围的资源,则永远不会跳过此策略。
例如,要对任何命名空间未关联 "runlevel" 为 "0" 或 "1" 的对象运行 Webhook,你可以将选择算符设置如下:
```yaml
"namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
```
如果你只想对那些命名空间与 "environment" 为 "prod" 或 "staging"
相关联的对象运行策略,你可以将选择器设置如下:
```yaml
"namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
```
参阅[标签选择算符示例](/zh-cn/docs/concepts/overview/working-with-objects/labels/)获取更多的示例。
默认为空的 LabelSelector,匹配所有内容。
- **spec.matchConstraints.objectSelector** (}}">LabelSelector)
objectSelector 决定了是否基于对象是否有匹配的标签来运行验证。
objectSelector 会针对将被发送到 CEL 验证的旧对象和新对象进行计算,
只要其中一个对象匹配选择算符,则视为匹配。Null 对象(在创建时为旧对象,或在删除时为新对象)
或不能有标签的对象(如 DeploymentRollback 或 PodProxyOptions 对象)不被认为匹配。
仅当 Webhook 是可选时使用对象选择器,因为终端用户可以通过设置标签跳过准入 Webhook。
默认为"空" LabelSelector,它匹配所有内容。
- **spec.matchConstraints.resourceRules** ([]NamedRuleWithOperations)
**原子性:将在合并期间被替换**
resourceRules 描述了 ValidatingAdmissionPolicy 匹配的资源/子资源上的什么操作。
只要匹配**任何**规则,策略就会关心该操作。
**NamedRuleWithOperations 是操作和带有资源名称的资源的元组。**
- **spec.matchConstraints.resourceRules.apiGroups** ([]string)
**原子性:将在合并期间被替换**
apiGroups 是资源所属的 API 组。`*` 表示所有组。如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchConstraints.resourceRules.apiVersions** ([]string)
**原子性:将在合并期间被替换**
apiVersions 是资源所属的 API 版本。`*` 表示所有版本。如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchConstraints.resourceRules.operations** ([]string)
**原子性:在合并期间将被替换**
operations 是准入钩子关心的操作 - CREATE、UPDATE、DELETE、CONNECT
或者是代表所有这些操作以及任何未来可能添加的准入操作的通配符 `*`。
如果包含了 `*`,那么切片的长度必须为一。必需字段。
- **spec.matchConstraints.resourceRules.resourceNames** ([]string)
**原子性:在合并期间将被替换**
resourceNames 是规则适用的名称白名单。一个空集合意味着允许所有。可选项。
- **spec.matchConstraints.resourceRules.resources** ([]string)
**原子性:在合并期间将被替换**
resources 是此规则适用的资源列表。
例如:`pods` 表示 pods。`pods/log` 表示 pods 的日志子资源。
`*` 表示所有资源,但不包括子资源。`pods/*` 表示 pods 的所有子资源。
`*/scale` 表示所有资源的 scale 子资源。`*/*` 表示所有资源及其子资源。
如果存在通配符,验证规则将确保资源之间不会相互重叠。
根据封装对象的不同,可能不允许有子资源。必需字段。
- **spec.matchConstraints.resourceRules.scope** (string)
scope 指定此规则的作用范围。有效值为 "`Cluster`"、"`Namespaced`" 和 "`*`"。
"`Cluster`" 表示只有集群范围的资源匹配此规则。Namespace API 对象是集群范围的。
"`Namespaced`" 表示只有名字空间作用域的资源匹配此规则。"`*`" 表示没有作用范围限制。
子资源匹配其父资源的作用范围。默认值为 "`*`"。
- **spec.paramKind** (ParamKind)
paramKind 指定用于参数化此策略的资源类型。如果不存在,则此策略没有参数,
且不会向验证表达式提供 param CEL 变量。如果 paramKind 引用了一个不存在的类型,
则此策略定义配置错误,并应用 FailurePolicy。
如果指定了 paramKind 但在 ValidatingAdmissionPolicyBinding 中未设置
paramRef,则 params 变量将为 null。
**ParamKind 是组类型和版本的组合。**
- **spec.paramKind.apiVersion** (string)
apiVersion 是资源所属的 API 组版本。格式为 "group/version"。必需字段。
- **spec.paramKind.kind** (string)
kind 是资源所属的 API 类型。必需字段。
- **spec.validations** ([]Validation)
**原子性:将在合并期间被替换**
validations 包含用于应用验证的 CEL 表达式。validations
和 auditAnnotations 不能同时为空;至少需要一个 validations 或 auditAnnotations。
**Validation 指定用于应用验证的 CEL 表达式。**
- **spec.validations.expression** (string),必需
expression 表示将由 CEL 计算的表达式。参考:
https://github.com/google/cel-spec
CEL 表达式可以访问 API 请求/响应的内容,这些内容被组织成 CEL 变量以及一些其他有用的变量:
- 'object' - 来自传入请求的对象。对于 DELETE 请求,该值为 null。
- 'oldObject' - 现有对象。对于 CREATE 请求,该值为 null。
- 'request' - API 请求的属性([参考](/pkg/apis/admission/types.go#AdmissionRequest))。
- 'params' - 由正在计算的策略绑定引用的参数资源。仅在策略具有 ParamKind 时填充。
- 'namespaceObject' - 传入对象所属的命名空间对象。对于集群范围的资源,该值为 null。
- 'variables' - 复合变量的映射,从其名称到其惰性求值的值。
例如,名为 'foo' 的变量可以作为 'variables.foo' 访问。
- 'authorizer' - 一个 CEL 鉴权器。可用于对请求的主体(用户或服务帐户)执行授权检查。
请参阅 https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
- 'authorizer.requestResource' - 由 'authorizer' 构建并使用请求资源配置的 CEL 资源检查。
`apiVersion`、`kind`、`metadata.name` 和 `metadata.generateName` 总是可以从对象的根部访问。没有其他元数据属性是可访问的。
只有形式为 `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` 的属性名称是可访问的。当在表达式中访问时,根据以下规则对可访问的属性名称进行转义:
- `__` 转义为 `__underscores__`
- `.` 转义为 `__dot__`
- `-` 转义为 `__dash__`
- `/` 转义为 `__slash__`
- 完全匹配 CEL 保留关键字的属性名称转义为 `__{keyword}__`。这些关键字包括:
"true"、"false"、"null"、"in"、"as"、"break"、"const"、"continue"、"else"、"for"、"function"、"if"、
"import"、"let"、"loop"、"package"、"namespace"、"return"。
示例:
- 访问名为 "namespace" 的属性的表达式:{"Expression": "object.__namespace__ > 0"}
- 访问名为 "x-prop" 的属性的表达式:{"Expression": "object.x__dash__prop > 0"}
- 访问名为 "redact__d" 的属性的表达式:{"Expression": "object.redact__underscores__d > 0"}
对于类型为 'set' 或 'map' 的列表,数组上的相等性忽略元素顺序,即 [1, 2] == [2, 1]。
带有 x-kubernetes-list-type 的数组上的连接使用列表类型的语义:
- 'set':`X + Y` 执行一个联合操作,其中 `X` 中所有元素的数组位置被保留,
并且 `Y` 中不相交的元素被追加,保持它们的部分顺序。
- 'map':`X + Y` 执行一个合并操作,其中 `X` 中所有键的数组位置被保留,
但值被 `Y` 中的值覆盖,当 `X` 和 `Y` 的键集相交时。`Y` 中具有不相交键的元素被追加,
保持它们的部分顺序。
必需。
- **spec.validations.message** (string)
message 表示验证失败时显示的消息。如果 expression 包含换行符,
则消息是必需的。消息中不能包含换行符。如果未设置,消息为 "failed rule: {Rule}"。
例如 "must be a URL with the host matching spec.host"。
如果 expression 包含换行符,则 message 是必需的。消息中不能包含换行符。
如果未设置,消息为 "failed Expression: {Expression}"。
- **spec.validations.messageExpression** (string)
messageExpression 声明一个 CEL 表达式,当此规则失败时返回该表达式计算得到的验证失败消息。
由于 messageExpression 用作失败消息,它必须计算为字符串。如果验证同时包含
message 和 messageExpression,则验证失败时将使用 messageExpression。
如果 messageExpression 导致运行时错误,将记录运行时错误,并且如同未设置
messageExpression 字段一样生成验证失败消息。如果 messageExpression
计算为空字符串、仅包含空格的字符串或包含换行符的字符串,则同样会如同未设置 messageExpression
字段一样生成验证失败消息,并且将记录 messageExpression 产生了空字符串/仅包含空格的字符串/包含换行符的字符串的情况。
messageExpression 可访问与 `expression` 相同的所有变量,除了 'authorizer' 和
'authorizer.requestResource'。示例:"object.x 必须小于最大值 ("+string(params.max)+")"
- **spec.validations.reason** (string)
reason 表示机器可读的描述,说明为何此验证失败。如果这是列表中第一个失败的验证,
则这个 reason 以及相应的 HTTP 响应代码将用于对客户端的 HTTP 响应。
当前支持的原因有:"Unauthorized"、"Forbidden"、"Invalid"、"RequestEntityTooLarge"。
如果没有设置,在响应给客户端时将使用 StatusReasonInvalid。
- **spec.variables** ([]Variable)
**补丁策略:基于 `name` 键合并**
**映射:在合并期间,基于 name 键的唯一值将被保留**
变量包含可用于其他表达式组合的变量定义。每个变量都被定义为一个命名的 CEL 表达式。
这里定义的变量将在策略的其他表达式中的 `variables` 下可用,除了 matchConditions,
因为 matchConditions 会在策略其余部分之前进行计算。
变量的表达式可以引用列表中先前定义的其他变量,但不能引用后续定义的变量。
因此,variables 必须按照首次出现的顺序排序并且不可存在循环的。
**Variable** 是用于组合的变量定义。变量被定义为一个命名的表达式。
- **spec.variables.expression** (string),必需
expression 是将被计算为变量值的表达式。CEL 表达式可以访问与 validation 中的 CEL 表达式相同的标识符。
- **spec.variables.name** (string),必需
name 是变量的名称。名称必须是有效的 CEL 标识符,并且在所有变量中唯一。变量可以通过 `variables`
在其他表达式中访问。例如,如果名称是 "foo",变量将作为 `variables.foo` 可用。
- **status** (ValidatingAdmissionPolicyStatus)
ValidatingAdmissionPolicy 的状态,包括有助于确定策略是否按预期行为的警告。由系统填充。只读。
**ValidatingAdmissionPolicyStatus** 表示一个准入验证策略的状态。
- **status.conditions** ([]Condition)
**在合并期间,键类型上的唯一值将被保留**
这些条件表示策略当前状态的最新可用观察结果。
**Condition** 包含此 API 资源当前状态某一方面的详细信息。
- **status.conditions.lastTransitionTime** (Time),必填
lastTransitionTime 是条件从一个状态转换到另一个状态的最后时间。这应该是底层条件改变的时间。
如果不知道该时间,使用 API 字段更改的时间是可以接受的。
**Time** 是对 time.Time 的封装,支持正确地序列化为 YAML 和 JSON。time 包提供的许多工厂方法都有对应的封装。
- **status.conditions.message** (string),必填
message 是一个人类可读的消息,指示有关过渡的详细信息。这可以是一个空字符串。
- **status.conditions.reason** (string),必填
reason 包含一个编程标识符,指示条件上次转换的原因。特定条件类型的提供者可以为此字段定义预期值和含义,
以及这些值是否被视为保证的 API。值应当是 CamelCase 格式的字符串。此字段不能为空。
- **status.conditions.status** (string),必需
condition 的状态,可能是 True、False、Unknown 中的一个。
- **status.conditions.type** (string),必需
condition 的类型,采用 CamelCase 或 foo.example.com/CamelCase 格式。
- **status.conditions.observedGeneration** (int64)
observedGeneration 表示设置条件时依据的 .metadata.generation。例如,如果当前
.metadata.generation 是 12,而 .status.conditions[x].observedGeneration 是 9,
则说明该条件相对于实例的当前状态已过期。
- **status.observedGeneration** (int64)
控制器观察到的 generation。
- **status.typeChecking** (TypeChecking)
每个表达式的类型检查结果。此字段的存在表明类型检查已完成。
**TypeChecking 包含了对 ValidatingAdmissionPolicy 中表达式进行类型检查的结果**
- **status.typeChecking.expressionWarnings** ([]ExpressionWarning)
**原子性:将在合并期间被替换**
每个表达式的类型检查警告。
**ExpressionWarning 是针对特定表达式的警告信息。**
- **status.typeChecking.expressionWarnings.fieldRef** (string),必需
引用表达式的字段路径。例如,对 validations 第一项的表达式的引用是 "spec.validations[0].expression"
- **status.typeChecking.expressionWarnings.warning** (string),必需
人类可读形式的类型检查信息内容。警告的每一行包含表达式所检查的类型,然后是编译器报告的类型检查错误。
## ValidatingAdmissionPolicyList {#ValidatingAdmissionPolicyList}
ValidatingAdmissionPolicyList 是 ValidatingAdmissionPolicy 的列表。
- **items** ([]}}">ValidatingAdmissionPolicy),必需
ValidatingAdmissionPolicy 的列表。
- **apiVersion** (string)
apiVersion 定义了对象表示的版本化模式。服务器应该将识别的模式转换为最新的内部值,并可能拒绝未识别的值。
更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
kind 是一个字符串值,表示此对象代表的 REST 资源。服务器可能从客户端提交请求的端点推断出该值。
不能更新。采用驼峰命名法。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (}}">ListMeta)
标准的列表元数据。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
## ValidatingAdmissionPolicyBinding {#ValidatingAdmissionPolicyBinding}
ValidatingAdmissionPolicyBinding 将 ValidatingAdmissionPolicy 与参数化资源绑定。
ValidatingAdmissionPolicyBinding 和参数 CRD 共同定义了集群管理员如何为集群配置策略。
对于一个给定的准入请求,每个绑定将导致其策略被计算 N 次,其中 N 对于不使用参数的策略/绑定是 1,
否则 N 是由绑定选择的参数数量。
策略的 CEL 表达式必须具有低于最大 CEL 预算的计算 CEL 成本。每次策略计算都有独立的
CEL 成本预算。添加/移除策略、绑定或参数不会影响特定(策略,绑定,参数)组合是否在其自身的 CEL 预算内。
- **apiVersion** (string)
apiVersion 定义了对象此表示形式的版本化模式。服务器应将识别的模式转换为最新的内部值,
并可能拒绝未识别的值。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- **kind** (string)
kind 是一个字符串值,代表此对象表示的 REST 资源。服务器可从客户端提交请求的端点推断出该值。
不能更新。采用驼峰式命名法。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata**(}}">ObjectMeta)
标准的对象元数据;更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata。
- **spec** (ValidatingAdmissionPolicyBindingSpec)
ValidatingAdmissionPolicyBinding 的期望行为规范。
**ValidatingAdmissionPolicyBindingSpec 是 ValidatingAdmissionPolicyBinding 的规范。**
- **spec.matchResources** (MatchResources)
matchResources 声明了哪些资源匹配此绑定并会由此进行验证。注意,这与策略的 matchConstraints 相交,
因此只有被策略匹配的请求才能由此选择。如果此字段未设置,则由策略匹配的所有资源都将由此绑定验证。
当 resourceRules 未设置时,它不限制资源匹配。如果资源符合此对象的其他字段,它将被验证。
注意,这与 ValidatingAdmissionPolicy matchConstraints 不同,在那里 resourceRules 是必需的。
**MatchResources 根据对象是否满足匹配条件来决定是否对其运行准入控制策略。
排除规则优先于包含规则(如果一个资源同时匹配两者,则该资源被排除)**
- **spec.matchResources.excludeResourceRules** ([]NamedRuleWithOperations)
**原子性:将在合并期间被替换**
excludeResourceRules 描述了 ValidatingAdmissionPolicy 应忽略的操作和资源/子资源。
排除规则优先于包含规则(如果一个资源同时匹配两者,则该资源被排除)
**NamedRuleWithOperations 是操作和资源及资源名称的元组。**
- **spec.matchResources.excludeResourceRules.apiGroups** ([]string)
**原子性:将在合并期间被替换**
apiGroups 是资源所属的 API 组。`*` 表示所有组。
如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchResources.excludeResourceRules.apiVersions** ([]string)
**原子性:将在合并期间被替换**
apiVersions 是资源所属的 API 版本。`*` 表示所有版本。
如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchResources.excludeResourceRules.operations** ([]string)
**原子性:将在合并期间被替换**
operations 是 admission hook 关心的操作 - CREATE、UPDATE、DELETE、CONNECT 或者
`*` 表示所有这些操作以及将来可能添加的任何 admission 操作。
如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchResources.excludeResourceRules.resourceNames** ([]string)
**原子性:将在合并期间被替换**
resourceNames 是规则适用的名字白名单。空集表示允许所有。
- **spec.matchResources.excludeResourceRules.resources** ([]string)
**原子性:将在合并期间被替换**
resources 是此规则适用的资源列表。
例如:`pods` 表示 pods。`pods/log` 表示 pods 的日志子资源。`*` 表示所有资源,
但不包括子资源。`pods/*` 表示 pods 的所有子资源。`*/scale` 表示所有 scale 子资源。
`*/*` 表示所有资源及其子资源。
如果存在通配符,验证规则将确保资源不会相互重叠。
根据封装对象的不同,可能不允许有子资源。必需。
- **spec.matchResources.excludeResourceRules.scope** (string)
scope 指定此规则的范围。有效值为 "`Cluster`"、"`Namespaced`" 和 "`*`"。"`Cluster`"
表示只有集群范围的资源将匹配此规则。Namespace API 对象是集群范围的。"`Namespaced`"
表示只有命名空间范围的资源将匹配此规则。"`*`" 表示没有范围限制。子资源匹配其父资源的范围。默认是 "`*`"。
- **spec.matchResources.matchPolicy** (string)
matchPolicy 定义了如何使用 "MatchResources" 列表来匹配传入的请求。允许的值为 "Exact" 或 "Equivalent"。
- Exact:仅当请求完全匹配指定规则时才匹配请求。例如,如果 deployments 可以通过
apps/v1、apps/v1beta1 和 extensions/v1beta1 修改,但 "rules" 仅包含
`apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`,
则对 apps/v1beta1 或 extensions/v1beta1 的请求不会发送到 ValidatingAdmissionPolicy。
- Equivalent:如果请求修改了规则中列出的资源,即使通过另一个 API 组或版本,也会匹配请求。
例如,如果 deployments 可以通过 apps/v1、apps/v1beta1 和 extensions/v1beta1 修改,
并且 "rules" 仅包含 `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`,
则对 apps/v1beta1 或 extensions/v1beta1 的请求将被转换为 apps/v1 并发送到 ValidatingAdmissionPolicy。
默认为 "Equivalent"
- **spec.matchResources.namespaceSelector** (}}">LabelSelector)
namespaceSelector 决定了是否基于对象的命名空间是否匹配选择器来对对象运行准入控制策略。
如果对象本身是一个命名空间,则匹配是在 object.metadata.labels 上执行的。
如果对象是另一个集群范围的资源,则永远不会跳过该策略。
例如,要对任何命名空间未关联 "runlevel" 为 "0" 或 "1" 的对象运行 Webhook,你可以将选择器设置如下:
```yaml
"namespaceSelector": {
"matchExpressions": [
{
"key": "runlevel",
"operator": "NotIn",
"values": [
"0",
"1"
]
}
]
}
```
如果你只想对那些命名空间与 "environment" 的 "prod" 或 "staging" 相关联的对象运行策略,你可以将选择器设置如下:
```yaml
"namespaceSelector": {
"matchExpressions": [
{
"key": "environment",
"operator": "In",
"values": [
"prod",
"staging"
]
}
]
}
```
参见[标签选择器示例](/zh-cn/docs/concepts/overview/working-with-objects/labels/)获取更多例子。
默认为空的 LabelSelector,它匹配所有内容。
- **spec.matchResources.objectSelector** (}}">LabelSelector)
objectSelector 决定是否基于对象是否有匹配的标签来运行验证。objectSelector 会针对将被发送到
CEL 验证的旧对象和新对象进行计算,只要其中一个对象匹配选择器,则认为匹配。
一个空对象(在创建时的旧对象,或在删除时的新对象)或不能有标签的对象(如
DeploymentRollback 或 PodProxyOptions 对象)不被认为是匹配的。
仅在 Webhook 是可选的情况下使用对象选择器,因为最终用户可以通过设置标签跳过准入
Webhook。默认为空的 LabelSelector ,它匹配所有内容。
- **spec.matchResources.resourceRules** ([]NamedRuleWithOperations)
**原子性:将在合并期间被替换**
resourceRules 描述了 ValidatingAdmissionPolicy 匹配的资源/子资源上的什么操作。
如果操作匹配**任意**规则,策略就会关心该操作。
**NamedRuleWithOperations 是操作和带有资源名称的资源的元组。**
- **spec.matchResources.resourceRules.apiGroups** ([]string)
**原子性:将在合并期间被替换**
apiGroups 是资源所属的 API 组。`*` 表示所有组。如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchResources.resourceRules.apiVersions** ([]string)
**原子性:将在合并期间被替换**
apiVersions 是资源所属的 API 版本。`*` 表示所有版本。如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchResources.resourceRules.operations** ([]string)
**原子性:将在合并期间被替换**
operations 是准入钩子关心的操作 - CREATE、UPDATE、DELETE、CONNECT 或 `*`
表示所有这些操作和将来可能添加的任何其他准入操作。如果存在 `*`,则切片的长度必须为一。必需。
- **spec.matchResources.resourceRules.resourceNames** ([]string)
**原子性:将在合并期间被替换**
resourceNames 是规则适用的名称可选白名单。一个空集意味着允许所有。
- **spec.matchResources.resourceRules.resources** ([]string)
**原子性:将在合并期间被替换**
resources 是此规则适用的资源列表。
例如:'pods' 表示 Pods。'pods/log' 表示 Pods 的日志子资源。`*` 表示所有资源,
但不包括子资源。`pods/*` 表示 Pods 的所有子资源。`*/scale` 表示所有扩缩子资源。
`*/*` 表示所有资源及其子资源。
如果通配符存在,验证规则将确保资源不会相互重叠。
取决于外层对象是什么,可能不允许有子资源。必需。
- **spec.matchResources.resourceRules.scope** (string)
scope 指定此规则的范围。有效值为 "`Cluster`"、"`Namespaced`" 和 "`*`"。
- "`Cluster`" 表示只有集群范围的资源会匹配此规则。Namespace API 对象是集群范围的。
- "`Namespaced`" 表示只有命名空间范围的资源会匹配此规则。
- "`*`" 表示没有范围限制。
子资源匹配其父资源的范围。默认是 "`*`"。
- **spec.paramRef** (ParamRef)
paramRef 指定了用于配置准入控制策略的参数资源。它应该指向绑定的 ValidatingAdmissionPolicy
中 paramKind 所指定类型的资源。如果策略指定了 paramKind 而且由 paramRef 引用的资源不存在,
则认为此绑定配置错误,并应用 ValidatingAdmissionPolicy 的 FailurePolicy。
如果策略没有指定 paramKind,则此字段将被忽略,规则将在没有参数的情况下进行计算。
**ParamRef** 描述了如何定位将作为策略绑定所应用规则表达式的输入参数。
- **spec.paramRef.name** (string)
name 是被引用资源的名称。
`name` 或 `selector` 必须设置一个,但 `name` 和 `selector` 是互斥属性。
如果设置了其中一个,另一个必须未设置。
通过设置 `name` 字段,留空 `selector`,并根据需要设置 namespace
(如果 `paramKind` 是命名空间范围的),可以为所有准入请求配置单个参数。
- **spec.paramRef.namespace** (string)
namespace 是被引用资源的命名空间。允许将参数搜索限制到特定命名空间。适用于 `name` 和 `selector` 字段。
通过在策略中指定命名空间范围的 `paramKind` 并留空此字段,可以使用每个命名空间的参数。
- 如果 `paramKind` 是集群范围的,此字段必须未设置。设置此字段会导致配置错误。
- 如果 `paramKind` 是命名空间范围的,在计算准入的对象时,如果此字段未设置,则会使用该对象的命名空间。
请注意,如果此字段为空,则绑定不能匹配任何集群范围的资源,否则将导致错误。
- **spec.paramRef.parameterNotFoundAction** (string)
`parameterNotFoundAction` 控制当资源存在,且名称或选择器有效但没有匹配的参数时绑定的行为。
如果值设置为 `Allow`,则未匹配到参数将被视为绑定的成功验证。如果设置为 `Deny`,
则未匹配到参数将会受到策略的 `failurePolicy` 的影响。
允许的值为 `Allow` 或 `Deny`
必需
- **spec.paramRef.selector** (}}">LabelSelector)
selector 可以用于根据 param 对象的标签匹配多个对象。提供 `selector: {}` 以匹配所有 ParamKind 的资源。
如果找到多个 params,它们都将使用策略表达式进行计算,并将结果进行 AND 连接。
必须设置 `name` 或 `selector` 中的一个,但 `name` 和 `selector` 是互斥属性。如果设置了其中一个,另一个必须未设置。
- **spec.policyName** (string)
policyName 引用一个 ValidatingAdmissionPolicy 的名称,ValidatingAdmissionPolicyBinding
将绑定到该名称。如果引用的资源不存在,此绑定将被视为无效并被忽略。必需。
- **spec.validationActions** ([]string)
**集合:唯一值将在合并期间被保留**
validationActions 声明了如何执行引用的 ValidatingAdmissionPolicy 的验证。
如果验证结果为 false,则根据这些操作强制执行。
仅当 FailurePolicy 设置为 Fail 时,根据这些操作强制执行由 ValidatingAdmissionPolicy
的 FailurePolicy 定义的失败,包括编译错误、运行时错误和策略的错误配置。否则,这些失败将被忽略。
validationActions 被声明为一组操作值。顺序不重要。validationActions 不得包含相同操作的重复项。
支持的操作值包括:
"Deny" 指定验证失败将导致请求被拒绝。
"Warn" 指定验证失败将以 HTTP 警告头的形式报告给请求客户端,警告代码为 299。警告可以随允许或拒绝的准入响应一起发送。
"Audit" 指定验证失败将包含在请求的已发布审计事件中。审计事件将包含一个
`validation.policy.admission.k8s.io/validation_failure` 审计注解,
其值包含验证失败的详细信息,格式为对象列表的 JSON,每个对象具有以下字段:
- message:验证失败消息字符串
- policy:ValidatingAdmissionPolicy 的资源名称
- binding:ValidatingAdmissionPolicyBinding 的资源名称
- expressionIndex:在 ValidatingAdmissionPolicy 中失败验证的索引
- validationActions:针对验证失败执行的强制操作
示例审计注解:
`"validation.policy.admission.k8s.io/validation_failure": "[{\"message\": \"Invalid value\", {\"policy\": \"policy.example.com\", {\"binding\": \"policybinding.example.com\", {\"expressionIndex\": \"1\", {\"validationActions\": [\"Audit\"]}]"`
客户端应预期通过忽略任何未识别的值来处理额外的值。
"Deny" 和 "Warn" 不能一起使用,因为这种组合会不必要地在 API 响应体和 HTTP 警告头中重复验证失败。
必需。
## 操作 {#Operations}
### `get` 读取指定的 ValidatingAdmissionPolicy
#### HTTP 请求
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
#### 参数
- **name** (**路径参数**): string,必需
ValidatingAdmissionPolicy 的名称。
- **pretty** (**查询参数**): string
}}">pretty
## 响应
200 (}}">ValidatingAdmissionPolicy): OK
401: Unauthorized
### `get` 读取指定 ValidatingAdmissionPolicy 的状态
#### HTTP 请求
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status
#### 参数
- **name** (**路径参数**): string,必需
ValidatingAdmissionPolicy 的名称。
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">ValidatingAdmissionPolicy): OK
401: Unauthorized
### `list` 列出或监视 ValidatingAdmissionPolicy 类型的对象
#### HTTP 请求
GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies
#### 参数
- **allowWatchBookmarks**(**查询参数**):boolean
}}">allowWatchBookmarks
- **continue**(**查询参数**):string
}}">continue
- **fieldSelector**(**查询参数**):string
}}">fieldSelector
- **labelSelector** (**查询参数**):string
}}">labelSelector
- **limit**(**查询参数**):integer
}}">limit
- **pretty**(**查询参数**):string
}}">pretty
- **resourceVersion**(**查询参数**):string
}}">resourceVersion
- **resourceVersionMatch**(**查询参数**):string
}}">resourceVersionMatch
- **sendInitialEvents**(**查询参数**):boolean
}}">sendInitialEvents
- **timeoutSeconds**(**查询参数**):integer
}}">timeoutSeconds
- **watch**(**查询参数**):boolean
}}">watch
#### 响应
200 (}}">ValidatingAdmissionPolicyList): OK
401: Unauthorized
### `create` 创建 ValidatingAdmissionPolicy
#### HTTP 请求
POST /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies
#### 参数
- **body**: }}">ValidatingAdmissionPolicy, 必填
- **dryRun**(**查询参数**):string
}}">dryRun
- **fieldManager**(**查询参数**):string
}}">fieldManager
- **fieldValidation**(**查询参数**):string
}}">fieldValidation
- **pretty**(**查询参数**):string
}}">pretty
#### 响应
200 (}}">ValidatingAdmissionPolicy): OK
201 (}}">ValidatingAdmissionPolicy): Created
202 (}}">ValidatingAdmissionPolicy): Accepted
401: Unauthorized
### `update` 替换指定的 ValidatingAdmissionPolicy
#### HTTP 请求
PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
#### 参数
- **name** (*路径参数*):string,必需
ValidatingAdmissionPolicy 的名称。
- **body**: }}">ValidatingAdmissionPolicy,必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">ValidatingAdmissionPolicy): OK
201 (}}">ValidatingAdmissionPolicy): Created
401: Unauthorized
### `update` 替换指定 ValidatingAdmissionPolicy 的状态
#### HTTP 请求
PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status
#### 参数
- **name** (**路径参数**):字符串,必需
ValidatingAdmissionPolicy 的名称。
- **body**: }}">ValidatingAdmissionPolicy, 必填
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">ValidatingAdmissionPolicy): OK
201 (}}">ValidatingAdmissionPolicy): Created
401: Unauthorized
### `patch` 部分更新指定的 ValidatingAdmissionPolicy
#### HTTP 请求
PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
#### 参数
- **name** (**路径参数**): string,必需
ValidatingAdmissionPolicy 的名称。
- **body**: }}">DeleteOptions
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **force** (**查询参数**): boolean
}}">force
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">ValidatingAdmissionPolicy): OK
201 (}}">ValidatingAdmissionPolicy): Created
401: Unauthorized
### `patch` 部分更新指定 ValidatingAdmissionPolicy 的状态
#### HTTP 请求
PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status
#### 参数
- **name** (**路径参数**): string,必需
name of the ValidatingAdmissionPolicy
- **body**: }}">Patch,必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **force** (**查询参数**): boolean
}}">force
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">ValidatingAdmissionPolicy): OK
201 (}}">ValidatingAdmissionPolicy): Created
401: Unauthorized
### `delete` 删除 ValidatingAdmissionPolicy
#### HTTP 请求
DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}
### 参数
- **name** (**路径参数**): string,必需
ValidatingAdmissionPolicy 的名称。
- **body**: }}">DeleteOptions
- **dryRun** (**查询参数**): string
}}">dryRun
- **gracePeriodSeconds** (**查询参数**): integer
}}">gracePeriodSeconds
- **ignoreStoreReadErrorWithClusterBreakingPotential** (**查询参数**): boolean
}}">ignoreStoreReadErrorWithClusterBreakingPotential
- **pretty** (**查询参数**): string
}}">pretty
- **propagationPolicy** (**查询参数**): string
}}">propagationPolicy
#### 响应
200 (}}">Status): OK
202 (}}">Status): Accepted
401: Unauthorized
### `deletecollection` 删除 ValidatingAdmissionPolicy 的集合
#### HTTP 请求
DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies
#### 参数
- **body**: }}">DeleteOptions
- **continue** (**查询参数**): string
}}">continue
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldSelector** (**查询参数**): string
}}">fieldSelector
- **gracePeriodSeconds** (**查询参数**): integer
}}">gracePeriodSeconds
- **ignoreStoreReadErrorWithClusterBreakingPotential** (**查询参数**): boolean
}}">ignoreStoreReadErrorWithClusterBreakingPotential
- **labelSelector** (**查询参数**): string
}}">labelSelector
- **limit** (**查询参数**): integer
}}">limit
- **pretty** (**查询参数**): string
}}">pretty
- **propagationPolicy** (**查询参数**): string
}}">propagationPolicy
- **resourceVersion** (**查询参数**): string
}}">resourceVersion
- **resourceVersionMatch** (**查询参数**): string
}}">resourceVersionMatch
- **sendInitialEvents** (**查询参数**): boolean
}}">sendInitialEvents
- **timeoutSeconds** (**查询参数**): integer
}}">timeoutSeconds
#### 响应
200 (}}">Status): OK
401: Unauthorized