Triggers

The trigger defines the condition when the notification should be sent. The definition includes name, condition and notification templates reference.

The trigger is configured in argocd-notifications-cm ConfigMap. For example the following trigger sends a notification when application sync status changes to Unknown using app-sync-status template:

apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
data:
  trigger.on-sync-status-unknown: |
    - when: app.status.sync.status == 'Unknown'     # trigger condition
      send: [app-sync-status, github-commit-status] # template names

Each condition might use several templates. Typically each template is responsible for generating a service-specific notification part. In the example above app-sync-status template "knows" how to create email and slack notification and github-commit-status knows how to generate payload for Github webhook.

Conditions Bundles¶

Triggers are typically managed by administrators and encapsulate information about when and which notification should be sent. The end users just need to subscribe to the trigger and specify the notification destination. In order to improve user experience triggers might include multiple conditions with a different set of templates for each condition. For example, the following trigger covers all stages of sync status operation and use a different template for different cases:

apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
data:
  trigger.sync-operation-change: |
    - when: app.status.operationState.phase in ['Succeeded']
      send: [github-commit-status]
    - when: app.status.operationState.phase in ['Running']
      send: [github-commit-status]
    - when: app.status.operationState.phase in ['Error', 'Failed']
      send: [app-sync-failed, github-commit-status]

Avoid Sending Same Notification Too Often¶

In some cases, the trigger condition might be "flapping". The example below illustrates the problem. The trigger is supposed to generate a notification once when Argo CD application is successfully synchronized and healthy. However the application health status might intermittently switch to Progressing and then back to Healthy so the trigger might unnecessary generate multiple notifications. The oncePer field configures triggers to generate the notification only when the corresponding application field changes. The on-deployed trigger from the example below sends the notification only once per observed Git revision of the deployment repository.

apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
data:
  # Optional 'oncePer' property ensure that notification is sent only once per specified field value
  # E.g. following is triggered once per sync revision
  trigger.on-deployed: |
    when: app.status.operationState.phase in ['Succeeded'] and app.status.health.status == 'Healthy'
    oncePer: app.status.sync.revision
    send: [app-sync-succeeded]

Functions¶

Triggers have access to the set of built-in functions.

Example:

when: time.Now().Sub(time.Parse(app.status.operationState.startedAt)).Minutes() >= 5

time¶

Time related functions.

time.Now() Time

Executes function built-in Golang time.Now function. Returns an instance of Golang Time.

time.Parse(val string) Time

Parses specified string using RFC3339 layout. Returns an instance of Golang Time.

repo¶

Functions that provide additional information about Application source repository.

repo.RepoURLToHTTPS(url string) string

Transforms given GIT URL into HTTPs format.

repo.FullNameByRepoURL(url string) string

Returns repository URL full name (<owner>/<repoName>). Currently supports only Github, Gitlab and Bitbucket.

repo.GetCommitMetadata(sha string) CommitMetadata

Returns commit metadata. The commit must belong to the application source repository. CommitMetadata fields:

Message string commit message
Author string - commit author
Date time.Time - commit creation date
Tags []string - Associated tags