Skip to content

Commit f714a82

Browse files
committed
Fix merge conflict resolution
1 parent 9375d40 commit f714a82

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,32 +43,32 @@ CAD consists of:
4343

4444
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
4545
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.
4747
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.
4949

5050
![CAD Overview](./images/cad_overview/cad_architecture_dark.png#gh-dark-mode-only)
5151
![CAD Overview](./images/cad_overview/cad_architecture_light.png#gh-light-mode-only)
5252

53-
## Contributing
53+
## Contributing
5454

5555
### Building
5656

57-
For build targets, see `make help`.
57+
For build targets, see `make help`.
5858

5959
### Adding a new investigation
6060

6161
CAD investigations are triggered by PagerDuty webhooks. Currently, CAD supports the following two formats of webhooks:
62-
- WebhookV3
62+
- WebhookV3
6363
- EventOrchestrationWebhook
6464

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.
6666
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.
6767

6868
To add a new alert investigation:
6969

7070
- 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)
7272

7373
### Integrations
7474

@@ -93,7 +93,7 @@ They are initialized for you and passed to the investigation via investigation.R
9393
- an existing cluster
9494
- an existing PagerDuty incident for the cluster and alert type that is being tested
9595

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>`.
9797
Example usage:`./test/generate_incident.sh ClusterHasGoneMissing 2b94brrrrrrrrrrrrrrrrrrhkaj`.
9898

9999
### Running cadctl for an incident ID

0 commit comments

Comments
 (0)