Overview
Send Spinnaker pipeline results to Callgoose SQIBS. Spinnaker's Echo service can post every event to a REST endpoint. SQIBS opens an incident when a pipeline fails and resolves it when the same pipeline completes successfully; all other events match no filter and are ignored.
How it works
pipeline:failed opens it, pipeline:complete 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
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- Add a filter with these values (there is no built-in Spinnaker template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "details"."type" |
orca:pipeline:failed |
Opens an incident. |
| Resolve | "details"."type" |
orca:pipeline:complete |
Resolves the open incident. |
| Match | "content"."execution"."name" |
The pipeline name: ties the success to the failure. | |
| Title from | "content"."execution"."name" |
Becomes the incident title. | |
| Description from | "details"."application" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
Echo sends stage and task events too; they match neither filter and are ignored. Pipeline names repeat across applications, so use distinct names or one SQIBS service per application. These values follow the payload shown in the test step. Send one test notification first and confirm the keys with the JSON key creator: Echo can change its payload between versions, and SQIBS matches key names exactly (upper and lower case matter).
Not sure of a key? Send one test message first (step below), then build the filter from the real payload.
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 a REST endpoint to Echo
- Add this to Echo's profile. With
wrap: false, Echo posts the raw event:
# echo-local.yml (Halyard: ~/.hal/default/profiles/echo-local.yml; Operator: spec.spinnakerConfig.profiles.echo)
rest:
enabled: true
endpoints:
- wrap: false
url: "https://<your-endpoint>/sqibs-api/v1/process?from=spinnaker&token=<your-token>"
headers:
Content-Type: application/json
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
- Apply it (
hal deploy apply, or apply your SpinnakerService manifest). Echo restarts with the new endpoint.
Step 3: 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.
- Run a pipeline with a stage that fails, for example a Wait stage followed by a failing Check Preconditions stage.
- In SQIBS, a new incident opens, titled with the pipeline name. Echo's event looks like this (shortened):
{
"details": {
"source": "orca",
"type": "orca:pipeline:failed",
"application": "shop"
},
"content": {
"execution": {
"id": "01JD4X7Q8Y",
"name": "deploy-prod",
"status": "TERMINAL"
}
}
}
- Run the pipeline again successfully. The
orca:pipeline:completeevent resolves the incident.
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 Echo's REST endpoint.
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 the deploy-prod pipeline fails, SQIBS can run a workflow that checks the cluster health and rolls back to the previous server group.
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:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- 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:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.