forked from argoproj/argo-cd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Update notification engine (argoproj#9386)
refactor: Update notification engine (argoproj#9386) Signed-off-by: todaywasawesome <[email protected]>
- Loading branch information
1 parent
1b6275a
commit f788c4e
Showing
5 changed files
with
93 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Pagerduty | ||
|
|
||
| ## Parameters | ||
|
|
||
| The Pagerduty notification service is used to create pagerduty incidents and requires specifying the following settings: | ||
|
|
||
| * `pagerdutyToken` - the pagerduty auth token | ||
| * `from` - email address of a valid user associated with the account making the request. | ||
| * `serviceID` - The ID of the resource. | ||
|
|
||
|
|
||
| ## Example | ||
|
|
||
| The following snippet contains sample Pagerduty service configuration: | ||
|
|
||
| ```yaml | ||
| apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| name: <secret-name> | ||
| stringData: | ||
| pagerdutyToken: <pd-api-token> | ||
| ``` | ||
| ```yaml | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: <config-map-name> | ||
| data: | ||
| service.pagerduty: | | ||
| token: $pagerdutyToken | ||
| from: <emailid> | ||
| ``` | ||
| ## Template | ||
| Notification templates support specifying subject for pagerduty notifications: | ||
| ```yaml | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: <config-map-name> | ||
| data: | ||
| template.rollout-aborted: | | ||
| message: Rollout {{.rollout.metadata.name}} is aborted. | ||
| pagerduty: | ||
| title: "Rollout {{.rollout.metadata.name}}" | ||
| urgency: "high" | ||
| body: "Rollout {{.rollout.metadata.name}} aborted " | ||
| priorityID: "<priorityID of incident>" | ||
| ``` | ||
| NOTE: A Priority is a label representing the importance and impact of an incident. This is only available on Standard and Enterprise plans of pagerduty. | ||
| ## Annotation | ||
| Annotation sample for pagerduty notifications: | ||
| ```yaml | ||
| apiVersion: argoproj.io/v1alpha1 | ||
| kind: Rollout | ||
| metadata: | ||
| annotations: | ||
| notifications.argoproj.io/subscribe.on-rollout-aborted.pagerduty: "<serviceID for Pagerduty>" | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters