diff --git a/content/zh/docs/pluggable-components/auditing-logs.md b/content/zh/docs/pluggable-components/auditing-logs.md index b8fad7e6f..311b9ff17 100644 --- a/content/zh/docs/pluggable-components/auditing-logs.md +++ b/content/zh/docs/pluggable-components/auditing-logs.md @@ -1,43 +1,42 @@ --- title: "KubeSphere 审计日志" -keywords: "Kubernetes, auditing, KubeSphere, logs" +keywords: "Kubernetes, 审计, KubeSphere, 日志" description: "如何启用 KubeSphere 审计日志" - linkTitle: "KubeSphere 审计日志" weight: 6700 --- ## 什么是 KubeSphere 审计日志 -KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排列的记录，记录了与单个用户、管理人员或系统其他组件相关的活动顺序。对 KubeSphere 的每个请求都会产生一个事件，然后写入 Webhook，并根据一定的规则进行处理。 +KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排列的记录，按顺序记录了与单个用户、管理人员或系统其他组件相关的活动。对 KubeSphere 的每个请求都会生成一个事件，然后写入 Webhook，并根据一定的规则进行处理。 -有关更多信息，请参阅[审计日志](../../toolbox/auditing/auditing-query)。 +有关更多信息，请参见[审计日志查询](../../toolbox/auditing/auditing-query/)。 ## 在安装前启用审计日志 ### 在 Linux 上安装 -当您在 Linux 上安装多节点 KubeSphere 时，首先需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 +当您在 Linux 上多节点安装 KubeSphere 时，需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -1. 基于在 [Linux 上安装 KubeSphere](../../installing-on-linux/introduction/multioverview/) 的教程，创建了一个默认文件 **config-sample.yaml**，通过执行以下命令修改该文件： +1. 基于[在 Linux 上安装 KubeSphere](../../installing-on-linux/introduction/multioverview/) 的教程，创建一个默认文件 `config-sample.yaml`。执行以下命令修改该文件： ```bash vi config-sample.yaml ``` {{< notice note >}} -如果采用 [All-in-one 安装](../../quick-start/all-in-one-on-linux/)，则不需要创建`config-sample.yaml`文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的，如果您想在这个模式下启用审计日志（比如出于测试的目的），可以参考[下面的部分](#在安装后启用审计日志)安装后如何启用审计模式。 +如果您采用 [All-in-One 安装](../../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-One 模式是为那些刚接触 KubeSphere 并希望熟悉系统的用户而准备的，如果您想在该模式下启用审计日志（例如用于测试），请参考[下面的部分](#在安装后启用审计日志)，查看如何在安装后启用审计功能。 {{}} -2. 在该文件中，搜寻到`auditing`，并将`enabled`的`false`改为`true`。完成后保存文件。 +2. 在该文件中，搜寻到 `auditing`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 - ```bash + ```yaml auditing: enabled: true # Change "false" to "true" ``` {{< notice note >}} -默认情况下，如果启用了审计功能，KubeKey 将在内部安装 Elasticsearch。对于生产环境，如果您想启用审计，强烈建议在 **config-sample.yaml** 中设置以下值，尤其是`externalElasticsearchUrl`和`externalElasticsearchPort`。一旦在安装前提供以下信息，KubeKey 将直接整合您的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 +默认情况下，如果启用了审计功能，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -52,7 +51,7 @@ KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排 externalElasticsearchPort: # The port of external Elasticsearch ``` -3. 使用配置文件创建一个集群： +3. 使用配置文件创建集群： ```bash ./kk create cluster -f config-sample.yaml @@ -60,15 +59,15 @@ KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排 ### 在 Kubernetes 上安装 -在已有 Kubernetes 集群上安装 KubeSphere 时，需要部署 [ks-installer](https://github.com/kubesphere/ks-installer/) 的两个 yaml 文件，如下面所示。 +在 Kubernetes 上安装 KubeSphere 的过程与教程[在 Kubernetes 上安装 KubeSphere](../../installing-on-kubernetes/introduction/overview/) 中的说明大致相同，不同之处是需要先在 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中启用审计功能（可选组件）。 -1. 首先下载 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件，然后打开并开始编辑。 +1. 下载 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件，然后打开并开始编辑。 ```bash vi cluster-configuration.yaml ``` -2. 在这个本地`cluster-configuration.yaml`文件中，搜寻到`auditing`，并将`enabled`的`false`改为`true`。完成后保存文件。 +2. 在该本地 `cluster-configuration.yaml` 文件中，搜寻到 `auditing`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```yaml auditing: @@ -76,7 +75,7 @@ KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排 ``` {{< notice note >}} -默认情况下，如果启用了审计功能，ks-installer 会在内部安装 Elasticsearch。对于生产环境，如果您想启用审计，强烈建议在 **cluster-configuration.yaml** 中设置以下值，尤其是`externalElasticsearchUrl`和`externalElasticsearchPort`。当在安装前提供以下信息时，ks-installer 将直接整合您的外部 Elasticsearch，而不是安装内部 Elasticsearch。 +默认情况下，如果启用了审计功能，ks-installer 会安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -101,21 +100,21 @@ KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排 ## 在安装后启用审计日志 -1. 以`admin`身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 - - ![集群管理](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) - -2. 点击 **自定义资源 CRD**，在搜索栏中输入`clusterconfiguration`，点击搜索结果查看其详细页面。 +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 + + ![集群管理](/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/clusters-management.png) + +2. 点击**自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`，点击搜索结果查看其详细页面。 {{< notice info >}} -自定义资源定义（CRD）允许用户在不增加额外的 API 服务器的情况下创建一种新的资源类型，用户可以像使用其它 Kubernetes 内置对象一样使用这些自定义资源。 +自定义资源定义 (CRD) 允许用户在不新增 API 服务器的情况下创建一种新的资源类型，用户可以像使用其他 Kubernetes 内置对象一样使用这些自定义资源。 {{}} -3. 在**资源列表**中，点击`ks-installer`右边的三个点，选择**编辑 YAML**。 +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 - ![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) + ![编辑 YAML](/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/edit-yaml.PNG) -4. 在这个 YAML 文件中，搜寻到`auditing`，将`enabled`的`false`改为`true`。完成后，点击右下角的**更新**，保存配置。 +4. 在该 YAML 文件中，搜寻到 `auditing`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```yaml auditing: @@ -123,7 +122,7 @@ KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排 ``` {{< notice note >}} -默认情况下，如果启用了审计功能，Elasticsearch 将在内部安装。对于生产环境，如果您想启用审计，强烈建议在这个 YAML 文件中设置以下值，尤其是`externalElasticsearchUrl`和`externalElasticsearchPort`。一旦提供了以下信息，KubeSphere 将直接整合您的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 +默认情况下，如果启用了审计功能，将安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -138,14 +137,14 @@ KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排 externalElasticsearchPort: # The port of external Elasticsearch ``` -5. 可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： +5. 可以执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash 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 工具。 +您可以点击控制台右下角的锤子图标找到 Web Kubectl 工具。 {{}} ## 验证组件的安装 @@ -154,11 +153,11 @@ KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排 {{< tab "在仪表板中验证组件的安装" >}} -如果同时启用了日志记录和审计日志，您可以在**服务组件**的 **Logging** 中查看审计状态，其结果如下图片所示： +如果同时启用了日志系统和审计功能，您可以在**服务组件**的 **Logging** 中查看审计状态。您可以看到如下图所示界面： -![auditing](https://ap3.qingstor.com/kubesphere-website/docs/20200829121140.png) +![审计](/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/auditing.PNG) -如果只启用审计而不安装日志，则无法看到上面的图片，因为 **Logging** 按钮不会显示。 +如果只启用审计功能而不安装日志系统，则无法看到上图所示界面，因为不会显示 **Logging** 按钮。 {{}} @@ -172,7 +171,7 @@ kubectl get pod -n kubesphere-logging-system 如果组件运行成功，输出结果如下： -```bash +```yaml 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 diff --git a/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/auditing.PNG b/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/auditing.PNG new file mode 100644 index 000000000..3d595dc83 Binary files /dev/null and b/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/auditing.PNG differ diff --git a/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/clusters-management.png b/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/clusters-management.png new file mode 100644 index 000000000..ee8935e1c Binary files /dev/null and b/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/clusters-management.png differ diff --git a/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/edit-yaml.PNG b/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/edit-yaml.PNG new file mode 100644 index 000000000..0475c20ea Binary files /dev/null and b/static/images/docs/zh-cn/enable-pluggable-components/kubesphere-auditing-logs/edit-yaml.PNG differ