使用 Notification Manager 管理多租户通知

Notification Manager 管理 KubeSphere 中的通知。它接收来自不同发送器的告警或者通知，然后将通知发送给不同用户。

支持的发送器包括：

  • Prometheus Alertmanager
  • 自定义发送器（即将上线）

支持的接收器包括：

notification-manager

快速入门

配置 Prometheus Alertmanager 向 Notification Manager 发送告警

Notification Manager 使用端口 19093 和 API 路径 /api/v2/alerts 来接收由 KubeSphere 的 Prometheus Alertmanager 发送的告警。

为了接收 Alertmanager 告警，KubeSphere 已添加如下所示的 Alertmanager Webhook 和路由配置（编辑命名空间 kubesphere-monitoring-system 中的密钥 alertmanager-main）：

将 Prometheus 告警发送至 Notification Manager：

  1.     "receivers":
  2.     - "name": "prometheus"
  3.       "webhook_configs":
  4.       - "url": "http://notification-manager-svc.kubesphere-monitoring-system.svc:19093/api/v2/alerts"
  5.     "route":
  6.       "routes":
  7.       - "match":
  8.           "alerttype": ""
  9.         "receiver": "prometheus"

将事件告警发送至 Notification Manager：

  1.     "receivers":
  2.     - "name": "event"
  3.       "webhook_configs":
  4.       - "url": "http://notification-manager-svc.kubesphere-monitoring-system.svc:19093/api/v2/alerts"
  5.         "send_resolved": false
  6.     "route":
  7.       "routes":
  8.       - "match":
  9.           "alerttype": "event"
  10.         "receiver": "event"
  11.         "group_interval": "30s"

将审计告警发送至 Notification Manager：

  1.     "receivers":
  2.     - "name": "auditing"
  3.       "webhook_configs":
  4.       - "url": "http://notification-manager-svc.kubesphere-monitoring-system.svc:19093/api/v2/alerts"
  5.         "send_resolved": false
  6.     "route":
  7.       "routes":
  8.       - "match":
  9.           "alerttype": "auditing"
  10.         "receiver": "auditing"
  11.         "group_interval": "30s"

备注

以上所示为默认配置。如果您不想接收某种类型的告警，可以删除相应配置。

配置接收器

Notification Manager 目前支持三种类型的接收器：电子邮件、企业微信和 Slack。只有管理员才能配置接收器。

电子邮件

如果一个名为 test-user 的租户想接收电子邮件通知，请创建一个电子邮件接收器，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: v1
  3. data:
  4.   password: dGVzdA==
  5. kind: Secret
  6. metadata:
  7.   labels:
  8.     app: notification-manager
  9.   name: test-user-email-secret
  10.   namespace: kubesphere-monitoring-system
  11. type: Opaque
  13. ---
  14. apiVersion: notification.kubesphere.io/v1alpha1
  15. kind: EmailConfig
  16. metadata:
  17.   labels:
  18.     app: notification-manager
  19.     type: tenant
  20.     user: test-user
  21.   name: test-user-config
  22.   namespace: kubesphere-monitoring-system
  23. spec:
  24.   authPassword:
  25.     key: password
  26.     name: test-user-email-secret
  27.   authUsername: abc1
  28.   from: abc1@xyz.com
  29.   requireTLS: true
  30.   smartHost:
  31.     host: imap.xyz.com
  32.     port: "25"
  34. ---
  35. apiVersion: notification.kubesphere.io/v1alpha1
  36. kind: EmailReceiver
  37. metadata:
  38.   labels:
  39.     app: notification-manager
  40.     type: tenant
  41.     user: test-user
  42.   name: test-user-receiver
  43.   namespace: kubesphere-monitoring-system
  44. spec:
  45.   emailConfigSelector:
  46.     matchLabels:
  47.       type: tenant
  48.       user: test-user
  49.   to:
  50.   - abc2@xyz.com
  51.   - abc3@xyz.com
  52. EOF

