审计

Kubernetes 的审计功能提供了一组与安全相关的、按时间顺序排列的记录，用于记录集群中的操作序列。集群会审计由用户、使用 Kubernetes API 的应用程序以及控制平面本身产生的活动。

审计允许集群管理员回答以下问题：

发生了什么？
何时发生的？
谁发起的？
发生在什么之上？
在哪里被观察到的？
从哪里发起的？
将要到哪里？

审计记录在其生命周期内从 kube-apiserver 组件内部开始。执行的每个阶段的每个请求都会生成一个审计事件，然后根据特定策略对其进行预处理并写入后端。该策略确定记录的内容，后端持久化这些记录。当前的后端实现包括日志文件和 Webhook。

每个请求都可以使用关联的阶段进行记录。定义的阶段为：

RequestReceived - 审计处理程序接收到请求后，以及在将其委派到处理程序链之前生成的事件的阶段。
ResponseStarted - 一旦发送了响应头，但在发送响应正文之前。此阶段仅为长时间运行的请求（例如 watch）生成。
ResponseComplete - 响应正文已完成，并且不再发送任何字节。
Panic - 发生崩溃时生成的事件。

注意

审计事件配置与 Event API 对象不同。

审计日志功能会增加 API 服务器的内存消耗，因为每个请求都会存储一些审计所需的上下文。内存消耗取决于审计日志配置。

审计策略

审计策略定义有关应记录哪些事件以及它们应包含哪些数据的规则。审计策略对象结构在 audit.k8s.io API 组中定义。当事件被处理时，会按照顺序将其与规则列表进行比较。第一个匹配的规则会设置事件的审计级别。定义的审计级别为：

None - 不记录与此规则匹配的事件。
Metadata - 记录具有元数据（请求用户、时间戳、资源、动词等）的事件，但不记录请求或响应正文。
Request - 记录具有请求元数据和正文但没有响应正文的事件。这不适用于非资源请求。
RequestResponse - 记录具有请求元数据、请求正文和响应正文的事件。这不适用于非资源请求。

你可以使用 --audit-policy-file 标志将带有策略的文件传递给 kube-apiserver。如果省略此标志，则不记录任何事件。请注意，rules 字段必须在审计策略文件中提供。没有 (0) 条规则的策略被视为非法。

以下是审计策略文件示例：

audit/audit-policy.yaml

apiVersion: audit.k8s.io/v1 # This is required.
kind: Policy
# Don't generate audit events for all requests in RequestReceived stage.
omitStages:
  - "RequestReceived"
rules:
  # Log pod changes at RequestResponse level
  - level: RequestResponse
    resources:
    - group: ""
      # Resource "pods" doesn't match requests to any subresource of pods,
      # which is consistent with the RBAC policy.
      resources: ["pods"]
  # Log "pods/log", "pods/status" at Metadata level
  - level: Metadata
    resources:
    - group: ""
      resources: ["pods/log", "pods/status"]

  # Don't log requests to a configmap called "controller-leader"
  - level: None
    resources:
    - group: ""
      resources: ["configmaps"]
      resourceNames: ["controller-leader"]

  # Don't log watch requests by the "system:kube-proxy" on endpoints or services
  - level: None
    users: ["system:kube-proxy"]
    verbs: ["watch"]
    resources:
    - group: "" # core API group
      resources: ["endpoints", "services"]

  # Don't log authenticated requests to certain non-resource URL paths.
  - level: None
    userGroups: ["system:authenticated"]
    nonResourceURLs:
    - "/api*" # Wildcard matching.
    - "/version"

  # Log the request body of configmap changes in kube-system.
  - level: Request
    resources:
    - group: "" # core API group
      resources: ["configmaps"]
    # This rule only applies to resources in the "kube-system" namespace.
    # The empty string "" can be used to select non-namespaced resources.
    namespaces: ["kube-system"]

  # Log configmap and secret changes in all other namespaces at the Metadata level.
  - level: Metadata
    resources:
    - group: "" # core API group
      resources: ["secrets", "configmaps"]

  # Log all other resources in core and extensions at the Request level.
  - level: Request
    resources:
    - group: "" # core API group
    - group: "extensions" # Version of group should NOT be included.

  # A catch-all rule to log all other requests at the Metadata level.
  - level: Metadata
    # Long-running requests like watches that fall under this rule will not
    # generate an audit event in RequestReceived.
    omitStages:
      - "RequestReceived"

你可以使用最小的审计策略文件来记录所有 Metadata 级别的请求。

# Log all requests at the Metadata level.
apiVersion: audit.k8s.io/v1
kind: Policy
rules:
- level: Metadata

如果你要制作自己的审计配置文件，则可以使用 Google Container-Optimized OS 的审计配置文件作为起点。你可以查看生成审计策略文件的 configure-helper.sh 脚本。你可以直接查看脚本来查看大多数审计策略文件。

你还可以参考 Policy 配置参考，了解有关定义的字段的详细信息。

审计后端

审计后端将审计事件持久保存到外部存储。开箱即用，kube-apiserver 提供了两个后端：

日志后端，将事件写入文件系统
Webhook 后端，将事件发送到外部 HTTP API

在所有情况下，审计事件都遵循 Kubernetes API 在 audit.k8s.io API 组中定义的结构。

注意

对于补丁，请求正文是一个包含补丁操作的 JSON 数组，而不是一个包含适当 Kubernetes API 对象的 JSON 对象。例如，以下请求正文是对 /apis/batch/v1/namespaces/some-namespace/jobs/some-job-name 的有效补丁请求：

