Slack¶

If you want to send message using incoming webhook, you can use webhook.

Parameters¶

The Slack notification service configuration includes following settings:

Option	Required	Type	Description	Example
`apiURL`	False	`string`	The server URL.	`https://example.com/api`
`channels`	False	`list[string]`		`["my-channel-1", "my-channel-2"]`
`icon`	False	`string`	The app icon.	`:robot_face:` or `https://example.com/image.png`
`insecureSkipVerify`	False	`bool`		`true`
`signingSecret`	False	`string`		`8f742231b10e8888abcd99yyyzzz85a5`
`token`	True	`string`	The app's OAuth access token.	`xoxb-1234567890-1234567890123-5n38u5ed63fgzqlvuyxvxcx6`
`username`	False	`string`	The app username.	`argocd`
`disableUnfurl`	False	`bool`	Disable slack unfurling links in messages	`true`

Configuration¶

Create Slack Application using https://api.slack.com/apps?new_app=1
Once application is created navigate to Enter OAuth & Permissions
Click Permissions under Add features and functionality section and add chat:write scope. To use the optional username and icon overrides in the Slack notification service also add the chat:write.customize scope.
Scroll back to the top, click 'Install App to Workspace' button and confirm the installation.
Once installation is completed copy the OAuth token.
Create a public or private channel, for this example my_channel
Invite your slack bot to this channel otherwise slack bot won't be able to deliver notifications to this channel

Store Oauth access token in argo-rollouts-notification-secret secret

  apiVersion: v1
  kind: Secret
  metadata:
      name: <secret-name>
  stringData:
      slack-token: <Oauth-access-token>

Define service type slack in data section of argo-rollouts-notification-configmap configmap:

  apiVersion: v1
  kind: ConfigMap
  metadata:
    name: argo-rollouts-notification-configmap
  data:
    service.slack: |
      token: $slack-token

Add annotation in application yaml file to enable notifications for specific argocd app. The following example uses the on-sync-succeeded trigger:

  apiVersion: argoproj.io/v1alpha1
  kind: Application
  metadata:
    annotations:
      notifications.argoproj.io/subscribe.on-sync-succeeded.slack: my_channel

Annotation with more than one trigger, with multiple destinations and recipients

  apiVersion: argoproj.io/v1alpha1
  kind: Application
  metadata:
    annotations:
      notifications.argoproj.io/subscriptions: |
        - trigger: [on-scaling-replica-set, on-rollout-updated, on-rollout-step-completed]
          destinations:
            - service: slack
              recipients: [my-channel-1, my-channel-2]
            - service: email
              recipients: [recipient-1, recipient-2, recipient-3 ]
        - trigger: [on-rollout-aborted, on-analysis-run-failed, on-analysis-run-error]
          destinations:
            - service: slack
              recipients: [my-channel-21, my-channel-22]

Templates¶

Notification templates can be customized to leverage slack message blocks and attachments feature.

The message blocks and attachments can be specified in blocks and attachments string fields under slack field:

template.app-sync-status: |
  message: |
    Application {{.app.metadata.name}} sync is {{.app.status.sync.status}}.
    Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.
  slack:
    attachments: |
      [{
        "title": "{{.app.metadata.name}}",
        "title_link": "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}",
        "color": "#18be52",
        "fields": [{
          "title": "Sync Status",
          "value": "{{.app.status.sync.status}}",
          "short": true
        }, {
          "title": "Repository",
          "value": "{{.app.spec.source.repoURL}}",
          "short": true
        }]
      }]

The messages can be aggregated to the slack threads by grouping key which can be specified in a groupingKey string field under slack field. groupingKey is used across each template and works independently on each slack channel. When multiple applications will be updated at the same time or frequently, the messages in slack channel can be easily read by aggregating with git commit hash, application name, etc. Furthermore, the messages can be broadcast to the channel at the specific template by notifyBroadcast field.

template.app-sync-status: |
  message: |
    Application {{.app.metadata.name}} sync is {{.app.status.sync.status}}.
    Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.
  slack:
    attachments: |
      [{
        "title": "{{.app.metadata.name}}",
        "title_link": "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}",
        "color": "#18be52",
        "fields": [{
          "title": "Sync Status",
          "value": "{{.app.status.sync.status}}",
          "short": true
        }, {
          "title": "Repository",
          "value": "{{.app.spec.source.repoURL}}",
          "short": true
        }]
      }]
    # Aggregate the messages to the thread by git commit hash
    groupingKey: "{{.app.status.sync.revision}}"
    notifyBroadcast: false
template.app-sync-failed: |
  message: |
    Application {{.app.metadata.name}} sync is {{.app.status.sync.status}}.
    Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.
  slack:
    attachments: |
      [{
        "title": "{{.app.metadata.name}}",
        "title_link": "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}",
        "color": "#ff0000",
        "fields": [{
          "title": "Sync Status",
          "value": "{{.app.status.sync.status}}",
          "short": true
        }, {
          "title": "Repository",
          "value": "{{.app.spec.source.repoURL}}",
          "short": true
        }]
      }]
    # Aggregate the messages to the thread by git commit hash
    groupingKey: "{{.app.status.sync.revision}}"
    notifyBroadcast: true

The message is sent according to the deliveryPolicy string field under the slack field. The available modes are Post (default), PostAndUpdate, and Update. The PostAndUpdate and Update settings require groupingKey to be set.