From 638ba9dbc3e13c3a714c96e8ad3edf4a3459a7f2 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 22 Apr 2024 15:46:11 +0530 Subject: [PATCH 1/6] BigAnimal - Notifications update --- .../administering_cluster/notifications.mdx | 60 +++++++++++-------- 1 file changed, 36 insertions(+), 24 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx index 83f12f9744f..51f9903d9cd 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx @@ -1,32 +1,44 @@ --- title: Notifications +description: "Use notifications to get an alert for the different types of events" --- With BigAnimal, you can opt to get specific types of notifications and receive both in-app and email notifications. -Different types of events are sent as notifications. These notifications are set at different levels, and users with different roles can configure these notifications. This table provides the list of events sent as notifications grouped by the levels at which they can be set. - -| Level | Event | Role | Subscription type | -|--------------|--------------------------------------------------------------------------------------------------|----------------------------------|--------------------- | -| Organization | Payment method added | Organization owner/admin | Digital self-service | -| Organization | Personal access key is expiring | Account owner | All | -| Organization | Machine user access key is expiring | Organization owner | All | -| Project | Upcoming maintenance upgrade on a cluster in 24 hours | Project owner/editor | All | -| Project | Successful maintenance upgrade on a cluster | Project owner/editor | All | -| Project | Failed maintenance upgrade on a cluster | Project owner/editor | All | -| Project | Paused cluster will automatically reactivate in 24 hours | Project owner/editor | All | -| Project | Paused cluster was automatically reactivated | Project owner/editor | All | -| Project | You must set up the encryption key permission for your CMK-enabled cluster | Project owner/editor | All | -| Project | Key error with CMK-enabled cluster | Project owner and project editor | All | -| Project | User is invited to a project (displays only to the Project owner) | Project owner | All | -| Project | New role is assigned to you | Account owner | All | -| Project | Role is unassigned from you | Account owner | All | -| Project | Failed connection to third-party monitoring integration (and future non-monitoring integrations) | Project owner/editor | All | +Different types of events are sent as notifications. Users with different roles can configure these notifications. +The notifications are categorized into following preference sections: +- Account +- Organizations +- Projects + +The notifications under **Account** preference section: + +- Role unassigned from you +- Access key is about to expire +- New role assigned to you + +The notifications under **Organizations** preference section: + +- Payment method added +- Machine user API key is expiring !!!note -Under "Subscription type," "All" means digital self-service, direct purchase, and Azure Marketplace. For more information, see [subscription types](/biganimal/latest/pricing_and_billing/#payments-and-billing). +This section is visible only to the organization owner/admin. !!! +The notifications under **Projects** preference section: + +- Paused cluster reactivated +- Upcoming cluster maintenance upgrade +- CMK error +- User invited to project +- Successful cluster maintenance upgrade +- Failed cluster maintenance upgrade +- Paused cluster will reactivate +- User encryption key permission for cluster +- Failed third-party monitoring integration + + ## 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. @@ -38,9 +50,9 @@ Notification settings made by a user apply only to that user. If an email notifi ## Viewing notifications Users in the following roles can view the notifications: -- Organization owners/admins can view the organization-level notifications. -- Project owners/editors can view the project-level notifications. -- Account owners can view their own account-level notifications. +- Organization owners/admins can view the organization notifications. +- Project owners/editors can view the project notifications. +- User can view their own account notifications. Each notification indicates the level and project it belongs to for the user having multiple roles in BigAnimal. @@ -53,7 +65,7 @@ To view the email notifications, check the inbox of your configured email addres To manage the notifications: 1. Log in to the BigAnimal portal. 1. From the menu under your name in the top-right panel, select **My Account**. -1. Select the **Notifications** tab. Notifications are grouped by organizations and projects available to you. -1. Select any specific organization/project to manage the notifications. +1. Select the **Notifications** tab. Notifications are grouped by account, organizations, and projects available to you. +1. Select account, organization, or project to manage the notifications. - Enable/disable the notification for a particular event using the toggle. - Select **Email** and **Inbox** next to an event to enable/disable the email and in-app notifications for the event. From 49b36051d9af354271b2eccd7f8e3ad227107686 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:12:39 +0530 Subject: [PATCH 2/6] Updated content as per review comments from Guang --- .../administering_cluster/notifications.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx index 51f9903d9cd..c35596a304e 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx @@ -5,7 +5,7 @@ description: "Use notifications to get an alert for the different types of event With BigAnimal, you can opt to get specific types of notifications and receive both in-app and email notifications. -Different types of events are sent as notifications. Users with different roles can configure these 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. The notifications are categorized into following preference sections: - Account - Organizations @@ -13,17 +13,17 @@ The notifications are categorized into following preference sections: The notifications under **Account** preference section: -- Role unassigned from you -- Access key is about to expire -- New role assigned to you +- Project role unassigned from you +- Personal access key is about to expire +- New project role assigned to you The notifications under **Organizations** preference section: -- Payment method added +- Payment method added (specific to organizations that opted credit card payment option) - Machine user API key is expiring !!!note -This section is visible only to the organization owner/admin. +This section is visible only to the organization owner. If the current user is owner of more than one organization, then this section lists the preferences for all the organizations. !!! The notifications under **Projects** preference section: @@ -50,7 +50,7 @@ Notification settings made by a user apply only to that user. If an email notifi ## Viewing notifications Users in the following roles can view the notifications: -- Organization owners/admins can view the organization notifications. +- Organization owners can view the organization notifications. - Project owners/editors can view the project notifications. - User can view their own account notifications. From 4f3d71641e19e1c785754ad3f8b0caab38d452d2 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Wed, 24 Apr 2024 13:35:41 +0530 Subject: [PATCH 3/6] Added cross-reference link for enabling notifications to the relevant topics --- .../biganimal/release/administering_cluster/notifications.mdx | 2 +- .../docs/biganimal/release/administering_cluster/projects.mdx | 1 + .../docs/biganimal/release/getting_started/managing_cluster.mdx | 2 ++ product_docs/docs/biganimal/release/overview/updates.mdx | 2 +- .../docs/biganimal/release/reference/access_key/index.mdx | 2 ++ .../third_party_integrations/index.mdx | 2 ++ 6 files changed, 9 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx index c35596a304e..446f731fcc1 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx @@ -68,4 +68,4 @@ To manage the notifications: 1. Select the **Notifications** tab. Notifications are grouped by account, organizations, and projects available to you. 1. Select account, organization, or project to manage the notifications. - Enable/disable the notification for a particular event using the toggle. - - Select **Email** and **Inbox** next to an event to enable/disable the email and in-app notifications for the event. + - Select **Email** and **Inbox** next to an event to enable/disable the email and in-app notifications for the event. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/administering_cluster/projects.mdx b/product_docs/docs/biganimal/release/administering_cluster/projects.mdx index f8064c12806..783153327e4 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/projects.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/projects.mdx @@ -23,6 +23,7 @@ To add a user: 4. Depending on the level of access you want for the user, select the appropriate role. 5. Select **Submit**. +You can enable in-app inbox or email notifications to get alerted when a user is invited to a project. For more information, see [managing notifications](/notifications/#manage-notifications). ## Creating a project diff --git a/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx b/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx index d92837d9cd1..7ce743a6d01 100644 --- a/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx +++ b/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx @@ -18,6 +18,8 @@ After seven days, single-node and high-availability clusters automatically resum With CLI 3.7.0 and later, you can [pause and resume cluster using CLI](../../getting_started/managing_cluster/#pausing-a-cluster). +You can enable in-app inbox or email notifications to get alerted when the paused cluster is or will be reactivated. For more information, see [managing notifications](../administering_cluster/notifications/#managing-notifications). + ### Pausing a cluster 1. Go to the [Clusters](https://portal.biganimal.com/clusters) page in the [BigAnimal portal](https://portal.biganimal.com). diff --git a/product_docs/docs/biganimal/release/overview/updates.mdx b/product_docs/docs/biganimal/release/overview/updates.mdx index 816ad84973d..86c91fad68c 100644 --- a/product_docs/docs/biganimal/release/overview/updates.mdx +++ b/product_docs/docs/biganimal/release/overview/updates.mdx @@ -6,7 +6,7 @@ EDB performs periodic maintenance to ensure stability and security of your clust ## Notification of upcoming maintenance -You're notified in the BigAnimal portal before maintenance occurs. Details are available on the [BigAnimal status page](https://status.biganimal.com/). You can subscribe to get these updates in a feed by selecting **Subscribe to Updates** on the status page. +You're notified in the BigAnimal portal before maintenance occurs. Details are available on the [BigAnimal status page](https://status.biganimal.com/). You can subscribe to get these updates in a feed by selecting **Subscribe to Updates** on the status page. You can also enable the notifications to receive in-app or email notifications for upcoming, successful, or failed cluster maintenance upgrade. For more information, see [managing notifications](../getting_started/notifications/#managing-notifications). EDB reserves the right to upgrade customers to the latest minor version without prior notice in an extraordinary circumstance. You can't configure minor versions. diff --git a/product_docs/docs/biganimal/release/reference/access_key/index.mdx b/product_docs/docs/biganimal/release/reference/access_key/index.mdx index 63f726f0d37..8f0ef1961e2 100644 --- a/product_docs/docs/biganimal/release/reference/access_key/index.mdx +++ b/product_docs/docs/biganimal/release/reference/access_key/index.mdx @@ -27,6 +27,8 @@ To create an access key: Copy this access key and save it in a secure location. The access key is available only when you create it. If you lose your access key, you must delete it and create a new one. +You can enable in-app inbox or email notifications to get alerted when your personal key is about to expire. For more information, see [manage notifications](../../administering_cluster/notifications/#manage-notifications). + ## Manage access key You can manage the access keys for a machine user from the **Users** home page. diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx index bdccf9712b6..be47a304e17 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx @@ -10,6 +10,8 @@ By default, all the integrations are disabled. After creating the project, enabl All the metrics collected from all the clusters in the project are sent to the integrated tool and displayed in the BigAnimal [**Monitoring and logging** tab using BigAnimal's Observability](../monitoring_using_biganimal_observability). The collected logs are exported to the object storage by default. +You can enable in-app inbox or email notifications to get notified incase third-party monitoring integration fails. For more information, see [managing notifications](../../../administering_cluster/notifications/#managing-notifications). + The third-party integrations available in BigAnimal are: - [Datadog](./datadog) From 3abc8db2dfd20f836dc3760684ba743213e68fee Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Thu, 25 Apr 2024 12:56:13 +0530 Subject: [PATCH 4/6] updates as per review comments & link fixes --- .../release/administering_cluster/notifications.mdx | 6 +++--- .../biganimal/release/getting_started/managing_cluster.mdx | 2 +- product_docs/docs/biganimal/release/overview/updates.mdx | 2 +- .../third_party_integrations/index.mdx | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx index 446f731fcc1..ba34414f97b 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx @@ -20,7 +20,7 @@ The notifications under **Account** preference section: The notifications under **Organizations** preference section: - Payment method added (specific to organizations that opted credit card payment option) -- Machine user API key is expiring +- Machine user access key is expiring !!!note This section is visible only to the organization owner. If the current user is owner of more than one organization, then this section lists the preferences for all the organizations. @@ -30,12 +30,12 @@ The notifications under **Projects** preference section: - Paused cluster reactivated - Upcoming cluster maintenance upgrade -- CMK error +- Cluster paused due to encryption key error - User invited to project - Successful cluster maintenance upgrade - Failed cluster maintenance upgrade - Paused cluster will reactivate -- User encryption key permission for cluster +- Encryption key permission required to provision the cluster - Failed third-party monitoring integration diff --git a/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx b/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx index 7ce743a6d01..0412fa4a7ba 100644 --- a/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx +++ b/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx @@ -18,7 +18,7 @@ After seven days, single-node and high-availability clusters automatically resum With CLI 3.7.0 and later, you can [pause and resume cluster using CLI](../../getting_started/managing_cluster/#pausing-a-cluster). -You can enable in-app inbox or email notifications to get alerted when the paused cluster is or will be reactivated. For more information, see [managing notifications](../administering_cluster/notifications/#managing-notifications). +You can enable in-app inbox or email notifications to get alerted when the paused cluster is or will be reactivated. For more information, see [managing notifications](../administering_cluster/notifications/#manage-notifications). ### Pausing a cluster diff --git a/product_docs/docs/biganimal/release/overview/updates.mdx b/product_docs/docs/biganimal/release/overview/updates.mdx index 86c91fad68c..edd07c97b78 100644 --- a/product_docs/docs/biganimal/release/overview/updates.mdx +++ b/product_docs/docs/biganimal/release/overview/updates.mdx @@ -6,7 +6,7 @@ EDB performs periodic maintenance to ensure stability and security of your clust ## Notification of upcoming maintenance -You're notified in the BigAnimal portal before maintenance occurs. Details are available on the [BigAnimal status page](https://status.biganimal.com/). You can subscribe to get these updates in a feed by selecting **Subscribe to Updates** on the status page. You can also enable the notifications to receive in-app or email notifications for upcoming, successful, or failed cluster maintenance upgrade. For more information, see [managing notifications](../getting_started/notifications/#managing-notifications). +You're notified in the BigAnimal portal before maintenance occurs. Details are available on the [BigAnimal status page](https://status.biganimal.com/). You can subscribe to get these updates in a feed by selecting **Subscribe to Updates** on the status page. You can also enable the notifications to receive in-app or email notifications for upcoming, successful, and failed cluster maintenance upgrade. For more information, see [managing notifications](../administering_cluster/notifications/#manage-notifications). EDB reserves the right to upgrade customers to the latest minor version without prior notice in an extraordinary circumstance. You can't configure minor versions. diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx index be47a304e17..f6dd5e4fd29 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx @@ -10,7 +10,7 @@ By default, all the integrations are disabled. After creating the project, enabl All the metrics collected from all the clusters in the project are sent to the integrated tool and displayed in the BigAnimal [**Monitoring and logging** tab using BigAnimal's Observability](../monitoring_using_biganimal_observability). The collected logs are exported to the object storage by default. -You can enable in-app inbox or email notifications to get notified incase third-party monitoring integration fails. For more information, see [managing notifications](../../../administering_cluster/notifications/#managing-notifications). +You can enable in-app inbox or email notifications to get notified incase third-party monitoring integration fails. For more information, see [managing notifications](../../../administering_cluster/notifications/#manage-notifications). The third-party integrations available in BigAnimal are: From 9c92cf1a8953dc545dea2631c753fc557078efe6 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Thu, 25 Apr 2024 14:03:27 +0530 Subject: [PATCH 5/6] fixed a broken link --- .../docs/biganimal/release/administering_cluster/projects.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/projects.mdx b/product_docs/docs/biganimal/release/administering_cluster/projects.mdx index 783153327e4..be6464ffa39 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/projects.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/projects.mdx @@ -23,7 +23,7 @@ To add a user: 4. Depending on the level of access you want for the user, select the appropriate role. 5. Select **Submit**. -You can enable in-app inbox or email notifications to get alerted when a user is invited to a project. For more information, see [managing notifications](/notifications/#manage-notifications). +You can enable in-app inbox or email notifications to get alerted when a user is invited to a project. For more information, see [managing notifications](../notifications/#manage-notifications). ## Creating a project From 6709ba649e56c99cab7357e45e3124d370a0df22 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Thu, 25 Apr 2024 15:40:11 +0530 Subject: [PATCH 6/6] Re-ordered bullets --- .../release/administering_cluster/notifications.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx index ba34414f97b..6a6fc4375ea 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx @@ -13,9 +13,9 @@ The notifications are categorized into following preference sections: The notifications under **Account** preference section: +- New project role assigned to you - Project role unassigned from you - Personal access key is about to expire -- New project role assigned to you The notifications under **Organizations** preference section: @@ -28,13 +28,13 @@ This section is visible only to the organization owner. If the current user is o The notifications under **Projects** preference section: -- Paused cluster reactivated - Upcoming cluster maintenance upgrade -- Cluster paused due to encryption key error -- User invited to project - Successful cluster maintenance upgrade - Failed cluster maintenance upgrade +- User invited to project - Paused cluster will reactivate +- Paused cluster reactivated +- Cluster paused due to encryption key error - Encryption key permission required to provision the cluster - Failed third-party monitoring integration