chore: update notifications-engine to 22ccfe0caf45 (argoproj#20239)

* Update notifications-engine Signed-off-by: SLASHLogin <loginmlgxd@gmail.com> * Update docs for Opsgenie notifications Signed-off-by: SLASHLogin <loginmlgxd@gmail.com> * docs: Fix outdated slack notification configuration readme Signed-off-by: SLASHLogin <loginmlgxd@gmail.com> --------- Signed-off-by: SLASHLogin <loginmlgxd@gmail.com> Signed-off-by: Moleus <fafufuburr@gmail.com>
moleus · Oct 7, 2024 · 8ef5f69 · 8ef5f69
1 parent e040049
commit 8ef5f69
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 30 deletions.
diff --git a/docs/operator-manual/notifications/services/opsgenie.md b/docs/operator-manual/notifications/services/opsgenie.md
@@ -2,28 +2,34 @@
 
 To be able to send notifications with argocd-notifications you have to create an [API Integration](https://docs.opsgenie.com/docs/integrations-overview) inside your [Opsgenie Team](https://docs.opsgenie.com/docs/teams).
 
-1. Login to Opsgenie at https://app.opsgenie.com or https://app.eu.opsgenie.com (if you have an account in the european union)
-2. Make sure you already have a team, if not follow this guide https://docs.opsgenie.com/docs/teams
-3. Click "Teams" in the Menu on the left
-4. Select the team that you want to notify
-5. In the teams configuration menu select "Integrations"
-6. Click "Add Integration" in the top right corner
-7. Select "API" integration
-8. Give your integration a name, copy the "API key" and safe it somewhere for later
-9. Click "Edit" in the integration settings
-10. Make sure the checkbox for "Create and Update Access" is selected, disable the other checkboxes to remove unnecessary permissions
-11. Click "Save" at the bottom
-12. Click "Turn on integration" in the top right corner
-13. Check your browser for the correct server apiURL. If it is "app.opsgenie.com" then use the US/international api url `api.opsgenie.com` in the next step, otherwise use `api.eu.opsgenie.com` (European API). 
-14. You are finished with configuring Opsgenie. Now you need to configure argocd-notifications. Use the apiUrl, the team name and the apiKey to configure the Opsgenie integration in the `argocd-notifications-secret` secret.
-15. You can find the example `argocd-notifications-cm` configuration at the below.
+1. Login to Opsgenie at https://app.opsgenie.com or https://app.eu.opsgenie.com (if you have an account in the European Union).
+2. Make sure you already have a team; if not, follow this guide: https://docs.opsgenie.com/docs/teams.
+3. Click "Teams" in the Menu on the left.
+4. Select the team that you want to notify.
+5. In the team's configuration menu, select "Integrations".
+6. Click "Add Integration" in the top right corner.
+7. Select "API" integration.
+8. Give your integration a name, copy the "API key", and save it somewhere for later.
+9. Click "Edit" in the integration settings.
+10. Make sure the checkbox for "Create and Update Access" is selected; disable the other checkboxes to remove unnecessary permissions.
+11. Click "Save" at the bottom.
+12. Click "Turn on integration" in the top right corner.
+13. Check your browser for the correct server apiURL. If it is "app.opsgenie.com", then use the US/international API URL `api.opsgenie.com`; otherwise, use `api.eu.opsgenie.com` (European API).
+14. You are finished with configuring Opsgenie. Now you need to configure argocd-notifications. Use the apiUrl, the team name, and the apiKey to configure the Opsgenie integration in the `argocd-notifications-secret` secret.
+15. You can find the example `argocd-notifications-cm` configuration below.
 
 | **Option**    | **Required** | **Type** | **Description**                                                                                          | **Example**                      |
 | ------------- | ------------ | -------- | -------------------------------------------------------------------------------------------------------- | -------------------------------- |
-| `description` | True         | `string` | Description field of the alert that is generally used to provide a detailed information about the alert. | `Hello from Argo CD!`            |
-| `priority`    | False        | `string` | Priority level of the alert. Possible values are P1, P2, P3, P4 and P5. Default value is P3.             | `P1`                             |
+| `description` | True         | `string` | Description field of the alert that is generally used to provide detailed information about the alert.   | `Hello from Argo CD!`            |
+| `priority`    | False        | `string` | Priority level of the alert. Possible values are P1, P2, P3, P4, and P5. Default value is P3.            | `P1`                             |
 | `alias`       | False        | `string` | Client-defined identifier of the alert, that is also the key element of Alert De-Duplication.            | `Life is too short for no alias` |
-| `note`       | False        | `string` | Additional note that will be added while creating the alert.            | `Error from Argo CD!` |
+| `note`        | False        | `string` | Additional note that will be added while creating the alert.                                            | `Error from Argo CD!`           |
+| `actions`     | False        | `[]string` | Custom actions that will be available for the alert.                                                    | `["Resolve", "Escalate"]`       |
+| `tags`        | False        | `[]string` | Tags of the alert.                                                                                        | `["critical", "deployment"]`    |
+| `visibleTo`   | False        | `[]alert.Responder` | Teams and users that the alert will become visible to without sending any notification. The `type` field is mandatory for each item, where possible values are `team` and `user`. In addition to the `type` field, either `id` or `name` should be provided for teams, and either `id` or `username` should be given for users. Please note that alerts will be visible to the teams specified within the `responders` field by default, so there is no need to re-specify them in the `visibleTo` field. | `[{Type: "team", Id: "team_id"}, {Type: "user", Id: "user_id"}]` |
+| `details`     | False        | `map[string]string` | Map of key-value pairs to use as custom properties of the alert.                                         | `{"environment": "production", "service": "web"}` |
+| `entity`      | False        | `string` | Entity field of the alert that is generally used to specify which domain the alert is related to.       | `web-server`                     |
+| `user`        | False        | `string` | Display name of the request owner.                                                                        | `admin_user`                     |
 
 ```yaml
 apiVersion: v1
@@ -47,18 +53,38 @@ data:
       priority: P1
       alias: {{.app.metadata.name}}
       note: Error from Argo CD!
+      actions:
+        - Restart
+        - AnExampleAction
+      tags:
+        - OverwriteQuietHours
+        - Critical
+      visibleTo:
+        - Id: "{{.app.metadata.responderId}}"
+          Type: "team"
+        - Name: "rocket_team"
+          Type: "team"
+        - Id: "{{.app.metadata.responderUserId}}"
+          Type: "user"
+        - Username: "trinity@opsgenie.com"
+          Type: "user"
+      details:
+        environment: production
+        service: web
+      entity: Argo CD Application
+      user: John Doe
   trigger.on-a-problem: |
     - description: Application has a problem.
       send:
       - opsgenie
       when: app.status.health.status == 'Degraded' or app.status.operationState.phase in ['Error', 'Failed'] or app.status.sync.status == 'Unknown'
 ```
 
-16. Add annotation in application yaml file to enable notifications for specific Argo CD app.
+16. Add annotation in the application YAML file to enable notifications for a specific Argo CD app.
 ```yaml
-  apiVersion: argoproj.io/v1alpha1
-  kind: Application
-  metadata:
-    annotations:
-      notifications.argoproj.io/subscribe.on-a-problem.opsgenie: <your-team>
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  annotations:
+    notifications.argoproj.io/subscribe.on-a-problem.opsgenie: <your-team>
 ```
diff --git a/docs/operator-manual/notifications/services/slack.md b/docs/operator-manual/notifications/services/slack.md
@@ -21,11 +21,11 @@ The Slack notification service configuration includes following settings:
 
 1. Create Slack Application using https://api.slack.com/apps?new_app=1
 ![1](https://user-images.githubusercontent.com/426437/73604308-4cb0c500-4543-11ea-9092-6ca6bae21cbb.png)
-1. Once application is created navigate to `Enter OAuth & Permissions`
+1. Once application is created navigate to `OAuth & Permissions`
 ![2](https://user-images.githubusercontent.com/426437/73604309-4d495b80-4543-11ea-9908-4dea403d3399.png)
-1. Click `Permissions` under `Add features and functionality` section and add `chat:write` scope. To use the optional username and icon overrides in the Slack notification service also add the `chat:write.customize` scope.
+1. Go to `Scopes` > `Bot Token Scopes` > `Add an OAuth Scope`. Add `chat:write` scope. To use the optional username and icon overrides in the Slack notification service also add the `chat:write.customize` scope.
 ![3](https://user-images.githubusercontent.com/426437/73604310-4d495b80-4543-11ea-8576-09cd91aea0e5.png)
-1. Scroll back to the top, click 'Install App to Workspace' button and confirm the installation.
+1. `OAuth & Permission` > `OAuth Tokens for Your Workspace` > `Install to Workspace`
 ![4](https://user-images.githubusercontent.com/426437/73604311-4d495b80-4543-11ea-9155-9d216b20ec86.png)
 1. Once installation is completed copy the OAuth token.
 ![5](https://user-images.githubusercontent.com/426437/73604312-4d495b80-4543-11ea-832b-a9d9d5e4bc29.png)

diff --git a/go.mod b/go.mod
@@ -11,7 +11,7 @@ require (
 	github.com/alicebob/miniredis/v2 v2.33.0
 	github.com/antonmedv/expr v1.15.1
 	github.com/argoproj/gitops-engine v0.7.1-0.20240917171920-72bcdda3f0a5
-	github.com/argoproj/notifications-engine v0.4.1-0.20240606074338-0802cd427621
+	github.com/argoproj/notifications-engine v0.4.1-0.20241005182503-22ccfe0caf45
 	github.com/argoproj/pkg v0.13.7-0.20230626144333-d56162821bd1
 	github.com/aws/aws-sdk-go v1.55.5
 	github.com/bmatcuk/doublestar/v4 v4.6.1

diff --git a/go.sum b/go.sum
@@ -86,8 +86,8 @@ github.com/apache/thrift v0.13.0/go.mod h1:cp2SuWMxlEZw2r+iP2GNCdIi4C1qmUzdZFSVb
 github.com/appscode/go v0.0.0-20191119085241-0887d8ec2ecc/go.mod h1:OawnOmAL4ZX3YaPdN+8HTNwBveT1jMsqP74moa9XUbE=
 github.com/argoproj/gitops-engine v0.7.1-0.20240917171920-72bcdda3f0a5 h1:K/e+NsNmE4BccRu21QpqUxkTHxU9YWjU3M775Ck+V/E=
 github.com/argoproj/gitops-engine v0.7.1-0.20240917171920-72bcdda3f0a5/go.mod h1:b1vuwkyMUszyUK+USUJqC8vJijnQsEPNDpC+sDdDLtM=
-github.com/argoproj/notifications-engine v0.4.1-0.20240606074338-0802cd427621 h1:Yg1nt+D2uDK1SL2jSlfukA4yc7db184TTN7iWy3voRE=
-github.com/argoproj/notifications-engine v0.4.1-0.20240606074338-0802cd427621/go.mod h1:N0A4sEws2soZjEpY4hgZpQS8mRIEw6otzwfkgc3g9uQ=
+github.com/argoproj/notifications-engine v0.4.1-0.20241005182503-22ccfe0caf45 h1:ry/oysT+kBvzLbLPhYAfaqhAtpRl/ONCuWnFZo1emIM=
+github.com/argoproj/notifications-engine v0.4.1-0.20241005182503-22ccfe0caf45/go.mod h1:N0A4sEws2soZjEpY4hgZpQS8mRIEw6otzwfkgc3g9uQ=
 github.com/argoproj/pkg v0.13.7-0.20230626144333-d56162821bd1 h1:qsHwwOJ21K2Ao0xPju1sNuqphyMnMYkyB3ZLoLtxWpo=
 github.com/argoproj/pkg v0.13.7-0.20230626144333-d56162821bd1/go.mod h1:CZHlkyAD1/+FbEn6cB2DQTj48IoLGvEYsWEvtzP3238=
 github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod h1:3U/XgcO3hCbHZ8TKRvWD2dDTCfh9M9ya+I9JpbB7O8o=