使用GitOps發布應用時,可以配置多種通知服務(例如Email、釘釘等)用于接收應用的重要變化。例如,當應用發布異常時您可以快速收到通知提醒,并及時排查異常原因。本文以發送釘釘消息為例,介紹如何在GitOps中發送通知。
背景信息
Argo CD Notifications提供了配置應用通知的機制,有以下幾個主要概念:
Triggers:定義發送通知的條件。
Templates:用于生成通知內容。
Subscriptions:訂閱應用、觸發器,并通過某種或者某幾種服務進行消息通知。
Notification Services:通知服務,如Email、Slack、GitHub、Webhook等。
釘釘是通過暴露HTTP Webhook接口的方式接收消息輸入,在ConfigMap下的argocd/argocd-notifications-cm
中配置Triggers、Templates、Notification Services和Subscriptions,可實現應用發生重要變化時自動推送釘釘通知。
前提條件
已開啟艦隊管理功能。具體操作,請參見開啟艦隊管理功能。
已從ACK One控制臺獲取Fleet實例的KubeConfig,并通過kubectl連接至Fleet實例。具體操作,請參見獲取集群KubeConfig并通過kubectl工具連接集群。
步驟一:創建釘釘機器人
創建釘釘機器人后會生成專屬的Webhook地址,通過Webhook地址可以關聯到其他服務用于接收通知消息,例如Argo工作流。
打開需要接收事件的釘釘群。
進入機器人設置頁面,添加自定義機器人。
單擊釘釘群右上角的圖標,然后在群設置面板單擊機器人。
在機器人管理面板單擊添加機器人,并單擊自定義卡片,然后在彈出的對話框中單擊添加。
設置機器人名字并選擇安全設置,然后單擊完成。
您必須至少選擇一種安全設置,建議選擇加簽或IP地址(段)中的至少一種,以保證安全性。
重要在工作流中通過釘釘發送消息,要求工作流集群的VPC網絡具有公網訪問能力。您可以為工作流集群VPC配置公網NAT網關,同時將公網NAT網關的EIP地址配置到機器人的IP地址(段)中,以確保安全性。
設置完成后復制并保存自定義機器人的Webhook地址。
步驟二:配置應用通知
通過kubectl連接到Fleet實例后,使用以下命令在argocd/argocd-notifications-cm
中進行配置。
kubectl edit cm argocd-notifications-cm -nargocd
配置示例如下:
service.webhook.dingtalk
的url
需要替換為您在步驟一:創建釘釘機器人中獲取到的釘釘機器人的Webhook地址。context
的argocdUrl
需要替換為實際的ArgoCD Server域名。獲取方式,請參見GitOps ArgoCD Server域名介紹。如果每個trigger需要定制不同信息,可以為每個trigger配置一個對應的templates。
如果需要改變通知內容的顏色,可以使用
<font color=>xxxx</font>
配置通知內容。
apiVersion: v1
kind: ConfigMap
metadata:
name: argocd-notifications-cm
namespace: argocd
data:
service.webhook.dingtalk: |
url: https://oapi.dingtalk.com/robot/send?access_token=535a56d**********
headers:
- name: Content-Type
value: application/json
context: |
argocdUrl: https://argocd.<your-fleet-id>.<region>.alicontainer.com
template.app-sync-change: |
webhook:
dingtalk:
method: POST
body: |
{
"msgtype": "markdown",
"markdown": {
"title":"ArgoCD應用狀態",
"text": "### ArgoCD應用狀態\n> - 應用名稱: {{.app.metadata.name}}\n> - 同步狀態: {{ .app.status.operationState.phase}}\n> - 時間:{{.app.status.operationState.finishedAt}}\n> - 應用URL: [點擊跳轉]({{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true) \n"
}
}
template.app-sync-status-unknown: |
webhook:
dingtalk:
method: POST
body: |
{
"msgtype": "markdown",
"markdown": {
"title":"ArgoCD應用Unknown",
"text": "### ArgoCD應用Unknown\n> - <font color=\"warning\">應用名稱</font>: {{.app.metadata.name}}\n> - <font color=\"warning\">應用同步狀態</font>: {{.app.status.sync.status}}\n> - <font color=\"warning\">應用健康狀態</font>: {{.app.status.health.status}}\n> - <font color=\"warning\">時間</font>: {{.app.status.operationState.startedAt}}\n> - <font color=\"warning\">應用URL</font>: [點擊跳轉ArgoCD UI]({{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true)"
}
}
template.app-sync-failed: |
webhook:
dingtalk:
method: POST
body: |
{
"msgtype": "markdown",
"markdown": {
"title":"ArgoCD應用發布失敗",
"text": "### ArgoCD應用發布失敗\n> - <font color=\"danger\">應用名稱</font>: {{.app.metadata.name}}\n> - <font color=\"danger\">應用同步狀態</font>: {{.app.status.operationState.phase}}\n> - <font color=\"danger\">應用健康狀態</font>: {{.app.status.health.status}}\n> - <font color=\"danger\">時間</font>: {{.app.status.operationState.startedAt}}\n> - <font color=\"danger\">應用URL</font>: [點擊跳轉ArgoCD UI]({{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true)"
}
}
trigger.on-deployed: |
- description: Application is synced and healthy. Triggered once per commit.
oncePer: app.status.sync.revision
send: [app-sync-change]
# trigger condition
when: app.status.operationState.phase in ['Succeeded'] and app.status.health.status == 'Healthy'
trigger.on-health-degraded: |
- description: Application has degraded
send: [app-sync-change]
when: app.status.health.status == 'Degraded'
trigger.on-sync-failed: |
- description: Application syncing has failed
send: [app-sync-failed]
when: app.status.operationState != nil and app.status.operationState.phase in ['Error',
'Failed']
trigger.on-sync-status-unknown: |
- description: Application status is 'Unknown'
send: [app-sync-status-unknown]
when: app.status.sync.status == 'Unknown'
trigger.on-sync-running: |
- description: Application is being synced
send: [app-sync-change]
when: app.status.operationState != nil and app.status.operationState.phase in ['Running']
trigger.on-sync-succeeded: |
- description: Application syncing has succeeded
send: [app-sync-change]
when: app.status.operationState != nil and app.status.operationState.phase in ['Succeeded']
subscriptions: |
- recipients: [dingtalk]
triggers: [on-sync-failed, on-sync-succeeded, on-sync-status-unknown,on-deployed]
相關文檔
若您需要配置釘釘自定義機器人的消息通知展示樣式,可參見釘釘自定義機器人數據類型及格式。