KubeSphere 审计日志
什么是 KubeSphere 审计日志
KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排列的记录,按顺序记录了与单个用户、管理人员或系统其他组件相关的活动。对 KubeSphere 的每个请求都会生成一个事件,然后写入 Webhook,并根据一定的规则进行处理。
有关更多信息,请参见审计日志查询。
在安装前启用审计日志
在 Linux 上安装
当您在 Linux 上安装多节点 KubeSphere 时,需要创建一个配置文件,该文件列出了所有 KubeSphere 组件。
-
基于在 Linux 上安装 KubeSphere 的教程,您需要创建一个默认文件
config-sample.yaml
。执行以下命令修改该文件:vi config-sample.yaml
备注
如果您采用 All-in-One 安装,则不需要创建config-sample.yaml
文件,因为可以直接创建集群。一般来说,All-in-One 模式是为那些刚接触 KubeSphere 并希望熟悉系统的用户而准备的,如果您想在该模式下启用审计日志(例如用于测试),请参考下面的部分,查看如何在安装后启用审计功能。 -
在该文件中,搜寻到
auditing
,并将enabled
的false
改为true
。完成后保存文件。auditing: enabled: true # Change "false" to "true"
备注
默认情况下,如果启用了审计功能,KubeKey 将安装内置 Elasticsearch。对于生产环境,如果您想启用审计功能,强烈建议在config-sample.yaml
中设置以下值,尤其是externalElasticsearchUrl
和externalElasticsearchPort
。在安装前提供以下信息后,KubeKey 将直接对接您的外部 Elasticsearch,不再安装内置 Elasticsearch。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
-
使用配置文件创建集群:
./kk create cluster -f config-sample.yaml
在 Kubernetes 上安装
在 Kubernetes 上安装 KubeSphere 的过程与教程在 Kubernetes 上安装 KubeSphere 中的说明大致相同,不同之处是需要先在 cluster-configuration.yaml 文件中启用审计功能(可选组件)。
-
下载 cluster-configuration.yaml 文件,然后打开并开始编辑。
vi cluster-configuration.yaml
-
在该本地
cluster-configuration.yaml
文件中,搜寻到auditing
,并将enabled
的false
改为true
。完成后保存文件。auditing: enabled: true # Change "false" to "true"
备注
默认情况下,如果启用了审计功能,ks-installer 会安装内置 Elasticsearch。对于生产环境,如果您想启用审计功能,强烈建议在cluster-configuration.yaml
中设置以下值,尤其是externalElasticsearchUrl
和externalElasticsearchPort
。在安装前提供以下信息后,ks-installer 将直接对接您的外部 Elasticsearch,不再安装内置 Elasticsearch。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
-
执行以下命令开始安装:
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml kubectl apply -f cluster-configuration.yaml
在安装后启用审计日志
-
以
admin
身份登录控制台。点击左上角的平台管理,选择集群管理。 -
点击自定义资源 CRD,在搜索栏中输入
clusterconfiguration
,点击搜索结果查看其详细页面。信息
自定义资源定义 (CRD) 允许用户在不新增 API 服务器的情况下创建一种新的资源类型,用户可以像使用其他 Kubernetes 原生对象一样使用这些自定义资源。 -
在资源列表中,点击
ks-installer
右边的三个点,选择编辑配置文件。 -
在该 YAML 文件中,搜寻到
auditing
,将enabled
的false
改为true
。完成后,点击右下角的更新,保存配置。auditing: enabled: true # Change "false" to "true"
备注
默认情况下,如果启用了审计功能,将安装内置 Elasticsearch。对于生产环境,如果您想启用审计功能,强烈建议在该 YAML 文件中设置以下值,尤其是externalElasticsearchUrl
和externalElasticsearchPort
。提供以下信息后,KubeSphere 将直接对接您的外部 Elasticsearch,不再安装内置 Elasticsearch。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
-
可以执行以下命令,使用 Web Kubectl 工具来检查安装过程:
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
提示
您可以点击控制台右下角的锤子图标找到 Web Kubectl 工具。
验证组件的安装
如果同时启用了日志系统和审计功能,您可以在服务组件的 Logging 中查看审计状态。您可以看到如下图所示界面:
如果只启用审计功能而不安装日志系统,则无法看到上图所示界面,因为不会显示 Logging 按钮。
执行以下命令来检查 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