Overview
Send OpenShift Pipelines results to Callgoose SQIBS. OpenShift Pipelines is built on Tekton, so a finally task at the end of a pipeline can post the run's overall status to your SQIBS API endpoint. SQIBS opens an incident when the pipeline fails and resolves it when the next run succeeds.
How it works
Failed opens it, Succeeded 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 OpenShift Pipelines template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Resolve | "status" |
Succeeded |
Resolves the open incident. |
| Trigger | "status" |
Failed |
Opens an incident. |
| Match | "pipeline" |
Namespace and pipeline: the next good run resolves the last failure. | |
| Title from | "pipeline" |
Becomes the incident title. | |
| Description from | "run" |
The PipelineRun name becomes the description. |
- Choose the Priority for these incidents and click Save.
Tekton reports Completed when all tasks passed but some were skipped. Add a second Resolve filter for Completed if your pipelines skip tasks on purpose.
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: Store the token as a secret
oc create secret generic callgoose-sqibs --from-literal=token='<your-token>' -n <your-namespace>
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Step 3: Add the finally task to the pipeline
Add this block to the pipeline's spec. $(tasks.status) is the overall result of the pipeline's tasks: Succeeded, Failed, Completed or None.
finally:
- name: notify-callgoose-sqibs
params:
- name: status
value: "$(tasks.status)"
- name: pipeline
value: "$(context.pipeline.name)"
- name: run
value: "$(context.pipelineRun.name)"
- name: namespace
value: "$(context.pipelineRun.namespace)"
taskSpec:
params:
- name: status
- name: pipeline
- name: run
- name: namespace
steps:
- name: post
image: registry.access.redhat.com/ubi9/ubi-minimal
env:
- name: SQIBS_TOKEN
valueFrom:
secretKeyRef:
name: callgoose-sqibs
key: token
script: |
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=openshift-pipelines" \
-H "Authorization: Bearer ${SQIBS_TOKEN}" -H "Content-Type: application/json" \
-d '{"pipeline": "$(params.namespace)/$(params.pipeline)", "run": "$(params.run)", "status": "$(params.status)"}'
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.
- Run the pipeline with a step that fails (for example
exit 1). - In SQIBS, a new incident opens, titled with the namespace and pipeline name.
- Fix the step and run the pipeline again. The finally task sends
Succeeded, and SQIBS 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 the finally task.
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 a deployment pipeline fails, SQIBS can run a workflow that checks the target environment and rolls back to the last good release.
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.