website/content/zh/docs/pluggable-components/auditing-logs.md

title	keywords	description	linkTitle	weight
KubeSphere 审计日志	Kubernetes, auditing, KubeSphere, logs	如何启用 KubeSphere 审计日志	KubeSphere 审计日志	3525

什么是 KubeSphere 审计日志

KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排列的记录，记录了与单个用户、管理人员或系统其他组件相关的活动顺序。对 KubeSphere 的每个请求都会产生一个事件，然后写入 Webhook，并根据一定的规则进行处理。

有关更多信息，请参阅日志、事件和审计。

在安装前启用审计日志

在 Linux 上安装

当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。

1. 基于在 Linux 上安装 KubeSphere 的教程，您创建了一个默认文件 config-sample.yaml。通过执行以下命令修改该文件：

vi config-sample.yaml

{{< notice note >}}

如果采用 All-in-one 安装，则不需要创建 config-sample.yaml 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用审计日志（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用审计模式。

{{</ notice >}}

2. 在该文件中，搜寻到 auditing，并将 enabled 的 false 改为 true。完成后保存文件。

auditing:
    enabled: true # Change "false" to "true"

{{< notice note >}}

默认情况下，如果启用了审计功能，KubeKey 将在内部安装 Elasticsearch。对于生产环境，如果你想启用审计，强烈建议你在 config-sample.yaml 中设置以下值，尤其是 externalElasticsearchUrl 和 externalElasticsearchPort。一旦你在安装前提供以下信息，KubeKey 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。

{{</ notice >}}

es:  # Storage backend for logging, tracing, events and auditing.
  elasticsearchMasterReplicas: 1   # total number of master nodes, it's not allowed to use even number
  elasticsearchDataReplicas: 1     # total number of data nodes
  elasticsearchMasterVolumeSize: 4Gi   # Volume size of Elasticsearch master nodes
  elasticsearchDataVolumeSize: 20Gi    # Volume size of Elasticsearch data nodes
  logMaxAge: 7                     # Log retention time in built-in Elasticsearch, it is 7 days by default.
  elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
  externalElasticsearchUrl: # The URL of external Elasticsearch
  externalElasticsearchPort: # The port of external Elasticsearch

3. 使用配置文件创建一个集群：

./kk create cluster -f config-sample.yaml

在 Kubernetes 上安装

在 Kubernetes 上安装 KubeSphere 时，需要下载文件 cluster-configuration.yaml 进行集群设置。如果要安装审计日志，不要直接使用 kubectl apply -f 对这个文件进行设置。

1. 参照在 Kubernetes 上安装 KubeSphere 的教程，先对文件 kubesphere-installer.yaml 执行 kubectl apply -f。之后，为了启用审计日志，创建一个本地文件 cluster-configuration.yaml。

vi cluster-configuration.yaml

2. 将 cluster-configuration.yaml 文件中的所有内容复制到刚才创建的本地文件中。

3. 在这个本地 cluster-configuration.yaml 文件中，搜寻到 auditing，并将 enabled 的 false 改为 true，启用它们。完成后保存文件。

auditing:
    enabled: true # Change "false" to "true"

{{< notice note >}}

默认情况下，如果启用了审计功能，ks-installer 会在内部安装 Elasticsearch。对于生产环境，如果你想启用审计，强烈建议你在 cluster-configuration.yaml 中设置以下值，尤其是 externalElasticsearchUrl 和 externalElasticsearchPort。当你在安装前提供以下信息时，ks-installer 将直接整合你的外部 Elasticsearch，而不是安装内部 Elasticsearch。

{{</ notice >}}

es:  # Storage backend for logging, tracing, events and auditing.
  elasticsearchMasterReplicas: 1   # total number of master nodes, it's not allowed to use even number
  elasticsearchDataReplicas: 1     # total number of data nodes
  elasticsearchMasterVolumeSize: 4Gi   # Volume size of Elasticsearch master nodes
  elasticsearchDataVolumeSize: 20Gi    # Volume size of Elasticsearch data nodes
  logMaxAge: 7                     # Log retention time in built-in Elasticsearch, it is 7 days by default.
  elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
  externalElasticsearchUrl: # The URL of external Elasticsearch
  externalElasticsearchPort: # The port of external Elasticsearch

4. 执行以下命令开始安装：

kubectl apply -f cluster-configuration.yaml

在安装后启用审计日志

1. 以 admin 身份登录控制台。点击左上角的平台管理，选择集群管理。

2. 点击 自定义资源 CRD，在搜索栏中输入 clusterconfiguration。点击结果查看其详细页面。

{{< notice info >}}

自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。

{{</ notice >}}

3. 在资源列表中，点击 ks-installer 右边的三个点，选择编辑 YAML。

4. 在这个 YAML 文件中，搜寻到 auditing，将 enabled 的 false 改为 true。完成后，点击右下角的更新，保存配置。

auditing:
    enabled: true # Change "false" to "true"

{{< notice note >}}

默认情况下，如果启用了审计功能，Elasticsearch 将在内部安装。对于生产环境，如果你想启用审计，强烈建议你在这个 YAML 文件中设置以下值，尤其是 externalElasticsearchUrl 和 externalElasticsearchPort。一旦你提供了以下信息，KubeSphere 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。

{{</ notice >}}

es:  # Storage backend for logging, tracing, events and auditing.
  elasticsearchMasterReplicas: 1   # total number of master nodes, it's not allowed to use even number
  elasticsearchDataReplicas: 1     # total number of data nodes
  elasticsearchMasterVolumeSize: 4Gi   # Volume size of Elasticsearch master nodes
  elasticsearchDataVolumeSize: 20Gi    # Volume size of Elasticsearch data nodes
  logMaxAge: 7                     # Log retention time in built-in Elasticsearch, it is 7 days by default.
  elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
  externalElasticsearchUrl: # The URL of external Elasticsearch
  externalElasticsearchPort: # The port of external Elasticsearch

5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程：

kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f

{{< notice tip >}}

您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。

{{</ notice >}}

验证组件的安装

{{< tabs >}}

{{< tab "在仪表板中验证组件的安装" >}}

如果您同时启用了日志记录和审计日志，您可以在服务组件的 Logging 中查看审计状态。您可能会看到如下图片：

如果只启用审计而不安装日志，则无法看到上面的图片，因为 Loggiing 按钮不会显示。

{{</ tab >}}

{{< tab "通过 kubectl 验证组件的安装" >}}

执行以下命令来检查 Pod 的状态：

kubectl get pod -n kubesphere-logging-system

如果组件运行成功，输出结果可能如下：

NAME                                                              READY   STATUS      RESTARTS   AGE
elasticsearch-logging-curator-elasticsearch-curator-159872n9g9g   0/1     Completed   0          2d10h
elasticsearch-logging-curator-elasticsearch-curator-159880tzb7x   0/1     Completed   0          34h
elasticsearch-logging-curator-elasticsearch-curator-1598898q8w7   0/1     Completed   0          10h
elasticsearch-logging-data-0                                      1/1     Running     1          2d20h
elasticsearch-logging-data-1                                      1/1     Running     1          2d20h
elasticsearch-logging-discovery-0                                 1/1     Running     1          2d20h
fluent-bit-6v5fs                                                  1/1     Running     1          2d20h
fluentbit-operator-5bf7687b88-44mhq                               1/1     Running     1          2d20h
kube-auditing-operator-7574bd6f96-p4jvv                           1/1     Running     1          2d20h
kube-auditing-webhook-deploy-6dfb46bb6c-hkhmx                     1/1     Running     1          2d20h
kube-auditing-webhook-deploy-6dfb46bb6c-jp77q                     1/1     Running     1          2d20h

{{</ tab >}}

{{</ tabs >}}