Mattermost cloud integration docs (#15141)
* feat: add mattermost integration docs * fix: typo
Joao Cardoso committed
Jun 6, 2023 at 09:47 UTC
f775ee563d1641276f4eb99d6e2e7d3216ca9267
7 files changed
+66
-15
docs/cloud/alerts-notifications/add-discord-notification.md
+1
-1
@@ -8,7 +8,7 @@ To enable Discord notifications you need:
8
9
- A Netdata Cloud account
10
- Access to the space as an **administrator**
11
-- Have a Discord server able to receive webhook integrations. For mode details check [how to configure this on Discord](#settings-on-discord)
11
+- Have a Discord server able to receive webhook integrations. For more details check [how to configure this on Discord](#settings-on-discord)
12
13
## Steps
14
docs/cloud/alerts-notifications/add-mattermost-notification-configuration.md
new
+51
@@ -0,0 +1,51 @@
1
+# Add Mattermost notification configuration
2
+
3
+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 Mattermost.
4
+
5
+## Prerequisites
6
+
7
+To add Mattermost notification configurations you need:
8
+
9
+- A Netdata Cloud account
10
+- Access to the space as an **administrator**
11
+- Space needs to be on **Business** plan or higher
12
+- Have a Mattermost app on your workspace to receive the webhooks, for more details check [how to configure this on Mattermost](#settings-on-mattermost)
13
+
14
+## Steps
15
+
16
+1. Click on the **Space settings** cog (located above your profile icon)
17
+1. Click on the **Notification** tab
18
+1. Click on the **+ Add configuration** button (near the top-right corner of your screen)
19
+1. On the **Mattermost** card click on **+ Add**
20
+1. A modal will be presented to you to enter the required details to enable the configuration:
21
+ 1. **Notification settings** are Netdata specific settings
22
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
23
+ - 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
24
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
25
+ 1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:
26
+ - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications. For more details check [how to configure this on Mattermost](#settings-on-mattermost)
27
+
28
+## Settings on Mattermost
29
+
30
+To enable the webhook integrations on Mattermost you need:
31
+1. In Mattermost, go to Product menu > Integrations > Incoming Webhook.
32
+
33
+
34
+
35
+ - If you don’t have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below
36
+
37
+
38
+
39
+2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters
40
+
41
+3. Select the channel to receive webhook payloads, then select Add to create the webhook
42
+
43
+
44
+
45
+4. You will end up with a webhook endpoint that looks like so:
46
+```
47
+https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx
48
+```
49
+ - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance.
50
+
51
+For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
docs/cloud/alerts-notifications/add-opsgenie-notification-configuration.md
+2
-2
@@ -4,7 +4,7 @@ From the Cloud interface, you can manage your space's notification settings and
4
5
## Prerequisites
6
7
-To add Opsgenie notification configurations you need
7
+To add Opsgenie notification configurations you need:
8
9
- A Netdata Cloud account
10
- Access to the space as an **administrator**
@@ -34,4 +34,4 @@ To enable the Netdata integration on Opsgenie you need:
34
35
1. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.
36
37
-1. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.
\ No newline at end of file
37
+1. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.
docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md
+2
-2
@@ -4,12 +4,12 @@ From the Cloud interface, you can manage your space's notification settings and
4
5
## Prerequisites
6
7
-To add PagerDuty notification configurations you need
7
+To add PagerDuty notification configurations you need:
8
9
- A Cloud account
10
- Access to the space as and **administrator**
11
- Space needs to be on **Business** plan or higher
12
-- Have a PagerDuty service to receive events, for mode details check [how to configure this on PagerDuty](#settings-on-pagerduty)
12
+- Have a PagerDuty service to receive events, for more details check [how to configure this on PagerDuty](#settings-on-pagerduty)
13
14
## Steps
15
docs/cloud/alerts-notifications/add-slack-notification-configuration.md
+3
-3
@@ -4,12 +4,12 @@ From the Cloud interface, you can manage your space's notification settings and
4
5
## Prerequisites
6
7
-To add discord notification configurations you need
7
+To add slack notification configurations you need:
8
9
- A Netdata Cloud account
10
- Access to the space as an **administrator**
11
- Space needs to be on **Business** plan or higher
12
-- Have a Slack app on your workspace to receive the webhooks, for mode details check [how to configure this on Slack](#settings-on-slack)
12
+- Have a Slack app on your workspace to receive the webhooks, for more details check [how to configure this on Slack](#settings-on-slack)
13
14
## Steps
15
@@ -34,7 +34,7 @@ To enable the webhook integrations on Slack you need:
34
- On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
35
36
37
-
37
+
38
- At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
39
- After pressing that specify the channel where you want your notifications to be delivered
40
docs/cloud/alerts-notifications/add-webhook-notification-configuration.md
+5
-5
@@ -4,12 +4,12 @@ From the Cloud interface, you can manage your space's notification settings and
4
5
## Prerequisites
6
7
-To add discord notification configurations you need
7
+To add webhook notification configurations you need:
8
9
- A Netdata Cloud account
10
- Access to the space as an **administrator**
11
- Space needs to be on **Pro** plan or higher
12
-- Have an app that allows you to receive webhooks following a predefined schema, for mode details check [how to create the webhook service](#webhook-service)
12
+- Have an app that allows you to receive webhooks following a predefined schema, for more details check [how to create the webhook service](#webhook-service)
13
14
## Steps
15
@@ -24,8 +24,8 @@ To add discord notification configurations you need
24
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
25
1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For webhook:
26
- Webhook URL - webhook URL is the url of the service that Netdata will send notifications to. In order to keep the communication secured, we only accept HTTPS urls. Check [how to create the webhook service](#webhook-service).
27
- - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL. For mode details check [Extra headers](#extra-headers)
28
- - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms. For mode details check [Authentication mechanisms](#authentication-mechanisms):
27
+ - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL. For more details check [Extra headers](#extra-headers)
28
+ - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms. For more details check [Authentication mechanisms](#authentication-mechanisms):
29
- Mutual TLS (recommended) - default authentication mechanism used if no other method is selected.
30
- Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.
31
- Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.
@@ -134,7 +134,7 @@ nsjoQAm6OwpTN5362vE9SYu1twz7KdzBlUkDhePEOgQkWfLHBJWwB+PvB1j/cUA3
134
```bash
135
server {
136
listen 443 ssl default_server;
137
-
137
+
138
# ... existing SSL configuration for server authentication ...
139
ssl_verify_client on;
140
ssl_client_certificate /path/to/Netdata_CA.pem;
docs/cloud/manage/plans.md
+2
-2
@@ -101,13 +101,13 @@ The plan on your space will determine what type of notifications methods will be
101
* **Pro** - Email, Discord and webhook
102
* **Business** - Unlimited, this includes Slack, PagerDuty, Opsgenie etc.
103
104
-For mode details check the documentation under [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#alert-notifications).
104
+For more details check the documentation under [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#alert-notifications).
105
106
##### Alert notification silencing rules
107
108
The plan on your space will determine if you are able to add alert notification silencing rules since this feature will only be available for paid plans: **Pro** or **Business**.
109
110
-For mode details check the documentation under [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#silencing-alert-notifications).
110
+For more details check the documentation under [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#silencing-alert-notifications).
111
112
### Related Topics
113