Version: v1.2

使用 Webhook 发送通知

在一些情况下，当我们使用工作流部署应用前后，希望能够得到部署的通知。KubeVela 提供了与 Webhook 集成的能力，支持用户在工作流中向邮件、钉钉、Slack 或者飞书发送通知。

本节将介绍如何在工作流中通过 notification 发送 Webhook 通知。

如何使用

部署如下应用部署计划，在部署组件前后，都有一个 notification 步骤发送通知：

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: Application
  5. metadata:
  7.   name: first-vela-workflow
  9.   namespace: default
  11. spec:
  13.   components:
  15.   - name: express-server
  17.     type: webservice
  19.     properties:
  21.       image: crccheck/hello-world
  23.       port: 8000
  25.     traits:
  27.     - type: ingress
  29.       properties:
  31.         domain: testsvc.example.com
  33.         http:
  35.           /: 8000
  37.   workflow:
  39.     steps:
  41.       - name: dingtalk-message
  43.         # 指定步骤类型
  45.         type: notification
  47.         properties:
  49.           dingding:
  51.             # 钉钉 Webhook 地址，请查看：https://developers.dingtalk.com/document/robots/custom-robot-access
  53.             url:
  55.               value: <your dingding url>
  57.             # 具体要发送的信息详情
  59.             message:
  61.               msgtype: text
  63.               text:
  65.                 content: 开始运行工作流
  67.       - name: application
  69.         type: apply-component
  71.         properties:
  73.           component: express-server
  75.         outputs:
  77.           - name: app-status
  79.             valueFrom: output.status.conditions[0].message + "工作流运行完成"
  81.       - name: slack-message
  83.         type: webhook-notification
  85.         inputs:
  87.           - from: app-status
  89.             parameterKey: slack.message.text
  91.         properties:
  93.           slack:
  95.             # Slack Webhook 地址，请查看：https://api.slack.com/messaging/webhooks
  97.             url:
  99.               secretRef:
  101.                 name: <the secret name that stores your slack url>
  103.                 key: <the secret key that stores your slack url>
  105.             # 具体要发送的信息详情，会被 input 中的值覆盖
  107.             # message:
  109.             #   text: condition message + 工作流运行完成

期望结果

通过与 Webhook 的对接，可以看到，在工作流中的组件部署前后，都能在对应的群聊中看到相应的信息。

通过 notification ，可以使用户方便的与 Webhook 对接消息通知。

参数说明

请参考 Notification 内置步骤