<p>
v1 包中包含 API 的 v1 版本。 </p>
资源类型
AdmissionConfiguration {#apiserver-config-k8s-io-v1-AdmissionConfiguration}
<p>
AdmissionConfiguration 为准入控制器提供版本化的配置。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.config.k8s.io/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>AdmissionConfiguration</code></td></tr>
<tr><td><code>plugins</code><br/> <a href="#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration"><code>[]AdmissionPluginConfiguration</code></a> </td> <td> <p>
<code>plugins</code> 字段允许为每个准入控制插件设置配置选项。 </p> </td> </tr>
</tbody> </table>
AuthorizationConfiguration {#apiserver-config-k8s-io-v1-AuthorizationConfiguration}
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.config.k8s.io/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>AuthorizationConfiguration</code></td></tr>
<tr><td><code>authorizers</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-AuthorizerConfiguration"><code>[]AuthorizerConfiguration</code></a> </td> <td> <p>
<code>authorizers</code> 是用于针对请求进行鉴权的鉴权组件的有序列表。 这类似于 <code>--authorization-modes</code> kube-apiserver 标志。 必须至少包含一个元素。 </p> </td> </tr> </tbody> </table>
EncryptionConfiguration {#apiserver-config-k8s-io-v1-EncryptionConfiguration}
<p>
EncryptionConfiguration 存储加密驱动的完整配置。它还允许使用通配符来指定应该被加密的资源。 使用 “*.<group>” 以加密组内的所有资源,或使用 “*.*” 以加密所有资源。 “*.” 可用于加密核心组中的所有资源。“*.*” 将加密所有资源,包括在 API 服务器启动后添加的自定义资源。 由于部分配置可能无效,所以不允许在同一资源列表中或跨多个条目使用重叠的通配符。 资源列表被按顺序处理,会优先处理较早的列表。 </p> <p>
示例: </p>
<pre><code>kind: EncryptionConfiguration apiVersion: apiserver.config.k8s.io/v1 resources:
- resources:
- events providers:
- identity: {} # 即使以下 . 被指定,也不会对事件加密
- resources:
- secrets
- configmaps
- pandas.awesome.bears.example providers:
- aescbc:
keys:
- name: key1 secret: c2VjcmV0IGlzIHNlY3VyZQ==
- resources:
- '*.apps' providers:
- aescbc:
keys:
- name: key2 secret: c2VjcmV0IGlzIHNlY3VyZSwgb3IgaXMgaXQ/Cg==
- resources:
- '.' providers:
- aescbc:
keys:
- name: key3 secret: c2VjcmV0IGlzIHNlY3VyZSwgSSB0aGluaw== </code></pre>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>apiserver.config.k8s.io/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>EncryptionConfiguration</code></td></tr>
<tr><td><code>resources</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-ResourceConfiguration"><code>[]ResourceConfiguration</code></a> </td> <td> <p>
<code>resources</code> 是一个包含资源及其对应加密驱动的列表。 </p> </td> </tr> </tbody> </table>
AESConfiguration {#apiserver-config-k8s-io-v1-AESConfiguration}
出现在:
<p>
AESConfiguration 包含针对 AES 转换器的 API 配置。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>keys</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-Key"><code>[]Key</code></a> </td> <td> <p>
<code>keys</code> 是一个用于创建 AES 转换器的密钥列表。 对于 AES-CBC,每个密钥的长度必须是 32 字节; 对于 AES-GCM,每个密钥的长度可以是 16、24 或 32 字节。 </p> </td> </tr> </tbody> </table>
AdmissionPluginConfiguration {#apiserver-config-k8s-io-v1-AdmissionPluginConfiguration}
出现在:
<p>AdmissionPluginConfiguration 为某个插件提供配置信息。</p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>name</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>name</code> 是准入控制器的名称。它必须与所注册的准入插件名称匹配。 </p> </td> </tr>
<tr><td><code>path</code><br/> <code>string</code> </td> <td> <p>
<code>path</code> 是指向包含插件配置信息的配置文件的路径。 </p> </td> </tr>
<tr><td><code>configuration</code><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#Unknown"><code>k8s.io/apimachinery/pkg/runtime.Unknown</code></a> </td> <td> <p>
<code>configuration</code> 是一个内嵌的配置对象,用来保存插件的配置信息。 如果存在,则使用这里的配置信息而不是指向配置文件的路径。 </p> </td> </tr>
</tbody> </table>
AuthorizerConfiguration {#apiserver-config-k8s-io-v1-AuthorizerConfiguration}
出现在:
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>type</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>type</code> 指的是鉴权组件的类型。 通用 API 服务器支持 "Webhook"。 其他 API 服务器可能支持额外的鉴权组件类型,如 Node、RBAC、ABAC 等。 </p> </td> </tr> <tr><td><code>name</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>name</code> 用于描述 Webhook。 此字段的明确用途是供监控机制中的指标使用。 注意:<code>name</code> 值必须是 DNS1123 标签,如 <code>myauthorizername</code> 或子域名, 如 <code>myauthorizer.example.domain</code>。 必需,无默认值。 </p> </td> </tr> <tr><td><code>webhook</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-WebhookConfiguration"><code>WebhookConfiguration</code></a> </td> <td> <p>
<code>webhook</code> 定义 Webhook 鉴权组件的配置。 当 <code>type</code> 为 Webhook 时,必须定义。 当 <code>type</code> 不是 Webhook 时,不得定义。 </p> </td> </tr> </tbody> </table>
IdentityConfiguration {#apiserver-config-k8s-io-v1-IdentityConfiguration}
出现在:
<p>
IdentityConfiguration 是一个空结构体,允许在驱动配置中使用身份转换器。 </p>
KMSConfiguration {#apiserver-config-k8s-io-v1-KMSConfiguration}
出现在:
<p>
KMSConfiguration 包含 KMS 型信封转换器所用的配置文件的名称、缓存大小和路径。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>apiVersion</code><br/> <code>string</code> </td> <td> <p>
KeyManagementService 的 apiVersion </p> </td> </tr> <tr><td><code>name</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>name</code> 是要使用的 KMS 插件的名称。 </p> </td> </tr> <tr><td><code>cachesize</code><br/> <code>int32</code> </td> <td> <p>
<code>cachesize</code> 是内存中缓存的最大 Secret 数量。默认值为 1000。 设置为负值将禁用缓存。此字段仅允许用于 KMS v1 驱动。 </p> </td> </tr> <tr><td><code>endpoint</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>endpoint</code> 是 gRPC 服务器的监听地址,例如 "unix:///var/run/kms-provider.sock"。 </p> </td> </tr> <tr><td><code>timeout</code><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a> </td> <td> <p>
<code>timeout</code> 是 gRPC 调用到 KMS 插件的超时时间(例如 5s)。默认值为 3 秒。 </p> </td> </tr> </tbody> </table>
Key {#apiserver-config-k8s-io-v1-Key}
出现在:
<p>
Key 包含为转换器所提供的密钥的名称和 Secret。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>name</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>name</code> 是在将数据存储到磁盘时所使用的密钥名称。 </p> </td> </tr> <tr><td><code>secret</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>secret</code> 是实际的密钥,以 base64 编码。 </p> </td> </tr> </tbody> </table>
ProviderConfiguration {#apiserver-config-k8s-io-v1-ProviderConfiguration}
出现在:
<p>
ProviderConfiguration 存储为加密驱动提供的配置。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>aesgcm</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-AESConfiguration"><code>AESConfiguration</code></a> </td> <td> <p>
<code>aesgcm</code> 是 AES-GCM 转换器的配置。 </p> </td> </tr> <tr><td><code>aescbc</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-AESConfiguration"><code>AESConfiguration</code></a> </td> <td> <p>
<code>aescbc</code> 是 AES-CBC 转换器的配置。 </p> </td> </tr> <tr><td><code>secretbox</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-SecretboxConfiguration"><code>SecretboxConfiguration</code></a> </td> <td> <p>
<code>secretbox</code> 是基于 Secretbox 的转换器的配置。 </p> </td> </tr> <tr><td><code>identity</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-IdentityConfiguration"><code>IdentityConfiguration</code></a> </td> <td> <p>
<code>identity</code> 是身份转换器的(空)配置。 </p> </td> </tr> <tr><td><code>kms</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-KMSConfiguration"><code>KMSConfiguration</code></a> </td> <td> <p>
<code>kms</code> 包含 KMS 型信封转换器所用的配置文件的名称、缓存大小和路径。 </p> </td> </tr> </tbody> </table>
ResourceConfiguration {#apiserver-config-k8s-io-v1-ResourceConfiguration}
出现在:
<p>
ResourceConfiguration 存储每个资源的配置。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>resources</code> <B>[必需]</B><br/> <code>[]string</code> </td> <td> <p>
<code>resources</code> 是一个需要加密的 Kubernetes 资源列表。 资源名称来源于组/版本/资源的 “<code>resource</code>” 或 “<code>resource.group</code>”。 例如,pandas.awesome.bears.example 是一个自定义资源,其 “group” 为 awesome.bears.example, “resource” 为 pandas。使用 “*.*” 以加密所有资源,使用 “*.<group>” 以加密特定组中的所有资源。 例如,“*.awesome.bears.example” 将加密 “awesome.bears.example” 组中的所有资源。 再比如,“*.” 将加密核心组中的所有资源(如 Pod、ConfigMap 等)。 </p> </td> </tr> <tr><td><code>providers</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-ProviderConfiguration"><code>[]ProviderConfiguration</code></a> </td> <td> <p>
<code>providers</code> 是从磁盘读取资源和写入资源到磁盘要使用的转换器的列表。 例如:aesgcm、aescbc、secretbox、identity、kms。 </p> </td> </tr> </tbody> </table>
SecretboxConfiguration {#apiserver-config-k8s-io-v1-SecretboxConfiguration}
出现在:
<p>
SecretboxConfiguration 包含 Secretbox 转换器的 API 配置。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>keys</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-Key"><code>[]Key</code></a> </td> <td> <p>
<code>keys</code> 是一个用于创建 Secretbox 转换器的密钥列表。每个密钥的长度必须为 32 字节。 </p> </td> </tr> </tbody> </table>
WebhookConfiguration {#apiserver-config-k8s-io-v1-WebhookConfiguration}
出现在:
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>authorizedTTL</code> <B>[必需]</B><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a> </td> <td> <p>
用于缓存来自 Webhook 鉴权组件的 'authorized' 响应的持续时间。 与设置 <code>--authorization-webhook-cache-authorized-ttl</code> 标志效果相同。 默认值:5m0s。 </p> </td> </tr> <tr><td><code>unauthorizedTTL</code> <B>[必需]</B><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a> </td> <td> <p>
用于缓存来自 Webhook 鉴权组件的 'unauthorized' 响应的持续时间。 与设置 <code>--authorization-webhook-cache-unauthorized-ttl</code> 标志效果相同。 默认值:30s。 </p> </td> </tr> <tr><td><code>timeout</code> <B>[必需]</B><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a> </td> <td> <p>
Webhook 请求的超时时间。 最大允许值为 30s。 必需,无默认值。 </p> </td> </tr> <tr><td><code>subjectAccessReviewVersion</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
发送到 Webhook 并期望从 Webhook 接收到的 authorization.k8s.io SubjectAccessReview 的 API 版本。 与设置 <code>--authorization-webhook-version</code> 标志效果相同。 有效值:v1beta1、v1。 必需,无默认值。 </p> </td> </tr> <tr><td><code>matchConditionSubjectAccessReviewVersion</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>matchConditionSubjectAccessReviewVersion</code> 指定了 CEL 表达式求值所用的 SubjectAccessReview 版本。 有效值:v1。 必需,无默认值。 </p> </td> </tr> <tr><td><code>failurePolicy</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
控制当 Webhook 请求未能完成、返回格式错误的响应或在评估 matchConditions 时发生错误的情况下鉴权决策。 有效值: </p> <ul> <li>
NoOpinion:继续处理后续的鉴权组件以查看它们中是否有一个允许请求。 </li> <li>
Deny:拒绝请求,不咨询后续鉴权组件。 必需,无默认值。 </li> </ul> </td> </tr> <tr><td><code>connectionInfo</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-WebhookConnectionInfo"><code>WebhookConnectionInfo</code></a> </td> <td> <p>
<code>connectionInfo</code> 定义了我们如何与 Webhook 进行通信。 </p> </td> </tr> <tr><td><code>matchConditions</code> <B>[必需]</B><br/> <a href="#apiserver-config-k8s-io-v1-WebhookMatchCondition"><code>[]WebhookMatchCondition</code></a> </td> <td> <p>
<code>matchConditions</code> 是请求发送到此 Webhook 之前必须满足的一系列条件。 空的 <code>matchConditions</code> 列表匹配所有请求。 最多允许 64 个匹配条件。 </p> <p>
精确的匹配逻辑(按顺序)是: </p> <ol>
<li>如果至少一个 <code>matchConditions</code> 元素的计算结果为 FALSE,则跳过此 Webhook。</li> <li>如果所有 <code>matchConditions</code> 元素的计算结果都为 TRUE,则调用此 Webhook。</li> <li>如果至少一个 <code>matchConditions</code> 元素的计算结果为出错(但没有 FALSE): <ul> <li>如果 <code>failurePolicy</code> 为 Deny,则 Webhook 拒绝请求。</li> <li>如果 <code>failurePolicy</code> 为 NoOpinion,则忽略错误并跳过此 Webhook。</li> </ul> </li> </ol> </td> </tr> </tbody> </table>
WebhookConnectionInfo {#apiserver-config-k8s-io-v1-WebhookConnectionInfo}
Appears in:
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>type</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
控制 Webhook 应如何与服务器通信。 有效值: </p> <ul>
<ul> <li>KubeConfigFile:使用 kubeConfigFile 中指定的文件来定位服务器。</li> <li>InClusterConfig:使用集群内配置调用由 kube-apiserver 上的 SubjectAccessReview API。 此模式不允许用于 kube-apiserver。</li> </ul> </ul> </td> </tr> <tr><td><code>kubeConfigFile</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>kubeConfigFile</code> 文件的路径,用于获取连接信息。 如果 <code>connectionInfo.type</code> 是 KubeConfig,则必需。 </p> </td> </tr> </tbody> </table>
WebhookMatchCondition {#apiserver-config-k8s-io-v1-WebhookMatchCondition}
出现在:
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>expression</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>expression</code> 表示将由 CEL 求值的表达式。求值结果必须是布尔值。 CEL 表达式可以访问 v1 版本中的 SubjectAccessReview 的内容。 如果请求变量中指定的 <code>subjectAccessReviewVersion</code> 是 v1beta1, 则在对 CEL 表达式求值之前,其内容会被转换为 v1 版本。 </p> <ul>
<li>'resourceAttributes' 描述了资源访问请求的信息,在非资源请求中未设置。 例如:<code>has(request.resourceAttributes) && request.resourceAttributes.namespace == 'default'</code>。 </li> <li>'nonResourceAttributes' 描述了非资源访问请求的信息,在资源请求中未设置。例如: <code>has(request.nonResourceAttributes) && request.nonResourceAttributes.path == '/healthz'</code>。 </li> <li>'user' 是要测试的用户。例如:<code>request.user == 'alice'</code>。</li> <li>'groups' 是要测试的组。例如:<code>('group1' in request.groups)</code>。</li> <li>'extra' 对应于身份验证器中的 <code>user.Info.GetExtra()</code> 方法。</li> <li>'uid' 是关于请求用户的详细信息。例如:<code>request.uid == '1'</code>。</li> </ul> <p>
关于 CEL 的文档:https://kubernetes.io/zh-cn/docs/reference/using-api/cel/ </p> </td> </tr> </tbody> </table>
来源:Kubernetes 文档贡献者 · 作者与贡献记录 · CC BY 4.0。离线整理了版式、链接和媒体显示。
