资源类型 {#resource-types}
Event {#audit-k8s-io-v1-Event}
出现在:
<p>
<code>Event</code> 结构包含可出现在 API 审计日志中的所有信息。 </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>audit.k8s.io/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>Event</code></td></tr>
<tr><td><code>level</code> <B>[必需]</B><br/> <a href="#audit-k8s-io-v1-Level"><code>Level</code></a> </td> <td> <p>
生成事件所对应的审计级别。 </p> </td> </tr>
<tr><td><code>auditID</code> <B>[必需]</B><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a> </td> <td> <p>
为每个请求所生成的唯一审计 ID。 </p> </td> </tr>
<tr><td><code>stage</code> <B>[必需]</B><br/> <a href="#audit-k8s-io-v1-Stage"><code>Stage</code></a> </td> <td> <p>
生成此事件实例时请求的处理阶段。 </p> </td> </tr>
<tr><td><code>requestURI</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>requestURI</code> 是客户端发送到服务器的请求 URI。 </p> </td> </tr>
<tr><td><code>verb</code> <B>[必需]</B><br/> <code>string</code> </td> <td> <p>
<code>verb</code> 是与请求对应的 Kubernetes 动词。对于非资源请求, 此字段为小写形式的 HTTP 方法。 </p> </td> </tr>
<tr><td><code>user</code> <B>[必需]</B><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.37/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a> </td> <td> <p>
关于认证用户的信息。 </p> </td> </tr>
<tr><td><code>impersonatedUser</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.37/#userinfo-v1-authentication-k8s-io"><code>authentication/v1.UserInfo</code></a> </td> <td> <p>
关于所伪装(<code>impersonatedUser</code>)的用户的信息。 </p> </td> </tr>
<tr><td><code>authenticationMetadata</code><br/> <a href="#audit-k8s-io-v1-AuthenticationMetadata"><code>AuthenticationMetadata</code></a> </td> <td> <p>
<code>authenticationMetadata</code> 包含有关请求如何进行身份认证的详细信息。 </p> </td> </tr>
<tr><td><code>sourceIPs</code><br/> <code>[]string</code> </td> <td> <p>
发起请求和中间代理的源 IP 地址。源 IP 从以下(按顺序)列出: </p> <ol> <li>
X-Forwarded-For 请求标头 IP。 </li> <li>
X-Real-Ip 标头,如果 X-Forwarded-For 列表中不存在。 </li> <li>
连接的远程地址,如果它无法与此处列表中的最后一个 IP(X-Forwarded-For 或 X-Real-Ip)匹配。 注意:除最后一个 IP 外的所有 IP 均可由客户端任意设置。 </li> </ol> </td> </tr>
<tr><td><code>userAgent</code><br/> <code>string</code> </td> <td> <p>
<code>userAgent</code> 中记录客户端所报告的用户代理(User Agent)字符串。 注意 <code>userAgent</code> 信息是由客户端提供的,一定不要信任。 </p> </td> </tr>
<tr><td><code>objectRef</code><br/> <a href="#audit-k8s-io-v1-ObjectReference"><code>ObjectReference</code></a> </td> <td> <p>
此请求所指向的对象引用。对于 List 类型的请求或者非资源请求,此字段可忽略。 </p> </td> </tr>
<tr><td><code>responseStatus</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.37/#status-v1-meta"><code>meta/v1.Status</code></a> </td> <td> <p>
响应的状态,当 <code>responseStatus</code> 不是 Status 类型时被赋值。 对于成功的请求,此字段仅包含 <code>code</code> 和 <code>statusSuccess</code>。 对于非 Status 类型的错误响应,此字段会被自动赋值为出错信息。 </p> </td> </tr>
<tr><td><code>requestObject</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>
来自请求的 API 对象,以 JSON 格式呈现。<code>requestObject</code> 在请求中按原样记录 (可能会采用 JSON 重新编码),之后会进入版本转换、默认值填充、准入控制以及配置信息合并等阶段。 此对象为外部版本化的对象类型,甚至其自身可能并不是一个合法的对象。对于非资源请求,此字段被忽略。 只有当审计级别为 Request 或更高的时候才会记录。 </p> </td> </tr>
<tr><td><code>responseObject</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>
响应中包含的 API 对象,以 JSON 格式呈现。<code>responseObject</code> 是在被转换为外部类型并序列化为 JSON 格式之后才被记录的。对于非资源请求,此字段会被忽略。 只有审计级别为 Response 时才会记录。 </p> </td> </tr>
<tr><td><code>requestReceivedTimestamp</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.37/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a> </td> <td> <p>
请求到达 API 服务器时的时间。 </p> </td> </tr>
<tr><td><code>stageTimestamp</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.37/#microtime-v1-meta"><code>meta/v1.MicroTime</code></a> </td> <td> <p>
请求到达当前审计阶段时的时间。 </p> </td> </tr>
<tr><td><code>annotations</code><br/> <code>map[string]string</code> </td> <td> <p>
<code>annotations</code> 是一个无结构的键值映射,其中保存的是一个审计事件。 该事件可以由请求处理链路上的插件来设置,包括身份认证插件、鉴权插件以及准入控制插件等。 注意这些注解是针对审计事件本身的,与所提交的对象中的 <code>metadata.annotations</code> 之间不存在对应关系。映射中的键名应该唯一地标识生成该事件的组件,从而避免名字上的冲突 (例如 <code>podsecuritypolicy.admission.k8s.io/policy</code>)。 映射中的键值应该比较简短。当审计级别为 Metadata 时会包含 <code>annotations</code> 字段。 </p> </td> </tr> </tbody> </table>
EventList {#audit-k8s-io-v1-EventList}
<p>
<code>EventList</code> 是审计事件(Event)的列表。 </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>audit.k8s.io/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>EventList</code></td></tr>
<tr><td><code>metadata</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.37/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a> </td> <td> <span class="text-muted">列表结构元数据</span> </td> </tr>
<tr><td><code>items</code> <B>[必需]</B><br/> <a href="#audit-k8s-io-v1-Event"><code>[]Event</code></a> </td> <td> <span class="text-muted">事件对象列表</span> </td> </tr> </tbody> </table>
Policy {#audit-k8s-io-v1-Policy}
出现在:
<p>
<code>Policy</code> 定义的是审计日志的配置以及不同类型请求的日志记录规则。 </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>audit.k8s.io/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>Policy</code></td></tr>
<tr><td><code>metadata</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.37/#objectmeta-v1-meta"><code>meta/v1.ObjectMeta</code></a> </td> <td> <p>
包含 <code>metadata</code> 字段是为了便于与 API 基础设施之间实现互操作。 </p> <p>
参考 Kubernetes API 文档了解 <code>metadata</code> 字段的详细信息。 </p> </td> </tr>
<tr><td><code>rules</code> <B>[必需]</B><br/> <a href="#audit-k8s-io-v1-PolicyRule"><code>[]PolicyRule</code></a> </td> <td> <p>
字段 <code>rules</code> 设置请求要被记录的审计级别(level)。 每个请求可能会与多条规则相匹配;发生这种状况时遵从第一条匹配规则。 默认的审计级别是 None,不过可以在列表的末尾使用一条全抓(catch-all)规则重载其设置。 列表中的规则(PolicyRule)是严格有序的。 </p> </td> </tr>
<tr><td><code>omitStages</code><br/> <a href="#audit-k8s-io-v1-Stage"><code>[]Stage</code></a> </td> <td> <p>
字段 <code>omitStages</code> 是一个阶段(Stage)列表,其中包含无须生成事件的阶段。 注意这一选项也可以通过每条规则来设置。 审计组件最终会忽略出现在 <code>omitStages</code> 中阶段,也会忽略规则中的阶段。 </p> </td> </tr>
<tr> <td> <code>omitManagedFields</code><br/> <code>bool</code> </td> <td> <p>
<code>omitManagedFields</code> 标明将请求和响应主体写入 API 审计日志时,是否省略其托管字段。 此字段值用作全局默认值 - 'true' 值将省略托管字段,否则托管字段将包含在 API 审计日志中。 请注意,也可以按规则指定此值,在这种情况下,规则中指定的值将覆盖全局默认值。 </p> </td> </tr> </tbody> </table>
PolicyList {#audit-k8s-io-v1-PolicyList}
<p>
<code>PolicyList</code> 是由审计策略(Policy)组成的列表。 </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>audit.k8s.io/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>PolicyList</code></td></tr>
<tr><td><code>metadata</code><br/> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#listmeta-v1-meta"><code>meta/v1.ListMeta</code></a> </td> <td> <span class="text-muted">列表结构元数据。</span> </td> </tr>
<tr><td><code>items</code> <B>[必需]</B><br/> <a href="#audit-k8s-io-v1-Policy"><code>[]Policy</code></a> </td> <td> <span class="text-muted">策略(Policy)对象列表。</span> </td> </tr> </tbody> </table>
AuthenticationMetadata {#audit-k8s-io-v1-AuthenticationMetadata}
出现在:
<table class="table"> <thead><tr><th width="30%">Field</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>impersonationConstraint</code><br/> <code>string</code> </td> <td> <p>
<code>impersonationConstraint</code> 是与用于鉴权与此审计事件关联的 <code>impersonatedUser</code> 的受限伪装模式相关的动词。它仅在使用了受限伪装时设置。 </p> </td> </tr> </tbody> </table>
GroupResources {#audit-k8s-io-v1-GroupResources}
出现在:
<p>
<code>GroupResources</code> 代表的是某 API 组中的资源类别。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>group</code><br/> <code>string</code> </td> <td> <p>
字段 <code>group</code> 给出包含资源的 API 组的名称。 空字符串代表 <code>core</code> API 组。 <code>*</code> 匹配所有组。 </p> </td> </tr>
<tr><td><code>resources</code><br/> <code>[]string</code> </td> <td>
<p><code>resources</code> 是此规则所适用的资源的列表。</p> <p>例如:</p> <ul> <li><code>pods</code> 匹配 Pod。</li> <li><code>pods/log</code> 匹配 Pod 的 log 子资源。</li> <li><code>*<code> 匹配所有资源及其子资源。</li> <li><code>pods/*</code> 匹配 Pod 的所有子资源。</li> <li><code>*/scale</code> 匹配所有的 scale 子资源。</li> </ul>
<p>
如果存在通配符,则合法性检查逻辑会确保 <code>resources</code> 中的条目不会彼此重叠。 </p> <p>
空的列表意味着规则适用于该 API 组中的所有资源及其子资源。 </p> </td> </tr>
<tr><td><code>resourceNames</code><br/> <code>[]string</code> </td> <td> <p>
字段 <code>resourceNames</code> 是策略将匹配的资源实例名称列表。 使用此字段时,必须指定 <code>resources</code>。 空的 <code>resourceNames</code> 列表意味着资源的所有实例都会匹配到此策略。 </p> </td> </tr> </tbody> </table>
Level {#audit-k8s-io-v1-Level}
string 数据类型的别名。
出现在:
<p>
<code>Level</code> 定义的是审计过程中在日志内记录的信息量。 </p>
ObjectReference {#audit-k8s-io-v1-ObjectReference}
出现在:
<p>
<code>ObjectReference</code> 包含的是用来检查或修改所引用对象时将需要的全部信息。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>resource</code><br/> <code>string</code> </td> <td> <span class="text-muted">资源类别。</span> </td> </tr>
<tr><td><code>namespace</code><br/> <code>string</code> </td> <td> <span class="text-muted">资源对象所在名字空间。</span> </td> </tr>
<tr><td><code>name</code><br/> <code>string</code> </td> <td> <span class="text-muted">资源对象名称。</span> </td> </tr>
<tr><td><code>uid</code><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID"><code>k8s.io/apimachinery/pkg/types.UID</code></a> </td> <td> <span class="text-muted">资源对象的唯一标识(UID)。</span> </td> </tr>
<tr><td><code>apiGroup</code><br/> <code>string</code> </td> <td> <p>
字段 <code>apiGroup</code> 给出包含所引用对象的 API 组的名称。 空字符串代表 <code>core</code> API 组。 </p> </td> </tr>
<tr><td><code>apiVersion</code><br/> <code>string</code> </td> <td> <p>
字段 <code>apiVersion</code> 是包含所引用对象的 API 组的版本。 </p> </td> </tr>
<tr><td><code>resourceVersion</code><br/> <code>string</code> </td> <td> <span class="text-muted">资源对象自身的版本值。</span> </td> </tr>
<tr><td><code>subresource</code><br/> <code>string</code> </td> <td> <span class="text-muted">子资源的类别。</span> </td> </tr> </tbody> </table>
PolicyRule {#audit-k8s-io-v1-PolicyRule}
出现在:
<p>
<code>PolicyRule</code> 包含一个映射,基于元数据将请求映射到某审计级别。 请求必须与每个字段所定义的规则都匹配(即 <code>rules</code> 的交集)才被视为匹配。 </p>
<table class="table"> <thead><tr><th width="30%">字段</th><th>描述</th></tr></thead> <tbody>
<tr><td><code>level</code> <B>[必需]</B><br/> <a href="#audit-k8s-io-v1-Level"><code>Level</code></a> </td> <td> <p>
与此规则匹配的请求所对应的日志记录级别(Level)。 </p> </td> </tr>
<tr><td><code>users</code><br/> <code>[]string</code> </td> <td> <p>
根据身份认证所确定的用户名的列表,给出此规则所适用的用户。 空列表意味着适用于所有用户。 </p> </td> </tr>
<tr><td><code>userGroups</code><br/> <code>[]string</code> </td> <td> <p>
此规则所适用的用户组的列表。如果用户是所列用户组中任一用户组的成员,则视为匹配。 空列表意味着适用于所有用户组。 </p> </td> </tr>
<tr><td><code>verbs</code><br/> <code>[]string</code> </td> <td> <p>
此规则所适用的动词(<code>verb</code>)列表。 空列表意味着适用于所有动词。 </p> </td> </tr>
<tr><td><code>resources</code><br/> <a href="#audit-k8s-io-v1-GroupResources"><code>[]GroupResources</code></a> </td> <td> <p>
此规则所适用的资源类别列表。 空列表意味着适用于 API 组中的所有资源类别。 </p> </td> </tr>
<tr><td><code>namespaces</code><br/> <code>[]string</code> </td> <td> <p>
此规则所适用的名字空间列表。 空字符串("")意味着适用于非名字空间作用域的资源。 空列表意味着适用于所有名字空间。 </p> </td> </tr>
<tr><td><code>nonResourceURLs</code><br/> <code>[]string</code> </td> <td> <p>
<code>nonResourceURLs</code> 是一组需要被审计的 URL 路径。 允许使用 <code>*<code>,但只能作为路径中最后一个完整分段。 例如: </p>
<ul> <li>"/metrics" - 记录对 API 服务器度量值(metrics)的所有请求;</li> <li>"/healthz*" - 记录所有健康检查。</li> </ul> </td> </tr>
<tr><td><code>omitStages</code><br/> <a href="#audit-k8s-io-v1-Stage"><code>[]Stage</code></a> </td> <td> <p>
字段 <code>omitStages</code> 是一个阶段(Stage)列表,针对所列的阶段服务器不会生成审计事件。 注意这一选项也可以在策略(Policy)级别指定。服务器审计组件会忽略 <code>omitStages</code> 中给出的阶段,也会忽略策略中给出的阶段。 空列表意味着不对阶段作任何限制。 </p> </td> </tr>
<tr> <td><code>omitManagedFields</code><br/> <code>bool</code> </td> <td> <p>
<code>omitManagedFields</code> 决定将请求和响应主体写入 API 审计日志时,是否省略其托管字段。 </p>
<ul> <li>值为 'true' 将从 API 审计日志中删除托管字段</li> <li> 值为 'false' 表示托管字段应包含在 API 审计日志中 请注意,如果指定此规则中的值将覆盖全局默认值。 如果未指定,则使用 <code>policy.omitManagedFields</code> 中指定的全局默认值。 </li> </ul> </td> </tr>
</tbody> </table>
Stage {#audit-k8s-io-v1-Stage}
string 数据类型的别名。
出现在:
<p>
<code>Stage</code> 定义在请求处理过程中可以生成审计事件的阶段。 </p>
来源:Kubernetes 文档贡献者 · 作者与贡献记录 · CC BY 4.0。离线整理了版式、链接和媒体显示。
