You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/user-guide/global-configurations/manage-notification.md
+180-43
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Manage Notification
1
+
# Manage Notifications
2
2
3
3
## Introduction
4
4
5
5
Monitoring updates of your CI/CD pipelines, such as their triggers, successes, and failures, can be tricky without a notification system in place.
6
6
7
-
The **Manage Notifications** feature in Devtron helps you solve this by sending updates about your pipelines through tools like Email, Slack, Discord, Microsoft Teams, and many more; thus ensuring you stay in the loop.
7
+
The **Notifications** feature in Devtron helps you solve this by sending updates about your pipelines through tools like Email, Slack, Discord, Microsoft Teams, and many more, thus ensuring you stay in the loop.
8
8
9
9
10
10
11
11
{% hint style="info" %}
12
12
### Prerequisite
13
-
OSS users should install **Notifications** integration available in [Devtron Stack Manager](../stack-manager.md).
13
+
OSS users should install the **Notifications** integration available in [Devtron Stack Manager](../stack-manager.md).
14
14
{% endhint %}
15
15
16
16
Go to **Global Configurations** → **Notifications** to access this feature in Devtron. As shown below, there are 2 tabs available for you to manage your notification settings:
@@ -26,6 +26,8 @@ Go to **Global Configurations** → **Notifications** to access this feature in
26
26
Only superadmins can manage configurations.
27
27
{% endhint %}
28
28
29
+
This section allows you to perform the configurations required for your notifications to work. Make sure you finish this step before [creating a notification](#create-notifications).
Here you can add and manage the following configurations:
@@ -36,15 +38,15 @@ Here you can add and manage the following configurations:
36
38
37
39
{% hint style="info" %}
38
40
### Tip
39
-
At any point of time, you have the option to edit or delete an existing configuration, or add more as per your requirements.
41
+
At any point in time, you have the option to edit or delete an existing configuration or add more as per your requirements.
40
42
{% endhint %}
41
43
42
44
### SES Configuration
43
45
44
46
{% hint style="info" %}
45
47
### Prerequisites
46
-
*[Generate SMTP Credentials from AWS SES](https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html) - To get the user ID and secret.
47
-
*[Verify Email Identities in AWS SES](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure) - This is to verify the email of the sender email address (e.g., *michael.devtron.ai*) you wish to use for sending email notifications.
48
+
*[Generate SMTP Credentials from AWS SES](https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html) - To get the user access key and secret key.
49
+
*[Verify Email Identities in AWS SES](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure) - This is to verify the sender's email address (e.g., *michael@devtron.ai*) you wish to use for sending email notifications.
48
50
{% endhint %}
49
51
50
52
You can use Amazon Simple Email Service (SES) to send email notifications to the recipients.
@@ -53,13 +55,13 @@ You can use Amazon Simple Email Service (SES) to send email notifications to the
53
55
54
56
2. Enter the following details in the **Configure SES** window:
55
57
56
-
| Key | Description |
57
-
| --- | ----------- |
58
-
|**Configuration Name**| Give a name to your SES Configuration, e.g., `Email SES 2024`|
59
-
|**Access Key ID**| Valid user ID from your AWS SMTP Settings page, e.g., `AKIAWEAVHF123ABCD123`|
60
-
|**Secret Access Key**| Password from your AWS SMTP Settings page |
61
-
|**AWS Region**| The AWS Region you used while setting up SES |
62
-
|**Send email from**| The sender email address verified by SES for sending emails |
58
+
| Key | Description |
59
+
| --- | ----------- |
60
+
|**Configuration Name**| Give a name to your SES Configuration, e.g., `Email SES 2024`|
61
+
|**Access Key ID**| Valid user ID from your AWS SMTP Settings page, e.g., `AKIAWEAVHF123ABCD123`|
62
+
|**Secret Access Key**| Password from your AWS SMTP Settings page |
63
+
|**AWS Region**| The AWS Region you used while setting up SES |
64
+
|**Send email from**| The sender email address verified by SES for sending emails |
63
65
64
66
SMTP Credentials from your SMTP Provider. If you are using AWS SMTP, make sure to [verify domain identities](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure) to verify the domain (e.g., *devtron.ai*) of the sender email address you wish to use for sending emails notifications.
82
+
SMTP Credentials from your SMTP Provider. If you are using AWS SMTP, make sure to [verify domain identities](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure) to verify the domain (e.g., *devtron.ai*) of the sender email address you wish to use for sending email notifications.
81
83
{% endhint %}
82
84
83
85
You can use any SMTP provider (e.g., Gmail SMTP, AWS) to send email notifications to the recipients.
@@ -86,14 +88,14 @@ You can use any SMTP provider (e.g., Gmail SMTP, AWS) to send email notification
86
88
87
89
2. Enter the following details in the **Configure SMTP** window:
88
90
89
-
| Key | Description |
90
-
| :--- | :--- |
91
-
|**Configuration Name**| Give a name to your SMTP Configuration, e.g., `Email SMTP 2024`|
92
-
|**SMTP Host**| The SMTP endpoint available in your SMTP settings, e.g., `email-smtp.ap-south-1.amazonaws.com`|
93
-
|**SMTP Port**| The port number available in your SMTP settings, e.g., `587`|
94
-
|**SMTP Username**| A valid username created with your SMTP provider, e.g., `AKIAWEAVHF123ABCD123`|
95
-
|**SMTP Password**| The password generated by your SMTP provider |
96
-
|**Send email from**| The sender email address verified by your SMTP provider for sending emails |
91
+
| Key | Description |
92
+
| :--- | :--- |
93
+
|**Configuration Name**| Give a name to your SMTP Configuration, e.g., `Email SMTP 2024`|
94
+
|**SMTP Host**| The SMTP endpoint available in your SMTP settings, e.g., `email-smtp.ap-south-1.amazonaws.com`|
95
+
|**SMTP Port**| The port number available in your SMTP settings, e.g., `587`|
96
+
|**SMTP Username**| A valid username created with your SMTP provider, e.g., `AKIAWEAVHF123ABCD123`|
97
+
|**SMTP Password**| The password generated by your SMTP provider |
98
+
|**Send email from**| The sender email address verified by your SMTP provider for sending emails |
@@ -147,16 +149,18 @@ A Webhook URL for receiving notifications (e.g., Microsoft Teams Webhook URL, Di
147
149
148
150
2. Enter the following details in the **Configure Webhook** window:
149
151
150
-
| Key | Description |
151
-
| :--- | :--- |
152
-
|**Configuration name**|Name of the Slack channel on which you wish to receive notifications|
153
-
|**Webhook URL**| Enter a valid Webhook URL link |
154
-
|**Headers**| Add optional key-value pairs, e.g. `Content-Type: application/json`|
155
-
|**Data**| Write the payload content of the notification in a JSON format <br /> `{ "content": "Automation Notification for Devtron \n App : {{devtronAppName}} \n Event Type : {{eventType}}" }`|
152
+
| Key | Description |
153
+
| :--- | :--- |
154
+
|**Configuration name**|Give a name to your webhook configuration|
155
+
|**Webhook URL**| Enter a valid Webhook URL link |
156
+
|**Headers**| Add optional key-value pairs, e.g. `Content-Type: application/json`|
157
+
|**Data**| Write the payload content of the notification in a JSON format. <br /> Refer: <ul><li>[Microsoft Teams Payload](#for-microsoft-teams)</li><li>[Discord Payload](#for-discord)</li><li>[Slack Payload](#for-slack)</li><li>[RingCentral Payload](#for-ringcentral)</li></ul>|
@@ -205,15 +209,15 @@ You can add more than one recipient as per your requirement.
205
209
You will see a list of CI/CD pipelines corresponding to your selected filter type.
206
210
* <span><imgsrc="https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/manage-notification/ci1.jpg"alt="CI Icon"></span> indicates that it is a CI (Build) pipeline.
207
211
* <span><imgsrc="https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/manage-notification/cd1.jpg"alt="CD Icon"></span> indicates that it is a CD (Deployment) pipeline.
208
-
* You can also choose to receive notifications for any CI or CD pipeline that do not exist currently but may exist in future.
212
+
* You can also choose to receive notifications for any CI or CD pipelines that do not exist currently but may exist in future.
209
213
{% endhint %}
210
214
211
215
4. For each pipeline, there are individual checkboxes for 3 types of events:
212
216
***Trigger** - Use this if you wish to receive notification whenever the pipeline is triggered.
213
217
***Success** - Use this if you wish to receive notification upon a successful build or deploy.
214
218
***Failure** - Use this if you wish to receive notification upon a failed build or deploy.
215
219
216
-
Click the checkbox relevant to you for receiving notifications. You can choose more than one as per your requirement.
220
+
Click the checkbox relevant to you to receive notifications. You can choose more than one as per your requirements.
@@ -226,13 +230,13 @@ Build and Deploy your application to get notifications of its CI/CD events.
226
230
227
231
### Edit Notifications
228
232
229
-
You can use the checkbox besides the notifications to edit themone-by-one or in bulk.
233
+
You can use the checkbox beside the notifications to edit them. You may delete the notification, modify its event, or change its recipients. Moreover, you can do it one by one or in bulk.
0 commit comments