Skip to content

Commit

Permalink
Merge pull request #5492 from EnterpriseDB/release-2024-04-10a
Browse files Browse the repository at this point in the history
Release 2024-04-10a
  • Loading branch information
djw-m authored Apr 10, 2024
2 parents 61aebb2 + 2aaf349 commit a27aaa7
Show file tree
Hide file tree
Showing 10 changed files with 740 additions and 257 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ title: Notifications

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 this notifications. This table provides the list of events sent as notifications grouped by different levels at which they can be set:
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 (24hr) | Project owner/editor | 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 reactivated in 24 hours | 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 |
Expand All @@ -24,16 +24,16 @@ Different types of events are sent as notifications. These notifications are set
| Project | Failed connection to third-party monitoring integration (and future non-monitoring integrations) | Project owner/editor | All |

!!!note
All subscription type means Digital self-service, Direct purchase, and Azure Marketplace. For more information, see [subscription types](/biganimal/latest/pricing_and_billing/#payments-and-billing).
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).
!!!

## 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, email or both. They can also configure email notifications for their teams within 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, or both. They can also configure email notifications for their teams in their organization.

Project level notifications are configured within the project.
Project-level notifications are configured in the project.

Notification settings made by a user are applicable only to that user. If an email notification is enabled, the email is sent to the email address associated with the user's login.
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.

## Viewing notifications

Expand All @@ -42,19 +42,18 @@ Users in the following roles can view the notifications:
- Project owners/editors can view the project-level notifications.
- Account owners can view their own account-level notifications.

Each notification indicates the level and/or project it belongs to for the user having multiple roles within BigAnimal.
Each notification indicates the level and project it belongs to for the user having multiple roles in BigAnimal.

Select the bell icon on the top of your BigAnimal portal to view the in-app notifications. On the bell icon, you can read the notification, mark it as unread and also archive the notification.
Select the bell at the top of your BigAnimal portal to view the in-app notifications. By selecting the bell, you can read the notification, mark it as unread, and archive it.

Check the inbox of your configured email addresses, to view the email notifications.
To view the email notifications, check the inbox of your configured email addresses.

## Manage notifications

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. 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.
- Enable/disable the notification for a particular event using the toggle button.
- Select the **Email** and **Inbox** next to an event to enable/disable the email and in-app notifications for the event.

- 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.
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ Before creating a project:

To create a new project:

1. Select **Projects > New Project**.
1. Enter a unique name for the project.
1. Select **Create Project**.
1. Select **Projects > Create New Project**.
1. In the **Project Name** field, enter a unique name.
1. Optionally, under **Tags*, select **+**.
1. To assign an existing tag, in the search bar under **Tags**, enter a tag name. To add a new tag, instead select **+ Add Tag**.
1. Select **Create New Project**.
1. Select **Project > See All Projects**.
1. Select your new project.
1. Set up the cloud provider for the project. See [Connecting your cloud](/biganimal/latest/getting_started/02_connecting_to_your_cloud/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ The following options aren't available when creating your cluster:

1. In the **Password** field, enter a password for your cluster. This is the password for the user edb_admin.

1. Under **Tags**, select **+**.

1. To assign an existing tag, in the search bar under **Tags**, enter a tag name. To add a new tag, instead select **+ Add Tag**.

1. In the **Database Type** section:

1. In the **Postgres Type** field, select the type of Postgres you want to use:
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/biganimal/release/known_issues/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ navTitle: Known issues

These known issues and/or limitations are in the current release of BigAnimal and the Postgres deployments it supports:

* [Known issues with distributed high availability](known_issues_dha)
* [Known issues with distributed high availability](known_issues_pgd)
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ redirects:
These are currently known issues in EDB Postgres Distributed (PGD) on BigAnimal as deployed in distributed high availability clusters.
These known issues are tracked in our ticketing system and are expected to be resolved in a future release.

For general PGD known issues, refer to the [Known Issues](/pgd/latest/known_issues/) and [Limitations](/pgd/latest/limitations/) in the PGD documentation.

## Management/administration

### Deleting a PGD data group may not fully reconcile
Expand Down Expand Up @@ -39,21 +41,15 @@ This cannot be changed, either at initialization or after the cluster is created

## Replication

### A PGD replication slot may fail to transition cleanly from disconnect to catch up
As part of fault injection testing with PGD on BigAnimal, you may decide to delete VMs.
Your cluster will recover if you do so, as expected.
However, if you're testing in a bring-your-own-account (BYOA) deployment, in some cases, as the cluster is recovering, a replication slot may remain disconnected.
This will persist for a few hours until the replication slot recovers automatically.

### Replication speed is slow during a large data migration
During a large data migration, when migrating to a PGD cluster, you may experience a replication rate of 20 MBps.

### PGD leadership change on healthy cluster
PGD clusters that are in a healthy state may experience a change in PGD node leadership, potentially resulting in failover.
No intervention is needed as a new leader will be appointed.
The client applications will need to reconnect when a leadership change occurs.

### Extensions which require alternate roles are not supported
Where an extension requires a role other than the default role (`streaming_replica`) used for replication, it will fail when attempting to replicate.
Where an extension requires a role other than the default role (`bdr_application`) used for replication, it will fail when attempting to replicate.
This is because PGD runs replication writer operations as a `SECURITY_RESTRICTED_OPERATION` to mitigate the risk of privilege escalation.
Attempts to install such extensions may cause the cluster to fail to operate.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
title: Creating and managing tags
---

BigAnimal supports tagging of the following resources:

- Project
- Cluster

## Create and assign a tag

You can create a tag using either of these methods:

- [Create a tag and assign it to a resource]()
- [Create and assign a tag while creating a resource]()

### Create a tag and assign it to a resource

To create a tag:

1. Log in to the BigAnimal portal.

1. From the menu under your name in the top right of the panel, select **Tags**.

1. From the Create Tag page, select **Create Tag**.

1. Enter the tag name.

1. Select the color for the tag.

1. View the tag in **Preview**.

1. Select **Save**.

The generated tag is available for the user.

To assign a tag to an existing cluster:

1. Go to cluster's home page.

1. In the clusters list, select the edit icon next to the cluster.

1. On the Edit Cluster page, go to the **Cluster Settings** tab.

1. Under **Tags**, select **+**.

1. In the search bar, enter the name of the tag and select the tag.

1. To assign the tag, select **Save**.

To assign a tag to an existing project:

1. Go to the project's home page.

1. In the projects list, select the edit icon next to the project.

1. On the Edit Project page, under **Tags**, select **+**.

1. In the search bar, enter the tag name and select the tag.

1. To assign the tag, select **Save**.

### Create a tag while creating a resource

Create and assign a tag while [creating a project](../../administering_cluster/projects.mdx/#creating-a-project) and [creating a cluster](../../getting_started/creating_a_cluster/index.mdx/#cluster-settings-tab).

## Edit a tag

1. Log in to the BigAnimal portal.

1. From the menu under your name in the top right of the panel, select **Tags**.

1. On the Tags page, select the edit button next to the tag name.

1. Edit the tag name and color.

1. Select **Save**.

## Delete a tag

1. Log in to the BigAnimal portal.

1. From the menu under your name in the top right of the panel, select **Tags**.

1. On the Tags page, select the delete icon next to the tag name.

You're prompted to type **delete tag** in the field.

1. To delete the tag, enter the text as instructed, and select **Yes, Delete tag**.
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Tagging BigAnimal resources
---

BigAnimal provides a shared tags system that allows you to assign and manage tags for resources across different resource types.

The tags are assigned to the following resource types:

- Project
- Cluster

Key features of shared tags system are:

- **Shared tags** — You can [create shared tags](./create_and_manage_tags.mdx) that are accessible and applicable to all the supported resource types. Shared tags provides a standard way to categorize and organize resources. Tags are scoped to the organizations and shared among all users in the organization. The access to tags is controlled by existing permission system.

- **Tag assignment** — You can assign one or more shared tags to individual resource items. This capability enables you to categorize resources effectively and according to the needs.

- **Tag permissions** — The tag management includes permission settings to control who can create, edit, or delete shared tags. This ensures security and control over the tagging system.
4 changes: 3 additions & 1 deletion product_docs/docs/pgd/5/admin-tpa/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Automated Installation and Administration with TPA
title: Automated installation and administration with TPA
navTitle: With TPA
---

Expand All @@ -22,3 +22,5 @@ This section of the manual covers how to use TPA to deploy and administer EDB Po
* Deploying the configuration with TPA

The installing section provides an example cluster which will be used in future examples.

You can also [perform a rolling major version upgrade](upgrading_major_rolling.mdx) with PGD administered by TPA.
Loading

2 comments on commit a27aaa7

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸŽ‰ Published on https://edb-docs.netlify.app as production
πŸš€ Deployed on https://66166dfe8714061871d470e4--edb-docs.netlify.app

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.