Overview

Send Argo CD application problems to Callgoose SQIBS. Argo CD's built-in notifications engine posts to your SQIBS API endpoint when a sync fails or an application turns Degraded, and again when it is synced and Healthy. SQIBS opens an incident for the problem and resolves it on recovery.

You need
Argo CD 2.3 or later with kubectl access to the argocd namespace, and a SQIBS API token
Setup time
About 20 minutes
Result
Failed syncs open SQIBS incidents; healthy apps resolve them

How it works

Argo CD
Alert fires
A sync fails or an application turns Degraded.
Argo CD
Sends a webhook
Argo CD notifications posts the webhook body you define.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
problem opens it, ok closes it.

Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.

Step 1: Add the API filter in SQIBS

  1. In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
  2. Add a filter with these values (there is no built-in Argo CD template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "status" problem Opens an incident.
Resolve "status" ok Resolves the open incident.
Match "app" The application name ties the recovery to its incident.
Title from "message" Becomes the incident title.
Description from "url" A link to the application in Argo CD.
  1. Choose the Priority for these incidents and click Save.

Not sure of a key? Send one test message first (step below), then build the filter from the real payload.

Find the right key with the JSON key creator
In the API Integration window, click the round {} button at the bottom right. Paste a payload that SQIBS received (copy it from the API log). SQIBS lists every key with its value, each with a copy button. Copy the key into Payload JSON key and the value into Key value contains. No need to read the JSON by hand.

Step 2: Add the webhook service, templates and triggers

Argo CD 2.3 and later include the notifications controller; you do not need to install it separately. Add this to the argocd-notifications-cm ConfigMap (merge it with what is already there):

apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
  namespace: argocd
data:
  service.webhook.callgoose: |
    url: https://<your-endpoint>/sqibs-api/v1/process?from=argocd&token=<your-token>
    headers:
      - name: Content-Type
        value: application/json
  template.callgoose-problem: |
    webhook:
      callgoose:
        method: POST
        body: |
          {"status": "problem", "app": "{{.app.metadata.name}}",
           "sync": "{{.app.status.sync.status}}", "health": "{{.app.status.health.status}}",
           "message": "{{.app.metadata.name}} is {{.app.status.health.status}} / {{.app.status.operationState.phase}}",
           "url": "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}"}
  template.callgoose-ok: |
    webhook:
      callgoose:
        method: POST
        body: |
          {"status": "ok", "app": "{{.app.metadata.name}}", "health": "{{.app.status.health.status}}"}
  trigger.on-callgoose-problem: |
    - when: app.status.operationState.phase in ['Error', 'Failed'] or app.status.health.status == 'Degraded'
      send: [callgoose-problem]
  trigger.on-callgoose-ok: |
    - when: app.status.operationState.phase in ['Succeeded'] and app.status.health.status == 'Healthy'
      send: [callgoose-ok]

Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.

To keep the token out of the ConfigMap, put it in the argocd-notifications-secret Secret and reference it as $callgoose-token in the URL.

Step 3: Subscribe applications

Annotate each application (or the AppProject, to cover all its apps):

kubectl -n argocd annotate app <app-name> \
  notifications.argoproj.io/subscribe.on-callgoose-problem.callgoose="" \
  notifications.argoproj.io/subscribe.on-callgoose-ok.callgoose=""

Step 4: Test it

The API log saves payloads only while API Tracking is on for the token. Turn it on under API Tokens before you test; it switches itself off after 48 hours.

  1. Point a test application at a bad revision so its sync fails.
  2. In SQIBS, a new incident opens, titled with the application state. The payload looks like this:
{
  "status": "problem",
  "app": "shop-api",
  "sync": "OutOfSync",
  "health": "Degraded",
  "message": "shop-api is Degraded / Failed",
  "url": "https://argocd.example.com/applications/shop-api"
}
  1. Fix the revision and sync again. When the app is Synced and Healthy, SQIBS resolves the incident.
  2. If nothing arrives, check the controller log: kubectl -n argocd logs deploy/argocd-notifications-controller.

No incident? Open the API log (with API Tracking on). If the payload is there, the filter did not match it: paste it into the JSON key creator and check the keys. If it is not there, check the URL and token in argocd-notifications-cm.

Fix known issues automatically

Many alerts have a known fix: restart a service, clear a full disk, run a health check. SQIBS can run that fix for you the moment the incident opens. This is event-driven auto remediation. For example, when an application turns Degraded after a sync, SQIBS can run a workflow that rolls it back to the previous revision with argocd app rollback.

Incident opens
Workflow starts
SQIBS runs the automation workflow linked to the filter.
Fixed
Incident resolved
The issue is fixed before anyone has to step in.
Not fixed
Escalated to the engineer
After the waiting time you set, the escalation policy pages on-call as usual.

Safe by design. SQIBS runs only workflows your own engineers wrote and approved for your environment. Nothing is guessed or generated: the same steps an engineer would run by hand, run sooner. If the workflow does not fix the issue, the engineer is paged as usual.

To set it up, in the same API filter:

  1. Select Workflow: choose the automation workflow to run when this filter opens an incident.
  2. If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
  3. Waiting time for escalate to escalation policies: how many minutes to give the workflow before paging the on-call engineer.

Start with low-risk workflows, such as a health check, and add fixes as you come to trust them.

Learn more: