feat: upgrade notification engine (argoproj#15359)

* Update notifications-engine dependencies Signed-off-by: Mike Splain <[email protected]> * Update docs Signed-off-by: Mike Splain <[email protected]> --------- Signed-off-by: Mike Splain <[email protected]> Co-authored-by: pasha-codefresh <[email protected]>
lukaszgyg · Jan 12, 2024 · 501d520 · 501d520
1 parent b2dff7d
commit 501d520
Show file tree

Hide file tree

Showing 8 changed files with 214 additions and 58 deletions.
diff --git a/docs/operator-manual/notifications/services/awssqs.md b/docs/operator-manual/notifications/services/awssqs.md
@@ -0,0 +1,106 @@
+# AWS SQS 
+
+## Parameters
+
+This notification service is capable of sending simple messages to AWS SQS queue. 
+
+* `queue` - name of the queue you are intending to send messages to. Can be overwriten with target destination annotation.
+* `region` - region of the sqs queue can be provided via env variable AWS_DEFAULT_REGION
+* `key` - optional, aws access key must be either referenced from a secret via variable or via env variable AWS_ACCESS_KEY_ID
+* `secret` - optional, aws access secret must be either referenced from a secret via variableor via env variable AWS_SECRET_ACCESS_KEY
+* `account` optional, external accountId of the queue
+* `endpointUrl` optional, useful for development with localstack
+
+## Example
+
+### Using Secret for credential retrieval:
+
+Resource Annotation:
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    notifications.argoproj.io/subscribe.on-deployment-ready.awssqs: "overwrite-myqueue"
+```
+
+* ConfigMap
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: <config-map-name>
+data:
+  service.awssqs: |
+    region: "us-east-2"
+    queue: "myqueue"
+    account: "1234567"
+    key: "$awsaccess_key"
+    secret: "$awsaccess_secret"
+
+  template.deployment-ready: |
+    message: |
+      Deployment {{.obj.metadata.name}} is ready!
+
+  trigger.on-deployment-ready: |
+    - when: any(obj.status.conditions, {.type == 'Available' && .status == 'True'})
+      send: [deployment-ready]
+    - oncePer: obj.metadata.annotations["generation"]
+
+```
+ Secret
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: <secret-name>
+stringData:
+  awsaccess_key: test
+  awsaccess_secret: test
+```
+
+
+### Minimal configuration using AWS Env variables
+
+Ensure following list of enviromental variable is injected via OIDC, or other method. And assuming SQS is local to the account.
+You may skip usage of secret for sensitive data and omit other parameters. (Setting parameters via ConfigMap takes precedent.)
+
+Variables:
+
+```bash
+export AWS_ACCESS_KEY_ID="test"
+export AWS_SECRET_ACCESS_KEY="test"
+export AWS_DEFAULT_REGION="us-east-1"
+```
+
+Resource Annotation:
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+  annotations:
+    notifications.argoproj.io/subscribe.on-deployment-ready.awssqs: ""
+```
+
+* ConfigMap
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: <config-map-name>
+data:
+  service.awssqs: |
+    queue: "myqueue"
+
+  template.deployment-ready: |
+    message: |
+      Deployment {{.obj.metadata.name}} is ready!
+
+  trigger.on-deployment-ready: |
+    - when: any(obj.status.conditions, {.type == 'Available' && .status == 'True'})
+      send: [deployment-ready]
+    - oncePer: obj.metadata.annotations["generation"]
+
+```
diff --git a/docs/operator-manual/notifications/services/github.md b/docs/operator-manual/notifications/services/github.md
@@ -75,8 +75,12 @@ template.app-deployed: |
       environmentURL: "https://{{.app.metadata.name}}.example.com"
       logURL: "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true"
       requiredContexts: []
+      autoMerge: true
 ```
 
 **Notes**:
 - If the message is set to 140 characters or more, it will be truncated.
 - If `github.repoURLPath` and `github.revisionPath` are same as above, they can be omitted.
+- Automerge is optional and `true` by default for github deployments to ensure the requested ref is up to date with the default branch.
+  Setting this option to `false` is required if you would like to deploy older refs in your default branch.
+  For more information see the [Github Deployment API Docs](https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#create-a-deployment).
diff --git a/docs/operator-manual/notifications/services/grafana.md b/docs/operator-manual/notifications/services/grafana.md
@@ -4,6 +4,12 @@ To be able to create Grafana annotation with argocd-notifications you have to cr
 
 ![sample](https://user-images.githubusercontent.com/18019529/112024976-0f106080-8b78-11eb-9658-7663305899be.png)
 
+Available parameters :
+
+* `apiURL` - the server url, e.g. https://grafana.example.com
+* `apiKey` - the API key for the serviceaccount
+* `insecureSkipVerify` - optional bool, true or false
+
 1. Login to your Grafana instance as `admin`
 2. On the left menu, go to Configuration / API Keys
 3. Click "Add API Key" 

diff --git a/docs/operator-manual/notifications/services/overview.md b/docs/operator-manual/notifications/services/overview.md
@@ -38,6 +38,7 @@ metadata:
 
 ## Service Types
 
+* [AwsSqs](./awssqs.md)
 * [Email](./email.md)
 * [GitHub](./github.md)
 * [Slack](./slack.md)

diff --git a/docs/operator-manual/notifications/services/slack.md b/docs/operator-manual/notifications/services/slack.md
@@ -29,56 +29,56 @@ The Slack notification service configuration includes following settings:
 1. Invite your slack bot to this channel **otherwise slack bot won't be able to deliver notifications to this channel**
 1. Store Oauth access token in `argocd-notifications-secret` secret
 
-```yaml
-  apiVersion: v1
-  kind: Secret
-  metadata:
-      name: <secret-name>
-  stringData:
-      slack-token: <Oauth-access-token>
-```
+    ```yaml
+      apiVersion: v1
+      kind: Secret
+      metadata:
+          name: <secret-name>
+      stringData:
+          slack-token: <Oauth-access-token>
+    ```
 
 1. Define service type slack in data section of `argocd-notifications-cm` configmap:
 
-```yaml
-  apiVersion: v1
-  kind: ConfigMap
-  metadata:
-    name: <config-map-name>
-  data:
-    service.slack: |
-      token: $slack-token
-```
+    ```yaml
+      apiVersion: v1
+      kind: ConfigMap
+      metadata:
+        name: <config-map-name>
+      data:
+        service.slack: |
+          token: $slack-token
+    ```
 
 1. Add annotation in application yaml file to enable notifications for specific argocd app.  The following example uses the [on-sync-succeeded trigger](../catalog.md#triggers):
 
-```yaml
-  apiVersion: argoproj.io/v1alpha1
-  kind: Application
-  metadata:
-    annotations:
-      notifications.argoproj.io/subscribe.on-sync-succeeded.slack: my_channel
-```
+    ```yaml
+      apiVersion: argoproj.io/v1alpha1
+      kind: Application
+      metadata:
+        annotations:
+          notifications.argoproj.io/subscribe.on-sync-succeeded.slack: my_channel
+    ```
 
 1. Annotation with more than one [trigger](../catalog.md#triggers), with multiple destinations and recipients
 
-```yaml
-  apiVersion: argoproj.io/v1alpha1
-  kind: Application
-  metadata:
-    annotations:
-      notifications.argoproj.io/subscriptions: |
-        - trigger: [on-scaling-replica-set, on-rollout-updated, on-rollout-step-completed]
-          destinations:
-            - service: slack
-              recipients: [my-channel-1, my-channel-2]
-            - service: email
-              recipients: [recipient-1, recipient-2, recipient-3 ]
-        - trigger: [on-rollout-aborted, on-analysis-run-failed, on-analysis-run-error]
-          destinations:
-            - service: slack
-              recipients: [my-channel-21, my-channel-22]
-```
+    ```yaml
+      apiVersion: argoproj.io/v1alpha1
+      kind: Application
+      metadata:
+        annotations:
+          notifications.argoproj.io/subscriptions: |
+            - trigger: [on-scaling-replica-set, on-rollout-updated, on-rollout-step-completed]
+              destinations:
+                - service: slack
+                  recipients: [my-channel-1, my-channel-2]
+                - service: email
+                  recipients: [recipient-1, recipient-2, recipient-3 ]
+            - trigger: [on-rollout-aborted, on-analysis-run-failed, on-analysis-run-error]
+              destinations:
+                - service: slack
+                  recipients: [my-channel-21, my-channel-22]
+    ```
 
 ## Templates
 

diff --git a/go.mod b/go.mod
@@ -12,7 +12,7 @@ require (
 	github.com/alicebob/miniredis/v2 v2.30.4
 	github.com/antonmedv/expr v1.12.7
 	github.com/argoproj/gitops-engine v0.7.1-0.20230809134534-ed7c77a9290b
-	github.com/argoproj/notifications-engine v0.4.1-0.20230620204159-3446d4ae8520
+	github.com/argoproj/notifications-engine v0.4.1-0.20230905144632-9dcecdc3eebf
 	github.com/argoproj/pkg v0.13.7-0.20230626144333-d56162821bd1
 	github.com/aws/aws-sdk-go v1.44.317
 	github.com/bmatcuk/doublestar/v4 v4.6.0
@@ -111,6 +111,19 @@ require (
 	github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.1.0 // indirect
 	github.com/Azure/azure-sdk-for-go/sdk/internal v1.0.0 // indirect
 	github.com/AzureAD/microsoft-authentication-library-for-go v0.5.2 // indirect
+	github.com/aws/aws-sdk-go-v2 v1.17.3 // indirect
+	github.com/aws/aws-sdk-go-v2/config v1.18.8 // indirect
+	github.com/aws/aws-sdk-go-v2/credentials v1.13.8 // indirect
+	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.12.21 // indirect
+	github.com/aws/aws-sdk-go-v2/internal/configsources v1.1.27 // indirect
+	github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.4.21 // indirect
+	github.com/aws/aws-sdk-go-v2/internal/ini v1.3.28 // indirect
+	github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.9.21 // indirect
+	github.com/aws/aws-sdk-go-v2/service/sqs v1.20.0 // indirect
+	github.com/aws/aws-sdk-go-v2/service/sso v1.12.0 // indirect
+	github.com/aws/aws-sdk-go-v2/service/ssooidc v1.14.0 // indirect
+	github.com/aws/aws-sdk-go-v2/service/sts v1.18.0 // indirect
+	github.com/aws/smithy-go v1.13.5 // indirect
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/kylelemons/godebug v1.1.0 // indirect
 	github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 // indirect
@@ -137,7 +150,7 @@ require (
 	github.com/MakeNowJust/heredoc v0.0.0-20170808103936-bb23615498cd // indirect
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Microsoft/go-winio v0.6.1 // indirect
-	github.com/PagerDuty/go-pagerduty v1.6.0 // indirect
+	github.com/PagerDuty/go-pagerduty v1.7.0 // indirect
 	github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95 // indirect
 	github.com/RocketChat/Rocket.Chat.Go.SDK v0.0.0-20210112200207-10ab4d695d60 // indirect
 	github.com/acomagu/bufpipe v1.0.4 // indirect
@@ -183,7 +196,7 @@ require (
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/gosimple/unidecode v1.0.1 // indirect
-	github.com/gregdel/pushover v1.1.0 // indirect
+	github.com/gregdel/pushover v1.2.1 // indirect
 	github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.11.3 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
@@ -231,8 +244,8 @@ require (
 	github.com/sergi/go-diff v1.1.0 // indirect
 	github.com/shopspring/decimal v1.2.0 // indirect
 	github.com/skeema/knownhosts v1.2.0 // indirect
-	github.com/slack-go/slack v0.12.1 // indirect
-	github.com/spf13/cast v1.5.0 // indirect
+	github.com/slack-go/slack v0.12.2 // indirect
+	github.com/spf13/cast v1.5.1 // indirect
 	github.com/stretchr/objx v0.5.0 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/vmihailenco/go-tinylfu v0.2.2 // indirect