summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoao Cardoso <car12o@users.noreply.github.com>2023-11-09 17:40:38 +0000
committerGitHub <noreply@github.com>2023-11-09 19:40:38 +0200
commit93eec07f62a3783f61a82f92a4d12a590e82a200 (patch)
tree105a499c682869389fd3ce1db8ae350a8a4ba6bc
parent7c2b74f32655687daccbdf548950cb5bc9170fbe (diff)
Add configuration documentation for Cloud AWS SNS (#16371)
--------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
-rw-r--r--integrations/cloud-notifications/metadata.yaml48
1 files changed, 48 insertions, 0 deletions
diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml
index 93acbdca9a..7a7c961dca 100644
--- a/integrations/cloud-notifications/metadata.yaml
+++ b/integrations/cloud-notifications/metadata.yaml
@@ -279,6 +279,54 @@
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
- Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.
+- id: 'notify-cloud-awssns'
+ meta:
+ name: 'Amazon SNS'
+ link: 'https://aws.amazon.com/sns/'
+ categories:
+ - notify.cloud
+ icon_filename: 'awssns.png'
+ keywords:
+ - awssns
+ overview:
+ 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."
+ notification_limitations: ''
+ setup:
+ description: |
+ ### Prerequisites
+
+ To add AWS SNS notification you need:
+
+ - A Netdata Cloud account
+ - Access to the space as an **administrator**
+ - Space needs to be on **Business** plan or higher
+ - Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
+
+ ### Steps
+
+ 1. Click on the **Space settings** cog (located above your profile icon)
+ 2. Click on the **Notification** tab
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
+ 4. On the **AwsSns** card click on **+ Add**
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
+ * **Notification settings** are Netdata specific settings
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
+ - 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
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For AWS SNS:
+ - 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)
+
+ ### Settings on AWS SNS
+
+ To enable the webhook integration on AWS SNS you need:
+ 1. [Setting up access for Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html)
+ 2. Create a topic
+ - On AWS SNS management console click on **Create topic**
+ - On the **Details** section, the standard type and provide the topic name
+ - 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
+ - Finally, click on **Create topic** on the bottom of the page
+ 3. Now, use the new **Topic ARN** while adding AWS SNS integration on your space.
+
- id: 'notify-cloud-webhook'
meta:
name: 'Webhook'