website/content/zh/docs/pluggable-components/alerting-notification.md

title	keywords	description	linkTitle	weight
KubeSphere 告警和通知系统	Kubernetes, alertmanager, KubeSphere, alerting, notification	如何启用告警和通知系统	KubeSphere 告警和通知	3545

什么是 KubeSphere 告警和通知系统

告警和通知是可观察性的两个重要构件，与监控和日志密切相关。KubeSphere 中的告警系统与主动故障通知系统相结合，用户可以根据告警策略了解感兴趣的活动。当达到某个指标的预定义阈值时，会向预先配置的收件人发出警报，通知方式可以自行设置，包括 Email、企业微信和 Slack。有了高功能的预警和通知系统，您就可以在潜在的问题影响到您的业务之前，迅速发现并提前解决。

更多信息，请参见告警策略和消息。

{{< notice note >}}

建议同时启用告警和通知功能，这样用户可以及时收到告警通知。

{{</ notice >}}

在安装前启用告警和通知系统

在 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. 在该文件中，搜寻到 alerting 和 notification，并将 enabled 的 false 改为 true。完成后保存文件。

alerting:
    enabled: true # Change "false" to "true"
notification:
    enabled: true # Change "false" to "true"

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 文件中，搜寻到 alerting 和 notification，并将 enabled 的 false 改为 true，启用它们。完成后保存文件。

alerting:
    enabled: true # Change "false" to "true"
notification:
    enabled: true # Change "false" to "true"

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

kubectl apply -f cluster-configuration.yaml

在安装后启用告警和通知系统

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

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

{{< notice info >}}

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

{{</ notice >}}

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

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

alerting:
    enabled: true # Change "false" to "true"
notification:
    enabled: true # Change "false" to "true"

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 "在仪表板中验证组件的安装" >}}

如果在下图中可以看到告警消息和告警策略，说明安装成功，因为在安装组件之前，这两部分不会显示。

{{</ tab >}}

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

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

kubectl get pod -n kubesphere-alerting-system

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

NAME                                       READY   STATUS      RESTARTS   AGE
alerting-client-744c794979-xvsbz           1/1     Running     2          36m
alerting-db-ctrl-job-jwdsh                 0/1     Completed   0          36m
alerting-db-init-job-sj2nv                 0/1     Completed   0          36m
alerting-executor-59ff88f484-2l57d         2/2     Running     0          36m
alerting-manager-5dc9d6cd46-jshkw          1/1     Running     0          36m
alerting-watcher-dcb87b665-sm87b           1/1     Running     0          36m
notification-db-ctrl-job-phxsx             0/1     Completed   3          36m
notification-db-init-job-8q5rf             0/1     Completed   0          36m
notification-deployment-748897cbdf-2djpr   1/1     Running     0          36m

{{</ tab >}}

{{</ tabs >}}