emailConfigSelector 是一个选择器，用于选择电子邮件接收器的 EmailConfig。如果没有设置 emailConfigSelector，接收器将使用默认电子邮件配置。您可以创建一个默认电子邮件配置，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: v1
  3. data:
  4.   password: dGVzdA==
  5. kind: Secret
  6. metadata:
  7.   labels:
  8.     app: notification-manager
  9.   name: default-email-secret
  10.   namespace: kubesphere-monitoring-system
  11. type: Opaque
  13. ---
  14. apiVersion: notification.kubesphere.io/v1alpha1
  15. kind: EmailConfig
  16. metadata:
  17.   labels:
  18.     app: notification-manager
  19.     type: default
  20.   name: default-email-config
  21.   namespace: kubesphere-monitoring-system
  22. spec:
  23.   authPassword:
  24.     key: password
  25.     name: default-email-secret
  26.   authUsername: default
  27.   from: default@xyz.com
  28.   requireTLS: true
  29.   smartHost:
  30.     host: imap.xyz.com
  31.     port: "25"
  32. EOF

带有 type: tenant 标签的电子邮件接收器只接收来自指定租户可以访问的命名空间的通知。如果您想让接收器接收来自所有命名空间的通知，或者不带命名空间标签，您可以创建一个全局电子邮件接收器，标签为 type: global，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: notification.kubesphere.io/v1alpha1
  3. kind: EmailReceiver
  4. metadata:
  5.   labels:
  6.     app: notification-manager
  7.     type: global
  8.   name: global-email-receiver
  9.   namespace: kubesphere-monitoring-system
  10. spec:
  11.   to:
  12.   - global@xyz.com
  13. EOF

备注

全局电子邮件接收器将使用默认电子邮件配置。

企业微信

Notification Manager 支持向企业微信发送通知。如果一个名为 test-user 的租户想接收企业微信通知，请创建一个微信接收器，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: v1
  3. data:
  4.   wechat: dGVzdA==
  5. kind: Secret
  6. metadata:
  7.   labels:
  8.     app: notification-manager
  9.   name: test-user-wechat-secret
  10.   namespace: kubesphere-monitoring-system
  11. type: Opaque
  13. ---
  14. apiVersion: notification.kubesphere.io/v1alpha1
  15. kind: WechatConfig
  16. metadata:
  17.   name: test-user-config
  18.   namespace: kubesphere-monitoring-system
  19.   labels:
  20.     app: notification-manager
  21.     type: tenant
  22.     user: test-user
  23. spec:
  24.   wechatApiUrl: https://qyapi.weixin.qq.com/cgi-bin/
  25.   wechatApiSecret:
  26.     key: wechat
  27.     name: test-user-wehat-secret
  28.   wechatApiCorpId: wwfd76b24f06513578
  29.   wechatApiAgentId: "1000002"
  31. ---
  32. apiVersion: notification.kubesphere.io/v1alpha1
  33. kind: WechatReceiver
  34. metadata:
  35.   name: test-user-wechat
  36.   namespace: kubesphere-monitoring-system
  37.   labels:
  38.     app: notification-manager
  39.     type: tenant
  40.     user: test-user
  41. spec:
  42.   wechatConfigSelector:
  43.     matchLabels:
  44.       type: tenant
  45.       user: test-user
  46.   # optional
  47.   # One of toUser, toParty, toParty should be specified.
  48.   toUser: user1 | user2
  49.   toParty: party1 | party2
  50.   toTag: tag1 | tag2
  51. EOF

信息

  • wechatApiCorpId 即您的企业微信 ID。
  • wechatApiAgentId 即在您的企业微信中向用户发送消息的应用的 ID。
  • wechatApiSecret 即该应用的密钥。您可以在企业微信的应用管理中获取这两个参数。
  • 想接收通知的任意用户、团体或标签必须在该应用的允许用户列表中。

wechatConfigSelector 是一个选择器，用于选择微信接收器的 WechatConfig。如果没有设置 wechatConfigSelector，微信接收器将使用默认微信配置。您可以创建一个默认微信配置，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: v1
  3. data:
  4.   wechat: dGVzdA==
  5. kind: Secret
  6. metadata:
  7.   labels:
  8.     app: notification-manager
  9.   name: default-wechat-secret
  10.   namespace: kubesphere-monitoring-system
  11. type: Opaque
  13. ---
  14. apiVersion: notification.kubesphere.io/v1alpha1
  15. kind: WechatConfig
  16. metadata:
  17.   name: default-wechat-config
  18.   namespace: kubesphere-monitoring-system
  19.   labels:
  20.     app: notification-manager
  21.     type: default
  22. spec:
  23.   wechatApiUrl: https://qyapi.weixin.qq.com/cgi-bin/
  24.   wechatApiSecret:
  25.     key: wechat
  26.     name: default-wechat-secret
  27.   wechatApiCorpId: wwfd76b24f06513578
  28.   wechatApiAgentId: "1000002"
  29. EOF

带有 type: tenant 标签的微信接收器只接收来自指定租户可以访问的命名空间的通知。如果您想让接收器接收来自所有命名空间的通知，或者不带命名空间标签，您可以创建一个全局微信接收器，标签为 type: global，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: notification.kubesphere.io/v1alpha1
  3. kind: WechatReceiver
  4. metadata:
  5.   name: global-wechat-wechat
  6.   namespace: kubesphere-monitoring-system
  7.   labels:
  8.     app: notification-manager
  9.     type: global
  10. spec:
  11.   # optional
  12.   # One of toUser, toParty, toParty should be specified.
  13.   toUser: global
  14.   toParty: global
  15.   toTag: global
  16. EOF

备注

全局微信接收器将使用默认微信配置。

Slack

Notification Manager 支持向 Slack 频道发送通知。如果一个名为 test-user 的租户想接收 Slack 通知，请创建一个 Slack 接收器，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: v1
  3. data:
  4.   token: dGVzdA==
  5. kind: Secret
  6. metadata:
  7.   labels:
  8.     app: notification-manager
  9.   name: test-user-slack-secret
  10.   namespace: kubesphere-monitoring-system
  11. type: Opaque
  13. ---
  14. apiVersion: notification.kubesphere.io/v1alpha1
  15. kind: SlackConfig
  16. metadata:
  17.   name: test-user-config
  18.   namespace: kubesphere-monitoring-system
  19.   labels:
  20.     app: notification-manager
  21.     type: tenant
  22.     user: test-user
  23. spec:
  24.   slackTokenSecret: 
  25.     key: token
  26.     name: test-user-slack-secret
  28. ---
  29. apiVersion: notification.kubesphere.io/v1alpha1
  30. kind: SlackReceiver
  31. metadata:
  32.   name: test-user-slack
  33.   namespace: kubesphere-monitoring-system
  34.   labels:
  35.     app: notification-manager
  36.     type: tenant
  37.     user: test-user
  38. spec:
  39.   slackConfigSelector:
  40.     matchLabels:
  41.       type: tenant
  42.       user: test-user
  43.   channel: alert
  44. EOF

信息

  • 当您创建 Slack 应用时，Slack 令牌为 OAuth 访问令牌或者 Bot 用户 OAuth 访问令牌。
  • 该应用必须有作用域 chat:write。
  • 创建该应用的用户或者 Bot 用户必须在您想发送通知的频道中。

slackConfigSelector 是一个选择器，用于选择 Slack 接收器的 SlackConfig。如果没有设置 slackConfigSelector，Slack 接收器将使用默认 Slack 配置。您可以创建一个默认 Slack 配置，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: v1
  3. data:
  4.   token: dGVzdA==
  5. kind: Secret
  6. metadata:
  7.   labels:
  8.     app: notification-manager
  9.   name: default-slack-secret
  10.   namespace: kubesphere-monitoring-system
  11. type: Opaque
  13. ---
  14. apiVersion: notification.kubesphere.io/v1alpha1
  15. kind: SlackConfig
  16. metadata:
  17.   name: default-slack-config
  18.   namespace: kubesphere-monitoring-system
  19.   labels:
  20.     app: notification-manager
  21.     type: default
  22. spec:
  23.   slackTokenSecret: 
  24.     key: token
  25.     name: default-slack-secret
  26. EOF

带有 type: tenant 标签的 Slack 接收器只接收来自指定租户可以访问的命名空间的通知。如果您想让接收器接收来自所有命名空间的通知，或者不带命名空间标签，您可以创建一个全局 Slack 接收器，标签为 type: global，如下所示：

  1. cat <<EOF | kubectl apply -f -
  2. apiVersion: notification.kubesphere.io/v1alpha1
  3. kind: SlackReceiver
  4. metadata:
  5.   name: global-slack-slack
  6.   namespace: kubesphere-monitoring-system
  7.   labels:
  8.     app: notification-manager
  9.     type: global
  10. spec:
  11.   channel: global
  12. EOF

备注

全局 Slack 接收器将使用默认 Slack 配置。