Add configuration documentation for Cloud AWS SNS (#16371)
--------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Joao Cardoso committed
Nov 9, 2023 at 17:40 UTC
93eec07f62a3783f61a82f92a4d12a590e82a200
1 file changed
+48
integrations/cloud-notifications/metadata.yaml
+48
@@ -279,6 +279,54 @@
279
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
280
- Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.
281
282
+- id: 'notify-cloud-awssns'
283
+ meta:
284
+ name: 'Amazon SNS'
285
+ link: 'https://aws.amazon.com/sns/'
286
+ categories:
287
+ - notify.cloud
288
+ icon_filename: 'awssns.png'
289
+ keywords:
290
+ - awssns
291
+ overview:
292
+ notification_description: "From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on AWS SNS."
293
+ notification_limitations: ''
294
+ setup:
295
+ description: |
296
+ ### Prerequisites
297
+
298
+ To add AWS SNS notification you need:
299
+
300
+ - A Netdata Cloud account
301
+ - Access to the space as an **administrator**
302
+ - Space needs to be on **Business** plan or higher
303
+ - Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
304
+
305
+ ### Steps
306
+
307
+ 1. Click on the **Space settings** cog (located above your profile icon)
308
+ 2. Click on the **Notification** tab
309
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
310
+ 4. On the **AwsSns** card click on **+ Add**
311
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
312
+ * **Notification settings** are Netdata specific settings
313
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
314
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
315
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
316
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For AWS SNS:
317
+ - Topic ARN - topic provided on AWS SNS (with region) for where to publish your notifications. For more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
318
+
319
+ ### Settings on AWS SNS
320
+
321
+ To enable the webhook integration on AWS SNS you need:
322
+ 1. [Setting up access for Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html)
323
+ 2. Create a topic
324
+ - On AWS SNS management console click on **Create topic**
325
+ - On the **Details** section, the standard type and provide the topic name
326
+ - On the **Access policy** section, change the **Publishers** option to **Only the specified AWS accounts** and provide the Netdata AWS account **(123269920060)** that will be used to publish notifications to the topic being created
327
+ - Finally, click on **Create topic** on the bottom of the page
328
+ 3. Now, use the new **Topic ARN** while adding AWS SNS integration on your space.
329
+
330
- id: 'notify-cloud-webhook'
331
meta:
332
name: 'Webhook'