From 514312200a013dc4951879a109f2a26d2c07bfd9 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Wed, 9 Oct 2024 08:20:35 +0530 Subject: [PATCH 01/10] Cloud Service - Expanding notifications Addresses [DOCS-740](https://enterprisedb.atlassian.net/browse/DOCS-740) --- .../console/using/notifications.mdx | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index cf270341853..d63ba2ff1d8 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -6,9 +6,12 @@ redirects: - /biganimal/latest/administering_cluster/notifications/ #generated for BigAnimal URL path removal branch --- -With EDB Postgres AI, you can opt to get specific types of notifications and receive both in-app and email notifications. +With EDB Postgres AI, you can customize the types of notifications you want to receive. There are two types of notifications: -Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications in the in-app inbox, by email, or both. +- User notifications +- System notifications + +Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications. The notifications are categorized into the following preference sections: - Account - Organizations @@ -44,12 +47,24 @@ The notifications under the **Projects** preference section are: ## Configuring notifications -The project owners/editors and organization owners/admins can configure the notifications for the events visible to them. They can choose if they want to receive notifications in the in-app inbox, by email, or both. They can also configure email notifications for their teams in their organization. +The project owners/editors and organization owners/admins can configure the notifications for the events visible to them. They can choose if they want to receive notifications in the in-app inbox, by email, by webhook, by slack or all. They can also configure email notifications for their teams in their organization. Project-level notifications are configured in the project. Notification settings made by a user apply only to that user. If an email notification is enabled, the email is sent to the email address associated with the user's login. +### Configure Webhook notifications + +To configure Webhook notification: +1. Log in to the EDB Postgres AI console. +1. From the menu under your name in the top-right panel, select **My Account**. +1. Select the **Notifications** tab. Notifications are grouped by account, organizations, and projects available to you. +1. Scroll to the Account, Organization or Project section to view the events you wish to manage. +1. Select the right arrow next to the entity to expand the list of events. +1. For each notification you can: + - Opt out or in to receiving the notification for a particular event by using the **Opted-In** toggle. + - Customize the email and in-app notifications for the event by selecting the **Customize Delivery Channel** checkbox and then toggling the displayed **Email** and **Inbox** buttons. + ## Viewing notifications Users in the following roles can view the notifications: From 8ec8193bb43adeffc8c68ac7c6cc0e57fa42b3ec Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 14 Oct 2024 18:13:56 +0530 Subject: [PATCH 02/10] Added more content --- .../console/using/notifications.mdx | 88 +++++++++++++++---- 1 file changed, 70 insertions(+), 18 deletions(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index d63ba2ff1d8..926411056c7 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -4,18 +4,20 @@ navTitle: Notifications description: "Use notifications to get an alert for the different types of events occurring in your EDB Postgres AI account, organizations, and projects." redirects: - /biganimal/latest/administering_cluster/notifications/ #generated for BigAnimal URL path removal branch +deepToC: true +indexdepth: 3 --- -With EDB Postgres AI, you can customize the types of notifications you want to receive. There are two types of notifications: +With EDB Postgres AI, you can customize the types of notifications you want to receive. There are two types of notifications channels: -- User notifications -- System notifications +- User notifications channels - where you can receive notifications on email or in-app inbox or both. +- System notifications channels - where you can receive notifications on slack or webhook or pagerduty or all. Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications. The notifications are categorized into the following preference sections: -- Account -- Organizations -- Projects +- **Account** - only for user notification channels +- **Organizations** - for user and system notification channels both +- **Projects** - for user and system notification channels both The notifications under the **Account** preference section are: @@ -47,23 +49,73 @@ The notifications under the **Projects** preference section are: ## Configuring notifications -The project owners/editors and organization owners/admins can configure the notifications for the events visible to them. They can choose if they want to receive notifications in the in-app inbox, by email, by webhook, by slack or all. They can also configure email notifications for their teams in their organization. - -Project-level notifications are configured in the project. +The project owners/editors and organization owners/admins can enable/disable the notifications for the events visible to them. They can choose if they want to receive notifications in the in-app inbox, by email or both. Notification settings made by a user apply only to that user. If an email notification is enabled, the email is sent to the email address associated with the user's login. -### Configure Webhook notifications +System notification channels can be configured at Organization-level by organization owner or at Project-level by project owner. By default, the Organization-level system notifications channel are inherited by each project of that organization. However you can enable/disable or re-configure the system notifications channel at the Project-level to override the default settings. + +This steps shows how to configure the system notification channels at Organization-level: + +### Configure Slack notification channel -To configure Webhook notification: +To configure Slack notification channel: 1. Log in to the EDB Postgres AI console. -1. From the menu under your name in the top-right panel, select **My Account**. -1. Select the **Notifications** tab. Notifications are grouped by account, organizations, and projects available to you. -1. Scroll to the Account, Organization or Project section to view the events you wish to manage. -1. Select the right arrow next to the entity to expand the list of events. -1. For each notification you can: - - Opt out or in to receiving the notification for a particular event by using the **Opted-In** toggle. - - Customize the email and in-app notifications for the event by selecting the **Customize Delivery Channel** checkbox and then toggling the displayed **Email** and **Inbox** buttons. +1. From the menu under your name in the top-right panel, select **Settings**. +1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. +1. Select **Slack** and a window pops-up, provide the following details: + 1. Slack bot access token. + 1. Slack channel on which notification are to be sent. For example: #general, #alerts, #notifications, etc. + 1. Select **Save** button + +!!!note +Before configuring slack notification channel, you need to create the slack app and grant the following permissions: +- `chat:write` +- `im:write` +- `users:read.email` +- `users:read` +Once the slack app is created and installed on the slack workspace, you can use the slack bot user oauth token of slack app to setup the slack channel. +!!! + + +### Configure Webhook notification channel + +To configure Webhook notification channel: +1. Log in to the EDB Postgres AI console. +1. From the menu under your name in the top-right panel, select **Settings**. +1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. +1. Select **Webhook** and provide the details on the pop-up window: + 1. Host URL of the Webhook + 1. Optionally provide any of these authentication parameters: + 1. Username and password + 1. Bearer token + 1. Optionally provide Http headers + 1. Select **Save** button. + +### Configure Pagerduty notification channel + +To configure Pagerduty notification channel: +1. Log in to the EDB Postgres AI console. +1. From the menu under your name in the top-right panel, select **Settings**. +1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. +1. Select **Pagerduty** and provide the details on the pop-up window: + 1. Set routing key(integration key). + 2. Select **Save** button. + +!!!note +Before configuring Pagerduty notification channel: +- You need to have access to a Pagerduty account with elevated privileges. +- Pagerduty Service created and configured with Events API v2 integration. +- In your PagerDuty account, navigate to the desired Service and access its "Integrations" settings. +- Add a new "Events API v2" integration and configure it according to your requirements. +- Copy the Integration Key(routing key) provided by PagerDuty for the newly created integration. +!!! + +To configure the system notifications channel at Project-level: +- Go to **Project Overview** page +- Select **Settings** on the left-side menu +- Select **Notifications** +- Follow the steps as mentioned above for Organization-level for each of the system notification channel. ## Viewing notifications From dbd3b452872b6c823f5236e7cb0f64ecac83e192 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 14 Oct 2024 18:16:05 +0530 Subject: [PATCH 03/10] Minor format fixing --- advocacy_docs/edb-postgres-ai/console/using/notifications.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index 926411056c7..fdcc4677cf7 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -60,6 +60,7 @@ This steps shows how to configure the system notification channels at Organizati ### Configure Slack notification channel To configure Slack notification channel: + 1. Log in to the EDB Postgres AI console. 1. From the menu under your name in the top-right panel, select **Settings**. 1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. @@ -81,6 +82,7 @@ Once the slack app is created and installed on the slack workspace, you can use ### Configure Webhook notification channel To configure Webhook notification channel: + 1. Log in to the EDB Postgres AI console. 1. From the menu under your name in the top-right panel, select **Settings**. 1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. @@ -95,6 +97,7 @@ To configure Webhook notification channel: ### Configure Pagerduty notification channel To configure Pagerduty notification channel: + 1. Log in to the EDB Postgres AI console. 1. From the menu under your name in the top-right panel, select **Settings**. 1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. From e4a1665ecc4d6c9f07436f57aa36a5eb6bb4538c Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Fri, 18 Oct 2024 11:04:29 +0530 Subject: [PATCH 04/10] Update advocacy_docs/edb-postgres-ai/console/using/notifications.mdx Co-authored-by: Nagesh Dhope --- .../edb-postgres-ai/console/using/notifications.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index fdcc4677cf7..c9d48e791cf 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -75,7 +75,10 @@ Before configuring slack notification channel, you need to create the slack app - `im:write` - `users:read.email` - `users:read` -Once the slack app is created and installed on the slack workspace, you can use the slack bot user oauth token of slack app to setup the slack channel. + +Once the slack app is created and installed on the slack workspace, you can use the slack bot user OAuth token of the slack app to setup the slack channel. + +Also make sure to add the created slack app to the slack channel of your choice. !!! From 27d342eba38b4392d13226752f279876b39da247 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Fri, 18 Oct 2024 11:04:48 +0530 Subject: [PATCH 05/10] Update advocacy_docs/edb-postgres-ai/console/using/notifications.mdx Co-authored-by: Nagesh Dhope --- advocacy_docs/edb-postgres-ai/console/using/notifications.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index c9d48e791cf..9f06c4cf2ce 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -91,6 +91,7 @@ To configure Webhook notification channel: 1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. 1. Select **Webhook** and provide the details on the pop-up window: 1. Host URL of the Webhook + 1. HTTP Method of the Webhook 1. Optionally provide any of these authentication parameters: 1. Username and password 1. Bearer token From d29be8723b0abcd16f7c05ed701b11a256fb4dcd Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Fri, 18 Oct 2024 12:30:45 +0530 Subject: [PATCH 06/10] Added content as per suggestion from Amine --- advocacy_docs/edb-postgres-ai/console/using/notifications.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index 9f06c4cf2ce..f39c80e6046 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -10,8 +10,8 @@ indexdepth: 3 With EDB Postgres AI, you can customize the types of notifications you want to receive. There are two types of notifications channels: -- User notifications channels - where you can receive notifications on email or in-app inbox or both. -- System notifications channels - where you can receive notifications on slack or webhook or pagerduty or all. +- User notifications channels - where you can receive notifications on email or in-app inbox or both. These notifications alerts all users who have enabled them and are eligible to receive the notifications for that event. +- System notifications channels - where you can receive notifications on slack or webhook or pagerduty or all. These notifications are designed to trigger once per event, primarily for automating tasks within the user's organization. Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications. The notifications are categorized into the following preference sections: From ddce2e8e79e7df47ec2bc5ecb04c0904f77c5067 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Wed, 30 Oct 2024 17:53:02 +0530 Subject: [PATCH 07/10] Made changes as to reflect the UI changes --- .../console/using/notifications.mdx | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index f39c80e6046..4534246640e 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -63,10 +63,10 @@ To configure Slack notification channel: 1. Log in to the EDB Postgres AI console. 1. From the menu under your name in the top-right panel, select **Settings**. -1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. +1. Select the **Notifications** tab. Options available are Webhook, Slack, and Pager Duty. 1. Select **Slack** and a window pops-up, provide the following details: - 1. Slack bot access token. - 1. Slack channel on which notification are to be sent. For example: #general, #alerts, #notifications, etc. + 1. Access token - provide a slack bot access token. + 1. Slack Channel on which notification are to be sent. For example: #general, #alerts, #notifications, etc. 1. Select **Save** button !!!note @@ -88,31 +88,33 @@ To configure Webhook notification channel: 1. Log in to the EDB Postgres AI console. 1. From the menu under your name in the top-right panel, select **Settings**. -1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. +1. Select the **Notifications** tab. Options available are Webhook, Slack, and Pager Duty. 1. Select **Webhook** and provide the details on the pop-up window: 1. Host URL of the Webhook - 1. HTTP Method of the Webhook - 1. Optionally provide any of these authentication parameters: - 1. Username and password - 1. Bearer token - 1. Optionally provide Http headers + 1. Method of the Webhook - POST or PUT + 1. Optionally provide any of these authentication parameters + a. For Basic Auth: + 1. Username and password + 1. Bearer token + a. For Bearer Token: + 1. Bearer Token 1. Select **Save** button. -### Configure Pagerduty notification channel +### Configure Pager Duty notification channel -To configure Pagerduty notification channel: +To configure Pager Duty notification channel: 1. Log in to the EDB Postgres AI console. 1. From the menu under your name in the top-right panel, select **Settings**. -1. Select the **Notifications** tab. Options available are Slack, Webhook, and Pagerduty. -1. Select **Pagerduty** and provide the details on the pop-up window: - 1. Set routing key(integration key). +1. Select the **Notifications** tab. Options available are Webhook, Slack, and Pager Duty. +1. Select **Pager Duty** and provide the details on the pop-up window: + 1. Set Routing Key(integration key). 2. Select **Save** button. !!!note -Before configuring Pagerduty notification channel: -- You need to have access to a Pagerduty account with elevated privileges. -- Pagerduty Service created and configured with Events API v2 integration. +Before configuring Pager Duty notification channel: +- You need to have access to a Pager Duty account with elevated privileges. +- Pager Duty Service created and configured with Events API v2 integration. - In your PagerDuty account, navigate to the desired Service and access its "Integrations" settings. - Add a new "Events API v2" integration and configure it according to your requirements. - Copy the Integration Key(routing key) provided by PagerDuty for the newly created integration. From 67fd9ae68b02e9c1e3bc1160cfd81969607f4887 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 4 Nov 2024 12:42:42 +0530 Subject: [PATCH 08/10] Update advocacy_docs/edb-postgres-ai/console/using/notifications.mdx Co-authored-by: Nagesh Dhope --- advocacy_docs/edb-postgres-ai/console/using/notifications.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index 4534246640e..2967063e275 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -95,7 +95,8 @@ To configure Webhook notification channel: 1. Optionally provide any of these authentication parameters a. For Basic Auth: 1. Username and password - 1. Bearer token + 1. Username + 1. Password a. For Bearer Token: 1. Bearer Token 1. Select **Save** button. From cf30131cfec2098e441e36ae32b4ae15336141df Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 4 Nov 2024 14:13:58 +0530 Subject: [PATCH 09/10] minor edits --- .../edb-postgres-ai/console/using/notifications.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index 2967063e275..561fc5c6cf0 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -93,13 +93,12 @@ To configure Webhook notification channel: 1. Host URL of the Webhook 1. Method of the Webhook - POST or PUT 1. Optionally provide any of these authentication parameters - a. For Basic Auth: - 1. Username and password + 1. For Basic Auth: 1. Username - 1. Password - a. For Bearer Token: + 2. Password + 2. For Bearer Token: 1. Bearer Token - 1. Select **Save** button. + 2. Select **Save** button. ### Configure Pager Duty notification channel From 8f6764438b1c5e8793e2afc958f41b2cbe50a2c8 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 5 Nov 2024 11:39:19 +0530 Subject: [PATCH 10/10] minor edit as per suggestion from Nagesh --- advocacy_docs/edb-postgres-ai/console/using/notifications.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx index 561fc5c6cf0..a2176ea8bb4 100644 --- a/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx +++ b/advocacy_docs/edb-postgres-ai/console/using/notifications.mdx @@ -10,7 +10,7 @@ indexdepth: 3 With EDB Postgres AI, you can customize the types of notifications you want to receive. There are two types of notifications channels: -- User notifications channels - where you can receive notifications on email or in-app inbox or both. These notifications alerts all users who have enabled them and are eligible to receive the notifications for that event. +- User notifications channels - where you can receive notifications on email or in-app inbox or both. These notifications are for all users who have enabled them and are eligible to receive the notifications for that event. - System notifications channels - where you can receive notifications on slack or webhook or pagerduty or all. These notifications are designed to trigger once per event, primarily for automating tasks within the user's organization. Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications.