Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 3.44 KB

README.md

File metadata and controls

95 lines (63 loc) · 3.44 KB

Configure ArgoCD to send synchronization feedback using Slack

This lab is optional, do it ONLY if you have a Slack account and you are a Workspace administrator.

Prerequisites

Install ArgoCD Notification

$ kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/release-1.0/manifests/install.yaml
$ kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/release-1.0/catalog/install.yaml

Create a Slack custom app

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:bot 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.

Configure ArgoCD Notification

Use the OAuth token to configure the slack integration in the argocd-notifications-secret secret.

Before running the following command, make sure to use your Slack tocken instead of the place holder <YOUR SLACK TOKEN>.

$ kubectl apply -n argocd -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
  name: argocd-notifications-secret
stringData:
  slack-token: <YOUR SLACK TOKEN>
EOF
secret/argocd-notifications-secret configured

Enable built-in trigger in the argocd-notifications-cm config map:

$ kubectl patch cm argocd-notifications-cm \
  -n argocd \
  --type merge \
  -p '{"data":{"service.slack":"token: $slack-token"}}'
configmap/argocd-notifications-cm configured

Subscribe to notifications by adding the recipients.argocd-notifications.argoproj.io annotation to the Argo CD application or project (make sure you put the channel name instead of <my-channel> and the application name instead of <my-app>):

$ kubectl patch app <my-app> -n argocd -p '{"metadata": {"annotations": {"notifications.argoproj.io/subscribe.on-sync-succeeded.slack":"<my-channel>"}}}' --type merge

In my case, I created a Slack channel named #java-hello-world (as the application name), so as my command is:

$ kubectl patch app java-hello-world-development -n argocd -p '{"metadata": {"annotations": {"notifications.argoproj.io/subscribe.on-sync-succeeded.slack": "java-hello-world"}}}' --type merge
application.argoproj.io/java-hello-world-development patched

Before testing the solution, invite the Slack bot you created in the channel java-hello-world by mentioning him in the channel (using @ArgoCD notification).

Test the notification

To test the notification, just manually force a Sync operation on the application you created in the previous lab.

$ argocd app sync java-hello-world-development 
...
Message:            successfully synced (all tasks run)
...

If the solution worked, you should see a message like this on you Slack channel

Troubleshooting

To inspect ArgoCD Notification logs

$ kubectl exec -it $(kubectl get pod -n argocd | grep notification | cut -d " " -f 1) -n argocd --  /app/argocd-notifications trigger get