KubeSphere 审计日志

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

有关更多信息,请参见审计日志查询

在安装前启用审计日志

在 Linux 上安装

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

  1. 在 Linux 上安装 KubeSphere 时,您需要创建一个默认文件 config-sample.yaml。执行以下命令修改该文件:

    1. vi config-sample.yaml

    备注

    如果您采用 All-in-One 安装,则不需要创建 config-sample.yaml 文件,因为可以直接创建集群。一般来说,All-in-One 模式是为那些刚接触 KubeSphere 并希望熟悉系统的用户而准备的,如果您想在该模式下启用审计日志(例如用于测试),请参考下面的部分,查看如何在安装后启用审计功能。

  2. 在该文件中,搜索 auditing,并将 enabledfalse 改为 true。完成后保存文件。

    1. auditing:
    2. enabled: true # 将“false”更改为“true”。

    备注

    默认情况下,如果启用了审计功能,KubeKey 将安装内置 Elasticsearch。对于生产环境,如果您想启用审计功能,强烈建议在 config-sample.yaml 中设置以下值,尤其是 externalElasticsearchUrlexternalElasticsearchPort。在安装前提供以下信息后,KubeKey 将直接对接您的外部 Elasticsearch,不再安装内置 Elasticsearch。

    1. es: # Storage backend for logging, tracing, events and auditing.
    2. elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed.
    3. elasticsearchDataReplicas: 1 # The total number of data nodes.
    4. elasticsearchMasterVolumeSize: 4Gi # The volume size of Elasticsearch master nodes.
    5. elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes.
    6. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default.
    7. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
    8. externalElasticsearchUrl: # The Host of external Elasticsearch.
    9. externalElasticsearchPort: # The port of external Elasticsearch.
  3. 执行以下命令使用该配置文件创建集群:

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

在 Kubernetes 上安装

当您在 Kubernetes 上安装 KubeSphere 时,需要先在 cluster-configuration.yaml 文件中启用审计功能。

  1. 下载 cluster-configuration.yaml 文件,执行以下命令打开并编辑该文件:

    1. vi cluster-configuration.yaml
  2. cluster-configuration.yaml 文件中,搜索 auditing,并将 enabledfalse 改为 true。完成后保存文件。

    1. auditing:
    2. enabled: true # 将“false”更改为“true”。

    备注

    默认情况下,如果启用了审计功能,ks-installer 会安装内置 Elasticsearch。对于生产环境,如果您想启用审计功能,强烈建议在 cluster-configuration.yaml 中设置以下值,尤其是 externalElasticsearchUrlexternalElasticsearchPort。在安装前提供以下信息后,ks-installer 将直接对接您的外部 Elasticsearch,不再安装内置 Elasticsearch。

    1. es: # Storage backend for logging, tracing, events and auditing.
    2. elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed.
    3. elasticsearchDataReplicas: 1 # The total number of data nodes.
    4. elasticsearchMasterVolumeSize: 4Gi # The volume size of Elasticsearch master nodes.
    5. elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes.
    6. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default.
    7. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
    8. externalElasticsearchUrl: # The Host of external Elasticsearch.
    9. externalElasticsearchPort: # The port of external Elasticsearch.
  3. 执行以下命令开始安装:

    1. kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.3.0/kubesphere-installer.yaml
    2. kubectl apply -f cluster-configuration.yaml

在安装后启用审计日志

  1. admin 用户登录控制台。点击左上角的平台管理,选择集群管理

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

    信息

    定制资源定义 (CRD) 允许用户在不新增 API 服务器的情况下创建一种新的资源类型,用户可以像使用其他 Kubernetes 原生对象一样使用这些定制资源。

  3. 自定义资源中,点击 ks-installer 右侧的 KubeSphere 审计日志 - 图1,选择编辑 YAML

  4. 在该 YAML 文件中,搜索 auditing,将 enabledfalse 改为 true。完成后,点击右下角的确定,保存配置。

    1. auditing:
    2. enabled: true # 将“false”更改为“true”。

    备注

    默认情况下,如果启用了审计功能,将安装内置 Elasticsearch。对于生产环境,如果您想启用审计功能,强烈建议在该 YAML 文件中设置以下值,尤其是 externalElasticsearchUrlexternalElasticsearchPort。提供以下信息后,KubeSphere 将直接对接您的外部 Elasticsearch,不再安装内置 Elasticsearch。

    1. es: # Storage backend for logging, tracing, events and auditing.
    2. elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed.
    3. elasticsearchDataReplicas: 1 # The total number of data nodes.
    4. elasticsearchMasterVolumeSize: 4Gi # The volume size of Elasticsearch master nodes.
    5. elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes.
    6. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default.
    7. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
    8. externalElasticsearchUrl: # The Host of external Elasticsearch.
    9. externalElasticsearchPort: # The port of external Elasticsearch.
  5. 在 kubectl 中执行以下命令检查安装过程:

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

    备注

    您可以点击控制台右下角的 KubeSphere 审计日志 - 图2 找到 kubectl 工具。

验证组件的安装

验证您可以使用右下角工具箱中的审计日志查询功能。

执行以下命令来检查容器组的状态:

  1. kubectl get pod -n kubesphere-logging-system

如果组件运行成功,输出结果如下:

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