Skip to content

Overview

Argo CD Notifications continuously monitors Argo CD applications and provides a flexible way to notify users about important changes in the application state. Using a flexible mechanism of triggers and templates you can configure when the notification should be sent as well as notification content. Argo CD Notifications includes the catalog of useful triggers and templates. So you can just use them instead of reinventing new ones.

Getting Started

  • Install Argo CD Notifications
kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/release-1.0/manifests/install.yaml
  • Install Triggers and Templates from the catalog
kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/release-1.0/catalog/install.yaml
  • Add Email username and password token to argocd-notifications-secret secret
export EMAIL_USER=<your-username>
export PASSWORD=<your-password>
kubectl apply -n argocd -f - << EOF
apiVersion: v1
kind: Secret
metadata:
  name: argocd-notifications-secret
stringData:
  email-username: $EMAIL_USER
  email-password: $PASSWORD
type: Opaque
EOF
  • Register Email notification service
kubectl patch cm argocd-notifications-cm -n argocd --type merge -p '{"data": {"service.email.gmail": "{ username: $email-username, password: $email-password, host: smtp.gmail.com, port: 465, from: $email-username }" }}'
  • Subscribe to notifications by adding the notifications.argoproj.io/subscribe.on-sync-succeeded.slack annotation to the Argo CD application or project:
kubectl patch app <my-app> -n argocd -p '{"metadata": {"annotations": {"notifications.argoproj.io/subscribe.on-sync-succeeded.slack":"<my-channel>"}}}' --type merge

Try syncing and application and get the notification once sync is completed.

Helm v3 Getting Started

argocd-notifications is now on Helm Hub as a Helm v3 chart, making it even easier to get started as installing and configuring happen together:

helm repo add argo https://argoproj.github.io/argo-helm
helm install argo/argocd-notifications --generate-name \
    --set triggers[0].name=on-sync-succeeded \
    --set triggers[0].enabled=true \
    --set secret.notifiers.slack.enabled=true \
    --set secret.notifiers.slack.token=<my-token>

For more information or to contribute, check out the argoproj/argo-helm repository.

Kustomize Getting Started

argocd-notification manifests can also be installed using Kustomize. To install argocd-notifications, we recommended saving a tagged release of the install.yaml:

curl -o argocd-notifications-v1.0.2-install.yaml https://github.com/argoproj-labs/argocd-notifications/blob/v1.0.2/manifests/install.yaml

The tagged release should then be included in a kustomization.yaml:

namespace: argocd
resources:
- argocd-notifications-v1.0.2-install.yaml

If you would like to also install Triggers and Templates from the Catalog, we recommend saving a tagged release of the catalog install.yaml:

curl -o argocd-notifications-catalog-v1.0.2-install.yaml https://github.com/argoproj-labs/argocd-notifications/blob/v1.0.2/catalog/install.yaml

The tagged release should then be patched into the base argocd-notifications install manifest in your kustomization.yaml:

namespace: argocd
resources:
- argocd-notifications-v1.0.2-install.yaml
patchesStrategicMerge:
- argocd-notifications-catalog-v1.0.2-install.yaml