[
  {
    "op": "replace",
    "path": "/spec/parallelism",
    "value": 0
  },
  {
    "op": "remove",
    "path": "/spec/template/spec/containers/0/terminationMessagePolicy"
  }
]

日志后端

日志后端将审计事件以 JSONlines 格式写入文件。你可以使用以下 kube-apiserver 标志配置日志审计后端：

--audit-log-path 指定日志后端用来写入审计事件的日志文件路径。不指定此标志会禁用日志后端。- 表示标准输出。
--audit-log-maxage 定义保留旧审计日志文件的最大天数。
--audit-log-maxbackup 定义要保留的最大审计日志文件数。
--audit-log-maxsize 定义审计日志文件在轮换之前可以达到的最大大小（以兆字节为单位）。

如果集群的控制平面将 kube-apiserver 作为 Pod 运行，请记住将 hostPath 挂载到策略文件和日志文件的位置，以便持久保存审计记录。例如：

  - --audit-policy-file=/etc/kubernetes/audit-policy.yaml
  - --audit-log-path=/var/log/kubernetes/audit/audit.log

然后挂载卷：

...
volumeMounts:
  - mountPath: /etc/kubernetes/audit-policy.yaml
    name: audit
    readOnly: true
  - mountPath: /var/log/kubernetes/audit/
    name: audit-log
    readOnly: false

最后配置 hostPath：

...
volumes:
- name: audit
  hostPath:
    path: /etc/kubernetes/audit-policy.yaml
    type: File

- name: audit-log
  hostPath:
    path: /var/log/kubernetes/audit/
    type: DirectoryOrCreate

Webhook 后端

Webhook 审计后端将审计事件发送到远程 Web API，该 API 被假定为 Kubernetes API 的一种形式，包括身份验证方式。你可以使用以下 kube-apiserver 标志配置 Webhook 审计后端：

--audit-webhook-config-file 指定包含 Webhook 配置的文件路径。Webhook 配置实际上是专门的 kubeconfig。
--audit-webhook-initial-backoff 指定在第一次请求失败后重试之前等待的时间量。后续请求会使用指数退避进行重试。

Webhook 配置文件使用 kubeconfig 格式来指定服务的远程地址以及用于连接到服务的凭据。

事件批处理

日志和 Webhook 后端都支持批处理。以 Webhook 为例，以下是可用的标志列表。要获取日志后端相同的标志，请在标志名称中将 webhook 替换为 log。默认情况下，webhook 中启用批处理，而 log 中禁用。类似地，默认情况下，webhook 中启用节流，而 log 中禁用。

--audit-webhook-mode 定义了缓冲策略。以下选项之一：
- batch - 缓冲事件并以批处理方式异步处理它们。这是默认设置。
- blocking - 在处理每个单独的事件时阻塞 API 服务器响应。
- blocking-strict - 与 blocking 相同，但当在 RequestReceived 阶段进行审计日志记录时出现故障时，整个对 kube-apiserver 的请求将失败。

以下标志仅在 batch 模式下使用：

--audit-webhook-batch-buffer-size 定义在批处理之前要缓冲的事件数量。如果传入事件的速率溢出缓冲区，则事件将被丢弃。
--audit-webhook-batch-max-size 定义一个批次中最大的事件数量。
--audit-webhook-batch-max-wait 定义在无条件地将队列中的事件批处理之前等待的最长时间。
--audit-webhook-batch-throttle-qps 定义每秒生成的最大平均批次数量。
--audit-webhook-batch-throttle-burst 定义如果先前允许的 QPS 未被充分利用，则在同一时刻生成的最大批次数量。

参数调整

应设置参数以适应 API 服务器上的负载。

例如，如果 kube-apiserver 每秒接收 100 个请求，并且每个请求仅在 ResponseStarted 和 ResponseComplete 阶段进行审计，则应考虑每秒生成约 200 个审计事件。假设一个批次中最多有 100 个事件，则应将节流级别设置为至少每秒 2 个查询。假设后端写入事件最多需要 5 秒，则应将缓冲区大小设置为最多容纳 5 秒的事件；即：10 个批次，或 1000 个事件。

但是在大多数情况下，默认参数应该足够，您不必担心手动设置它们。您可以查看 kube-apiserver 公开的以下 Prometheus 指标以及日志，以监视审计子系统的状态。

apiserver_audit_event_total 指标包含导出的审计事件总数。
apiserver_audit_error_total 指标包含由于导出期间发生错误而丢弃的事件总数。

日志条目截断

日志和 Webhook 后端都支持限制记录的事件的大小。例如，以下是日志后端可用的标志列表：

audit-log-truncate-enabled 是否启用事件和批处理截断。
audit-log-truncate-max-batch-size 发送到基础后端的批次的最大大小（以字节为单位）。
audit-log-truncate-max-event-size 发送到基础后端的审计事件的最大大小（以字节为单位）。

默认情况下，webhook 和 log 都禁用截断，集群管理员应设置 audit-log-truncate-enabled 或 audit-webhook-truncate-enabled 来启用该功能。

下一步

了解关于变更 Webhook 审计注解。
通过阅读审计配置参考，了解更多关于Event和Policy资源类型的信息。

上次修改时间为 2024 年 10 月 22 日凌晨 3:28 PST：Update audit.md (#46655) (ae153723dd)

审计

注意