You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,32 +43,32 @@ CAD consists of:
43
43
44
44
1)[PagerDuty Webhooks](https://support.pagerduty.com/docs/webhooks) are used to trigger Configuration-Anomaly-Detection when a [PagerDuty incident](https://support.pagerduty.com/docs/incidents) is created
45
45
2) The webhook routes to a [Tekton EventListener](https://tekton.dev/docs/triggers/eventlisteners/)
46
-
3) Received webhooks are filtered by a [Tekton Interceptor](https://tekton.dev/docs/triggers/interceptors/) that uses the payload to evaluate whether the alert has an implemented handler function in `cadctl` or not. If there is no handler implemented, the alert is directly forwarded to a human SRE.
46
+
3) Received webhooks are filtered by a [Tekton Interceptor](https://tekton.dev/docs/triggers/interceptors/) that uses the payload to evaluate whether the alert has an implemented handler function in `cadctl` or not. If there is no handler implemented, the alert is directly forwarded to a human SRE.
47
47
4) If `cadctl` implements a handler for the received payload/alert, a [Tekton PipelineRun](https://tekton.dev/docs/pipelines/pipelineruns/) is started.
48
-
5) The pipeline runs `cadctl` which determines the handler function by itself based on the payload.
48
+
5) The pipeline runs `cadctl` which determines the handler function by itself based on the payload.
CAD investigations are triggered by PagerDuty webhooks. Currently, CAD supports the following two formats of webhooks:
62
-
- WebhookV3
62
+
- WebhookV3
63
63
- EventOrchestrationWebhook
64
64
65
-
The required investigation is identified by CAD based on the incident and its payload.
65
+
The required investigation is identified by CAD based on the incident and its payload.
66
66
As PagerDuty itself does not provide finer granularity for webhooks than service-based, CAD filters out the alerts it should investigate. For more information, please refer to https://support.pagerduty.com/docs/webhooks.
67
67
68
68
To add a new alert investigation:
69
69
70
70
- run `make bootstrap-investigation` to generate boilerplate code in `pkg/investigations` (This creates the corresponding folder & .go file, and also appends the investigation to the `availableInvestigations` interface in `registry.go`.).
71
-
-if the alert is not yet routed to CAD, add a webhook to the service your alert fires on. For production, the service should also have an escalation policy that escalates to SRE on CAD automation timeout.
71
+
-investigation.Resources contain initialized clients for the clusters aws environment, ocm and more. See [Integrations](#integrations)
72
72
73
73
### Integrations
74
74
@@ -93,7 +93,7 @@ They are initialized for you and passed to the investigation via investigation.R
93
93
- an existing cluster
94
94
- an existing PagerDuty incident for the cluster and alert type that is being tested
95
95
96
-
To quickly create an incident for a cluster_id, you can run `./test/generate_incident.sh <alertname> <clusterid>`.
96
+
To quickly create an incident for a cluster_id, you can run `./test/generate_incident.sh <alertname> <clusterid>`.
97
97
Example usage:`./test/generate_incident.sh ClusterHasGoneMissing 2b94brrrrrrrrrrrrrrrrrrhkaj`.
0 commit comments