Version: v1.2

Notification

If we want to be notified before or after deploying an application, KubeVela provides integration with notification webhooks, allowing users to send notifications to Email, DingTalk, Slack, Lark.

In this guide, you will learn how to send notifications via notification in workflow.

How to use

Apply the following Application with workflow step type of 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.         # specify the workflow step type
  45.         type: notification
  47.         properties:
  49.           dingding:
  51.             # the DingTalk webhook address, please refer to: https://developers.dingtalk.com/document/robots/custom-robot-access
  53.             url:
  55.               address: <your dingding url>
  57.             # specify the message details
  59.             message:
  61.               msgtype: text
  63.               text:
  65.                 content: Workflow starting...
  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: notification
  85.         inputs:
  87.           - from: app-status
  89.             parameterKey: slack.message.text
  91.         properties:
  93.           slack:
  95.             # the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks
  97.             url:
  99.               fromSecret:
  101.                 name: <the secret name that stores your slack url>
  103.                 key: <the secret key that stores your slack url>
  105.             # specify the message details, will be filled by the input value
  107.             # message:
  109.             #   text: condition message + Workflow ended.

Expected outcome

we can see that before and after the deployment of the application, the messages can be seen in the corresponding group chat.

With notification, we can integrate with webhook notifier easily.

Parameters

For details, please checkout notification parameters