From 56f12f38f8764b24c5a6a788597cedc822270564 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 11 May 2022 10:03:14 -0400 Subject: [PATCH 01/31] BigAnimal: BDR support --- .../docs/biganimal/release/overview/02_high_availability.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 38e235c8fd2..263aa61691d 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -4,7 +4,7 @@ redirects: - 02_high_availibility --- -BigAnimal enables deploying a cluster with or without high availability. The option is controlled with the **High Availablity** control on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. +BigAnimal enables deploying a single node cluster with no standby servers or with two standby replicas in different availability zones (high availability) or exteme high availability leveraging EDB Postgres Distributed. You chose you which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. ## High availability—enabled From 7ad3375336d74125b5287b6340e7ac938f22dc90 Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Thu, 12 May 2022 19:22:53 +0530 Subject: [PATCH 02/31] Added DRAFT content for UPM-4771 --- .../creating_a_cluster/index.mdx | 45 ++++++++++++------- 1 file changed, 30 insertions(+), 15 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 55f5442858e..4fba682e39c 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -16,22 +16,38 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. -2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. -3. On the **Create Cluster** page, specify the cluster settings on the following tabs: +1. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. +1. On the **Create Cluster** page, specify the cluster settings on the following tabs: + - [**Cluster Type tab**](#cluster-type-tab) - [**Cluster Settings**](#cluster-settings-tab) - - [**DB Configuration** ](#db-configuration-tab) (optional) - [ **Availability** ](#availability-tab) (optional) -4. Select **Create Cluster**. It might take a few minutes to deploy. +1. Select **Create Cluster**. It might take a few minutes to deploy. !!! Note When you don't configure settings on optional tabs, the default values are used. +### Cluster Type tab + +1. Select which type of cluster to deploy. + + - *Single node cluster* + Suited for test environments where high availability is not a primary concern. Creates a cluster with one primary and no standby servers. + + - *High Availability cluster* + Creates a cluster with one primary and two standby replicas in different availability zones. + + - *Extreme High Availability Cluster* + Creates a cluster configured with a leader node, three shadow nodes and one witness node. This cluster uses a logical replication to deliver faster failover and recovery. + + +1. Select the Cloud Provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). + ### Cluster Settings tab 1. Enter the name for your cluster in the **Cluster Name** field. -2. Enter a password for your cluster in the **Password** field. This is the password for the user edb_admin. +1. Enter a password for your cluster in the **Password** field. This is the password for the user edb_admin. 1. In the **Database Type** section: 1. Select the type of Postgres you want to use in the **Postgres Type** field: @@ -40,28 +56,27 @@ Prior to creating your cluster, make sure you have enough resources. Without eno - [**PostgreSQL**](/supported-open-source/postgresql/) is an open-source object-relational database management system. - 2. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. -2. In the **Provider** section, select the cloud provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). -3. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). -4. In the **Instance Type** section, + - [*EDB Postgres Advanced Server*](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). + 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. + +1. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). +1. In the **Instance Type** section, 1. Select the category that works best for your applications and workload: - Memory optimized for large data sets - Compute optimized for compute bound applications - General purpose if you don't require memory or compute optimization. - 2. Select the instance series and size. + 1. Select the instance series and size. - See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) or [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/) for information to help you choose the appropriate instance type. -5. In the **Storage** section, select your volume type from the **Volume Type** list. +1. In the **Storage** section, select your volume type from the **Volume Type** list. - For Azure, BigAnimal currently supports Azure Premium SSD storage types. In **Volume Properties**, select the type and amount of storage needed for your cluster. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. - For AWS, BigAnimal currently supports General Purpose SSD (GP3) storage. In **Volume Properties**, select the disk size for your cluster. -6. In the **Networking Connectivity** section, you specify whether to use private or public networking. Networking is set to **Public** by default. Public means that any client can connect to your cluster’s public IP address over the internet. Optionally, you can limit traffic to your public cluster by specifying an IP allowlist, which allows access only to certain blocks of IP addresses. To limit access, add one or more classless inter-domain routing (CIDR) blocks in the **IP Allowlists** section. CIDR is a method for allocating IP addresses and IP routing to a whole network or subnet. If you have any CIDR block entries, access is limited to those IP addresses. If none are specified, all network traffic is allowed. +1. In the **Networking Connectivity** section, you specify whether to use private or public networking. Networking is set to **Public** by default. Public means that any client can connect to your cluster’s public IP address over the internet. Optionally, you can limit traffic to your public cluster by specifying an IP allowlist, which allows access only to certain blocks of IP addresses. To limit access, add one or more classless inter-domain routing (CIDR) blocks in the **IP Allowlists** section. CIDR is a method for allocating IP addresses and IP routing to a whole network or subnet. If you have any CIDR block entries, access is limited to those IP addresses. If none are specified, all network traffic is allowed. Private networking allows only IP addresses within your private network to connect to your cluster. See [Cluster networking architecture](01_cluster_networking) for more information. - - -7. To optionally make updates to your database configuration parameters, select **Next: DB Configuration**. +1. To optionally make updates to your database configuration parameters, select **Next: DB Configuration**. ### DB Configuration tab From 7ee396c045a52f46f8629c71f586d4e96ba44739 Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Fri, 13 May 2022 14:13:35 +0530 Subject: [PATCH 03/31] Updates supported regions and database pages --- .../release/overview/03a_region_support.mdx | 29 ++++++++++++++++--- .../overview/05_database_version_policy.mdx | 4 +-- 2 files changed, 27 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx index 1da6dddfb65..b4c1a3f649b 100644 --- a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx +++ b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx @@ -2,9 +2,11 @@ title: "Supported regions" --- -## Supported Azure regions +## Supported Azure regions -When using Azure, you can create a cluster in the following regions: +When using Azure, you can create clusters in the following regions: + +**Single node and high availability clusters** - North America (NA): - Canada Central (Toronto) @@ -27,9 +29,28 @@ When using Azure, you can create a cluster in the following regions: - Japan East (Tokyo, Saitama) - South East Asia (Singapore) -## Supported AWS regions +**Extreme high availability (beta) clusters** + +- North America (NA): + - Canada Central (Toronto) + - Central US (Iowa) + - East US (Virginia) + - East US 2 (Virigina) + - West US 2 (Washington) + - West US 3 (Arizona) +- Europe, Middle East, Africa (EMEA) + - North Europe (Ireland) + - UK South (London) +- Asia Pacific, Japan (APJ) + - Australia East (New South Wales) + - Japan East (Tokyo, Saitama) + - South East Asia (Singapore) + +## Supported AWS regions + +When using AWS, you can create clusters in the following regions: -When using AWS, you can create a cluster in the following regions: +**Single node, high availability, and extreme high availability (beta) clusters** - United States (US): - US East 1 (N. Virginia) diff --git a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx index 1cb5d3fd1ce..9831a5ebfc9 100644 --- a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx +++ b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx @@ -10,6 +10,6 @@ PostgreSQL and EDB Postgres Advanced Server major versions are supported from th | ---------------------------- | ------------ | | PostgreSQL | 11–14 | | EDB Postgres Advanced Server | 11–14 | +| Postgres Extended | 11-14 | - - + \ No newline at end of file From bdf3450dcfb080d47db9bc210136f3bba9848b12 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Fri, 13 May 2022 14:46:16 -0400 Subject: [PATCH 04/31] initial attempt at EHA description (Extreme High Availability) initial attempt at EHA description --- .../release/overview/02_high_availability.mdx | 25 +++++++++++++++---- .../images/extreme-availability-ui.png | 3 +++ .../overview/images/extreme-availability.png | 3 +++ .../overview/images/ha-not-enabled-UI.png | 3 +++ .../overview/images/high-availability-ui.png | 3 +++ 5 files changed, 32 insertions(+), 5 deletions(-) create mode 100644 product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png create mode 100644 product_docs/docs/biganimal/release/overview/images/extreme-availability.png create mode 100644 product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png create mode 100644 product_docs/docs/biganimal/release/overview/images/high-availability-ui.png diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 263aa61691d..bb06c5ac769 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -4,25 +4,40 @@ redirects: - 02_high_availibility --- -BigAnimal enables deploying a single node cluster with no standby servers or with two standby replicas in different availability zones (high availability) or exteme high availability leveraging EDB Postgres Distributed. You chose you which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. +BigAnimal supports three deployment architectures: +- Single node +- Standard high availability +- Extreme high availability (beta) -## High availability—enabled +You choose which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. + +## Extreme high availability + +Extreme high availability clusters are built with EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension providing multi-master replication and data distribution with advanced conflict management, data-loss protection, and throughput up to 5X faster than native logical replication, and enables distributed PostgreSQL clusters with high availability up to five 9s. Extreme high availability clusters use EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is fully compatible with community PostgreSQL. + +The extreme high availability clusters are all in one cloud region with three availability zones. One BDR group is the *leader* node. It exists in one availability zone along with a shadow node. In another availability zone, there are two more *shadow* nodes. A third availability zone contains a witness node. The leader node represents the entire cluster or a local region. The shadow nodes wait to take over when needed. If a node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node [NEED DEFINITION OF WHAT ROLE THE WITNESS NODE PLAYS]. This architecture allows for higher performance and faster failover recovery compared to standard high availability. + +![*BigAnimal Cluster4*](images/extreme-availability-ui.png) + +EDB Postgres Distributed uses a [Raft](https://raft.github.io/)-based consensus architecture. While regular database operations (INSERT, SELECT, DELETE) don’t require cluster-wide consensus, the extreme high availability architecture benefits from an odd number of BDR nodes to make decisions that require consensus, such as generating new global sequences, or distributed DDL operations. + +## Standard high availability The high availability option is provided to minimize downtime in cases of failures. High-availability clusters—one *primary* and two *replicas*—are configured automatically, with replicas staying up to date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across multiple availability zones to provide fault tolerance in the face of a datacenter failure. - Replicas are usually called *standby servers*. - In case of temporary or permanent unavailability of the primary, a standby replica becomes the primary. -![*BigAnimal Cluster4*](images/high-availability.png) +![*BigAnimal Cluster4*](images/high-availability-ui.png) Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica is automatically promoted to primary, and new connections are routed to the new primary. When the old primary recovers, it rejoins the cluster as a replica. By default, replication is synchronous to one replica and asynchronous to the other. That is, one replica must confirm that a transaction record was written to disk before the client receives acknowledgment of a successful commit. In PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. You can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. -## High availability—not enabled +## Single node For nonproduction use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one primary with no standby servers for failover or read-only workloads. In case of permanent unavailability of the primary, a restore from a backup is required. -![*BigAnimal Cluster4*](images/ha-not-enabled.png) +![*BigAnimal Cluster4*](images/ha-not-enabled-UI.png) diff --git a/product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png b/product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png new file mode 100644 index 00000000000..58e3650d49f --- /dev/null +++ b/product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b23b0ee1ffd81cb11e49b2ca1b67dabd7cda1466f6ace95f8cbf3c389fc33d40 +size 162521 diff --git a/product_docs/docs/biganimal/release/overview/images/extreme-availability.png b/product_docs/docs/biganimal/release/overview/images/extreme-availability.png new file mode 100644 index 00000000000..13062dcdc16 --- /dev/null +++ b/product_docs/docs/biganimal/release/overview/images/extreme-availability.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d991c511cfbfd3bdc257da62766a46154933e418950cf6da9b98b0a2df32d2fa +size 228061 diff --git a/product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png b/product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png new file mode 100644 index 00000000000..9436a77b593 --- /dev/null +++ b/product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1c71271314c7c75a22feef354833075e717976191f723071b5c7cc889a304a6b +size 48160 diff --git a/product_docs/docs/biganimal/release/overview/images/high-availability-ui.png b/product_docs/docs/biganimal/release/overview/images/high-availability-ui.png new file mode 100644 index 00000000000..8afca2ac35a --- /dev/null +++ b/product_docs/docs/biganimal/release/overview/images/high-availability-ui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a761897b50b864e49957501a8273eb5aaa9094b246deac0c8637f49b18dd670 +size 120644 From cf1009cb67f9c6bbfc62b0eeb49ea1b5a26216bb Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Mon, 16 May 2022 17:17:55 +0530 Subject: [PATCH 05/31] Resolving conflicts --- .../release/getting_started/creating_a_cluster/index.mdx | 6 +++--- .../docs/biganimal/release/overview/03a_region_support.mdx | 2 +- .../release/overview/05_database_version_policy.mdx | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 4fba682e39c..cf0cb6d6944 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -29,16 +29,16 @@ Prior to creating your cluster, make sure you have enough resources. Without eno ### Cluster Type tab -1. Select which type of cluster to deploy. +1. Select which type of cluster to deploy. Note that you cannot switch from single node/HA to BDR or vice versa - *Single node cluster* - Suited for test environments where high availability is not a primary concern. Creates a cluster with one primary and no standby servers. + Creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. - *High Availability cluster* Creates a cluster with one primary and two standby replicas in different availability zones. - *Extreme High Availability Cluster* - Creates a cluster configured with a leader node, three shadow nodes and one witness node. This cluster uses a logical replication to deliver faster failover and recovery. + Creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. 1. Select the Cloud Provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). diff --git a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx index b4c1a3f649b..d9842813b74 100644 --- a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx +++ b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx @@ -29,7 +29,7 @@ When using Azure, you can create clusters in the following regions: - Japan East (Tokyo, Saitama) - South East Asia (Singapore) -**Extreme high availability (beta) clusters** +**Extreme high availability clusters (beta)** - North America (NA): - Canada Central (Toronto) diff --git a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx index 9831a5ebfc9..442c2a48b9d 100644 --- a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx +++ b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx @@ -12,4 +12,4 @@ PostgreSQL and EDB Postgres Advanced Server major versions are supported from th | EDB Postgres Advanced Server | 11–14 | | Postgres Extended | 11-14 | - \ No newline at end of file + \ No newline at end of file From ecba3256e4ba862d15c7d04bf2963de704d17445 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Mon, 16 May 2022 12:47:51 -0400 Subject: [PATCH 06/31] updated arch diagrams and tweaked wording for EHA added definition for witness node --- .../release/overview/02_high_availability.mdx | 18 +++++++++++------- .../overview/images/Extreme-HA-Diagram-2x.png | 3 +++ .../release/overview/images/HA-diagram-2x.png | 3 +++ .../overview/images/Single-Node-Diagram-2x.png | 3 +++ .../images/extreme-availability-ui.png | 3 --- .../overview/images/ha-not-enabled-UI.png | 3 --- .../overview/images/high-availability-ui.png | 3 --- 7 files changed, 20 insertions(+), 16 deletions(-) create mode 100644 product_docs/docs/biganimal/release/overview/images/Extreme-HA-Diagram-2x.png create mode 100644 product_docs/docs/biganimal/release/overview/images/HA-diagram-2x.png create mode 100644 product_docs/docs/biganimal/release/overview/images/Single-Node-Diagram-2x.png delete mode 100644 product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png delete mode 100644 product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png delete mode 100644 product_docs/docs/biganimal/release/overview/images/high-availability-ui.png diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index bb06c5ac769..db498a612af 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -11,15 +11,19 @@ BigAnimal supports three deployment architectures: You choose which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. -## Extreme high availability +## Extreme high availability (beta) -Extreme high availability clusters are built with EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension providing multi-master replication and data distribution with advanced conflict management, data-loss protection, and throughput up to 5X faster than native logical replication, and enables distributed PostgreSQL clusters with high availability up to five 9s. Extreme high availability clusters use EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is fully compatible with community PostgreSQL. +Extreme high availability clusters are built with EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension providing multi-master replication and data distribution with advanced conflict management, data-loss protection, and throughput up to 5X faster than native logical replication, and enables distributed PostgreSQL clusters with high availability up to five 9s. Extreme high availability clusters require EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is fully compatible with community PostgreSQL. -The extreme high availability clusters are all in one cloud region with three availability zones. One BDR group is the *leader* node. It exists in one availability zone along with a shadow node. In another availability zone, there are two more *shadow* nodes. A third availability zone contains a witness node. The leader node represents the entire cluster or a local region. The shadow nodes wait to take over when needed. If a node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node [NEED DEFINITION OF WHAT ROLE THE WITNESS NODE PLAYS]. This architecture allows for higher performance and faster failover recovery compared to standard high availability. +The extreme high availability clusters are all in one cloud region with three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. + +The leader node exists in one availability zone along with a shadow node. In another availability zone, there are two more *shadow* nodes. A third availability zone contains a witness node. The shadow nodes wait to take over when needed. If a node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. + +This architecture allows for higher performance and faster failover recovery compared to standard high availability. + +![*BigAnimal Cluster4*](images/Extreme-HA-Diagram-2x.png) -![*BigAnimal Cluster4*](images/extreme-availability-ui.png) -EDB Postgres Distributed uses a [Raft](https://raft.github.io/)-based consensus architecture. While regular database operations (INSERT, SELECT, DELETE) don’t require cluster-wide consensus, the extreme high availability architecture benefits from an odd number of BDR nodes to make decisions that require consensus, such as generating new global sequences, or distributed DDL operations. ## Standard high availability @@ -28,7 +32,7 @@ The high availability option is provided to minimize downtime in cases of failur - Replicas are usually called *standby servers*. - In case of temporary or permanent unavailability of the primary, a standby replica becomes the primary. -![*BigAnimal Cluster4*](images/high-availability-ui.png) +![*BigAnimal Cluster4*](images/HA-diagram-2x.png) Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica is automatically promoted to primary, and new connections are routed to the new primary. When the old primary recovers, it rejoins the cluster as a replica. @@ -40,4 +44,4 @@ For nonproduction use cases where high availability is not a primary concern, a In case of permanent unavailability of the primary, a restore from a backup is required. -![*BigAnimal Cluster4*](images/ha-not-enabled-UI.png) +![*BigAnimal Cluster4*](images/Single-Node-Diagram-2x.png) diff --git a/product_docs/docs/biganimal/release/overview/images/Extreme-HA-Diagram-2x.png b/product_docs/docs/biganimal/release/overview/images/Extreme-HA-Diagram-2x.png new file mode 100644 index 00000000000..41f973c47ca --- /dev/null +++ b/product_docs/docs/biganimal/release/overview/images/Extreme-HA-Diagram-2x.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30461e8c5e0df0e62f34315e3e20e05484c4429f17305f8955ffa1de0d009b73 +size 61239 diff --git a/product_docs/docs/biganimal/release/overview/images/HA-diagram-2x.png b/product_docs/docs/biganimal/release/overview/images/HA-diagram-2x.png new file mode 100644 index 00000000000..66dafa45e47 --- /dev/null +++ b/product_docs/docs/biganimal/release/overview/images/HA-diagram-2x.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:437565fba81757714d1327c15e308a7487db42e05579a88b2d471253a3eb60ae +size 32023 diff --git a/product_docs/docs/biganimal/release/overview/images/Single-Node-Diagram-2x.png b/product_docs/docs/biganimal/release/overview/images/Single-Node-Diagram-2x.png new file mode 100644 index 00000000000..75e5fca9a21 --- /dev/null +++ b/product_docs/docs/biganimal/release/overview/images/Single-Node-Diagram-2x.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b9d6b638f6ecbd6873defb748317d2a24f50759a7236f6f69339ab24313c27e5 +size 11826 diff --git a/product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png b/product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png deleted file mode 100644 index 58e3650d49f..00000000000 --- a/product_docs/docs/biganimal/release/overview/images/extreme-availability-ui.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:b23b0ee1ffd81cb11e49b2ca1b67dabd7cda1466f6ace95f8cbf3c389fc33d40 -size 162521 diff --git a/product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png b/product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png deleted file mode 100644 index 9436a77b593..00000000000 --- a/product_docs/docs/biganimal/release/overview/images/ha-not-enabled-UI.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:1c71271314c7c75a22feef354833075e717976191f723071b5c7cc889a304a6b -size 48160 diff --git a/product_docs/docs/biganimal/release/overview/images/high-availability-ui.png b/product_docs/docs/biganimal/release/overview/images/high-availability-ui.png deleted file mode 100644 index 8afca2ac35a..00000000000 --- a/product_docs/docs/biganimal/release/overview/images/high-availability-ui.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:1a761897b50b864e49957501a8273eb5aaa9094b246deac0c8637f49b18dd670 -size 120644 From 1bf26a774ee6a2794456783a87d2fe5b1fbe6884 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Mon, 16 May 2022 14:38:09 -0400 Subject: [PATCH 07/31] removed comment that was causing the build to fail --- .../creating_a_cluster/index.mdx | 23 ++++++++++++------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index cf0cb6d6944..22cf6621d79 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -29,17 +29,24 @@ Prior to creating your cluster, make sure you have enough resources. Without eno ### Cluster Type tab -1. Select which type of cluster to deploy. Note that you cannot switch from single node/HA to BDR or vice versa +1. Select which type of cluster to deploy. - - *Single node cluster* - Creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. + - *Single Node* - - *High Availability cluster* - Creates a cluster with one primary and two standby replicas in different availability zones. + Creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. - - *Extreme High Availability Cluster* - Creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. - + - *High Availability* + + Creates a cluster with one primary and two standby replicas in different availability zones. + + - *Extreme High Availability* (beta) + + Creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. + + See [Supported architectures](/biganimal/release/overview/03_security) for more information about the different cluster types. + + !!!Note + You can't switch from a single node cluster or a high availability node to an extreme high availability node or vice versa. 1. Select the Cloud Provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). From 87f86b6c998aa581d3a0c43c409ec3613eba2e67 Mon Sep 17 00:00:00 2001 From: nataliawojcik27 <90423028+nataliawojcik27@users.noreply.github.com> Date: Mon, 16 May 2022 16:22:48 -0400 Subject: [PATCH 08/31] natalia-copytweaks-order adjusted order of paragraphs to match order of bullets at top + copy tweaks (i.e. think instead of multi-master we'd say multi-leader due to the negative implications of 'master') --- .../release/overview/02_high_availability.mdx | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index db498a612af..1639f7dbf86 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -9,21 +9,15 @@ BigAnimal supports three deployment architectures: - Standard high availability - Extreme high availability (beta) -You choose which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. +You choose which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. -## Extreme high availability (beta) - -Extreme high availability clusters are built with EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension providing multi-master replication and data distribution with advanced conflict management, data-loss protection, and throughput up to 5X faster than native logical replication, and enables distributed PostgreSQL clusters with high availability up to five 9s. Extreme high availability clusters require EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is fully compatible with community PostgreSQL. - -The extreme high availability clusters are all in one cloud region with three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. - -The leader node exists in one availability zone along with a shadow node. In another availability zone, there are two more *shadow* nodes. A third availability zone contains a witness node. The shadow nodes wait to take over when needed. If a node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. - -This architecture allows for higher performance and faster failover recovery compared to standard high availability. +## Single node -![*BigAnimal Cluster4*](images/Extreme-HA-Diagram-2x.png) +For nonproduction use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one primary with no standby servers for failover or read-only workloads. +In case of permanent unavailability of the primary, a restore from a backup is required. +![*BigAnimal Cluster4*](images/Single-Node-Diagram-2x.png) ## Standard high availability @@ -38,10 +32,16 @@ Incoming client connections are always routed to the current primary. In case of By default, replication is synchronous to one replica and asynchronous to the other. That is, one replica must confirm that a transaction record was written to disk before the client receives acknowledgment of a successful commit. In PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. You can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. -## Single node +## Extreme high availability (beta) -For nonproduction use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one primary with no standby servers for failover or read-only workloads. +Extreme high availability clusters are powered by EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension providing multi-leader replication and data distribution with advanced conflict management, data-loss protection, and throughput up to 5X faster than native logical replication, and enables distributed PostgreSQL clusters with high availability up to five 9s. -In case of permanent unavailability of the primary, a restore from a backup is required. +Extreme high availability clusters require EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is fully compatible with community PostgreSQL. -![*BigAnimal Cluster4*](images/Single-Node-Diagram-2x.png) +During the Beta, the components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. + +The leader node exists in one availability zone along with a shadow node. In another availability zone, there are two more *shadow* nodes. A third availability zone contains a witness node. The shadow nodes wait to take over when needed. If a node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. + +This architecture allows for higher performance and faster failover recovery compared to standard high availability. + +![*BigAnimal Cluster4*](images/Extreme-HA-Diagram-2x.png) From 8314039fed36884e68ea347b17a7c16bb24b5386 Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Tue, 17 May 2022 15:17:24 +0530 Subject: [PATCH 09/31] Adding support for Postgres Extended Which versions are we using/supporting with BigAnimal to support Extreme High Availability? Are we also planning the compatibility matrix [here](https://www.enterprisedb.com/resources/platform-compatibility) under Postgres SQL Databases to add info for EDB Postgres Extended. --- .../getting_started/creating_a_cluster/index.mdx | 1 + .../release/overview/05_database_version_policy.mdx | 12 ++++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 22cf6621d79..c0018241b51 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -64,6 +64,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno - [**PostgreSQL**](/supported-open-source/postgresql/) is an open-source object-relational database management system. - [*EDB Postgres Advanced Server*](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). + 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. 1. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). diff --git a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx index 442c2a48b9d..59e0ef94bb4 100644 --- a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx +++ b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx @@ -6,10 +6,18 @@ PostgreSQL and EDB Postgres Advanced Server major versions are supported from th ## Supported Postgres types and versions +**Single node and high availability** + | **Postgres type** | **Versions** | | ---------------------------- | ------------ | | PostgreSQL | 11–14 | | EDB Postgres Advanced Server | 11–14 | -| Postgres Extended | 11-14 | +| EDB Postgres Extended | 11-14 | + + +**Extreme high availability (beta) clusters** - \ No newline at end of file +| **Postgres type** | **Versions** | +| ---------------------------- | ------------ | +| EDB Postgres Advanced Server | 11–14 | +| EDB Postgres Extended | 11-14 | From dc85f07f9dba256c74d3bc290a3bf7cbd2dfc7ca Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Tue, 17 May 2022 17:04:06 +0530 Subject: [PATCH 10/31] Updated Creating a cluster page As part of our content strategy, do we want to mention BDR while describing EDB Postgres Extended? Do we allow user to select the EDB Postgres Extended while create a single node or high availability cluster? --- .../release/getting_started/creating_a_cluster/index.mdx | 4 +++- .../release/using_cluster/03_modifying_your_cluster/index.mdx | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index c0018241b51..8d24771b38d 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -45,7 +45,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno See [Supported architectures](/biganimal/release/overview/03_security) for more information about the different cluster types. - !!!Note + !!! Note You can't switch from a single node cluster or a high availability node to an extreme high availability node or vice versa. 1. Select the Cloud Provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). @@ -64,6 +64,8 @@ Prior to creating your cluster, make sure you have enough resources. Without eno - [**PostgreSQL**](/supported-open-source/postgresql/) is an open-source object-relational database management system. - [*EDB Postgres Advanced Server*](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). + + - [*EDB Postgres Extended*](https://www.enterprisedb.com/products/edb-postgres-extended) is a Postgres distribution that uses advanced logical replication of data and schema. 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. diff --git a/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx b/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx index 733e1e3b2f7..2d48b377f90 100644 --- a/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx @@ -13,6 +13,9 @@ You can modify your cluster by modifying: - Database configuration parameters - High availability +!!! Note + You can't switch from a single node cluster or a high availability cluster to an extreme high availability cluster or vice versa. + ## Modify your cluster 1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. From a8fb89551ad8f6fcc69927eeb58db58bdfba15ad Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Wed, 18 May 2022 16:33:22 +0530 Subject: [PATCH 11/31] incorporated Natalie's inputs --- .../getting_started/creating_a_cluster/index.mdx | 12 +++++------- .../release/overview/05_database_version_policy.mdx | 6 ++---- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 8d24771b38d..b5f90d4d9d1 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -31,15 +31,15 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select which type of cluster to deploy. - - *Single Node* + - Single Node Creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. - - *High Availability* + - High Availability Creates a cluster with one primary and two standby replicas in different availability zones. - - *Extreme High Availability* (beta) + - Extreme High Availability (beta) Creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. @@ -63,10 +63,8 @@ Prior to creating your cluster, make sure you have enough resources. Without eno - [**PostgreSQL**](/supported-open-source/postgresql/) is an open-source object-relational database management system. - - [*EDB Postgres Advanced Server*](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). - - - [*EDB Postgres Extended*](https://www.enterprisedb.com/products/edb-postgres-extended) is a Postgres distribution that uses advanced logical replication of data and schema. - + - [EDB Postgres Extended](https://www.enterprisedb.com/products/edb-postgres-extended) is a Postgres distribution that uses advanced logical replication of data and schema. + 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. 1. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). diff --git a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx index 59e0ef94bb4..4855b5ada61 100644 --- a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx +++ b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx @@ -6,18 +6,16 @@ PostgreSQL and EDB Postgres Advanced Server major versions are supported from th ## Supported Postgres types and versions -**Single node and high availability** +**Single node and high availability clusters** | **Postgres type** | **Versions** | | ---------------------------- | ------------ | | PostgreSQL | 11–14 | | EDB Postgres Advanced Server | 11–14 | -| EDB Postgres Extended | 11-14 | -**Extreme high availability (beta) clusters** +**Extreme high availability clusters (beta)** | **Postgres type** | **Versions** | | ---------------------------- | ------------ | -| EDB Postgres Advanced Server | 11–14 | | EDB Postgres Extended | 11-14 | From 6237253d6d77036a8db5c813e2dcf6531e117b0c Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 18 May 2022 15:00:23 -0400 Subject: [PATCH 12/31] minor copy edits --- .../creating_a_cluster/index.mdx | 35 ++++++------------- .../release/overview/02_high_availability.mdx | 2 +- 2 files changed, 12 insertions(+), 25 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index b5f90d4d9d1..8eb5792ff03 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -18,10 +18,10 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. 1. On the **Create Cluster** page, specify the cluster settings on the following tabs: - - [**Cluster Type tab**](#cluster-type-tab) + - [**Cluster Type**](#cluster-type-tab) + - [**Cluster Settings**](#cluster-settings-tab) - [**DB Configuration** ](#db-configuration-tab) (optional) - - [ **Availability** ](#availability-tab) (optional) 1. Select **Create Cluster**. It might take a few minutes to deploy. !!! Note @@ -31,24 +31,18 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select which type of cluster to deploy. - - Single Node - - Creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. + - [Single node](bigamimal/release/03_security/#single-node) creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. - - High Availability + - [High availability](bigamimal/release/03_security/#high-availability) creates a cluster with one primary and two standby replicas in different availability zones. - Creates a cluster with one primary and two standby replicas in different availability zones. - - - Extreme High Availability (beta) - - Creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. + - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. See [Supported architectures](/biganimal/release/overview/03_security) for more information about the different cluster types. !!! Note You can't switch from a single node cluster or a high availability node to an extreme high availability node or vice versa. -1. Select the Cloud Provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). +1. Select the cloud provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). ### Cluster Settings tab @@ -60,10 +54,10 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select the type of Postgres you want to use in the **Postgres Type** field: - **Oracle Compatible** is powered by [EDB Postgres Advanced Server](/epas/latest/). View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). + + - [PostgreSQL](/supported-open-source/postgresql/) is an open-source object-relational database management system. - - [**PostgreSQL**](/supported-open-source/postgresql/) is an open-source object-relational database management system. - - - [EDB Postgres Extended](https://www.enterprisedb.com/products/edb-postgres-extended) is a Postgres distribution that uses advanced logical replication of data and schema. + - [EDB Postgres Extended](https://www.enterprisedb.com/products/edb-postgres-extended) is a Postgres distribution that uses advanced logical replication of data and schema. It is only available if you select extreme high availability as your cluster type. 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. @@ -71,10 +65,10 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. In the **Instance Type** section, 1. Select the category that works best for your applications and workload: - Memory optimized for large data sets + - Compute optimized for compute bound applications - General purpose if you don't require memory or compute optimization. - 1. Select the instance series and size. - - See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) or [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/) for information to help you choose the appropriate instance type. + 1. Select the instance series and size. See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) or [Amazon EC2 Instance Types](https://aws.amazon.com/ec2/instance-types/) for information to help you choose the appropriate instance type. 1. In the **Storage** section, select your volume type from the **Volume Type** list. - For Azure, BigAnimal currently supports Azure Premium SSD storage types. In **Volume Properties**, select the type and amount of storage needed for your cluster. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. @@ -92,13 +86,6 @@ In the **Parameters** section, you can update the value of the database configur To update the parameter values, see [Modifying Your Database Configuration Parameters](../../using_cluster/03_modifying_your_cluster/05_db_configuration_parameters). -### Availability tab - - Enable or disable high availability using the **High Availability** control. High availability is enabled by default. - When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. - Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, only one instance is provisioned. - See [Supported Architectures](../../overview/02_high_availability) for more information. - ## What’s next After you create your cluster, use these resources to learn about cluster use and management: diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 1639f7dbf86..c4b878c2b55 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -38,7 +38,7 @@ Extreme high availability clusters are powered by EDB Postgres Distributed, a lo Extreme high availability clusters require EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is fully compatible with community PostgreSQL. -During the Beta, the components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. +During the beta, the components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. The leader node exists in one availability zone along with a shadow node. In another availability zone, there are two more *shadow* nodes. A third availability zone contains a witness node. The shadow nodes wait to take over when needed. If a node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. From e7808fc32715df5ad21d288163bd632df2cd1ad8 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 18 May 2022 15:01:23 -0400 Subject: [PATCH 13/31] missed one file that was copy edited --- .../release/using_cluster/03_modifying_your_cluster/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx b/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx index 2d48b377f90..27ab98c61c4 100644 --- a/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx @@ -29,10 +29,10 @@ You can modify your cluster by modifying: | Settings | Tab | | ----------------------------------- | ----------------------------------------------------------------------------------------- | | Cluster name and password | [Cluster Settings](../../getting_started/03_create_cluster/#cluster-settings-tab) | - | Instance type \* | [Cluster Settings](../../getting_started/03_create_cluster/#cluster-settings-tab) | + | Instance type \* | [Cluster Settings](../../getting_started/03_create_cluster/#cluster-settings-tab) | | Networking type (public or private) \**| [Cluster Settings](../../getting_started/03_create_cluster/#cluster-settings-tab)| | Database configuration parameters | [DB Configuration](05_db_configuration_parameters) | - | High availability (on or off) | [Availability](../../getting_started/03_create_cluster/#availability-tab) | + \* Changing the instance type could incur higher cloud infrastructure charges. From 3f5f89337ddb89bd718735aa16de82a8732de0c1 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 18 May 2022 19:50:38 -0400 Subject: [PATCH 14/31] Fixed database type description for EHA --- .../docs/biganimal/release/overview/02_high_availability.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index c4b878c2b55..5176d9a7b37 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -36,7 +36,7 @@ By default, replication is synchronous to one replica and asynchronous to the ot Extreme high availability clusters are powered by EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension providing multi-leader replication and data distribution with advanced conflict management, data-loss protection, and throughput up to 5X faster than native logical replication, and enables distributed PostgreSQL clusters with high availability up to five 9s. -Extreme high availability clusters require EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is fully compatible with community PostgreSQL. +Extreme high availability clusters can be deployed with either EDB Postgres Advanced Server or EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is compatible with open source PostgreSQL. During the beta, the components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. From 323a08a11ad309b8219124fee1baa1a29099d636 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 19 May 2022 16:28:20 -0400 Subject: [PATCH 15/31] Incorporated feedback from Natalia --- .../creating_a_cluster/index.mdx | 10 +++++----- .../release/overview/02_high_availability.mdx | 8 ++++++++ .../overview/05_database_version_policy.mdx | 18 +++++------------- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 8eb5792ff03..602616d5089 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -18,7 +18,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. 1. On the **Create Cluster** page, specify the cluster settings on the following tabs: - - [**Cluster Type**](#cluster-type-tab) + - [**Cluster Info**](#cluster-info-tab) - [**Cluster Settings**](#cluster-settings-tab) - [**DB Configuration** ](#db-configuration-tab) (optional) @@ -27,15 +27,15 @@ Prior to creating your cluster, make sure you have enough resources. Without eno !!! Note When you don't configure settings on optional tabs, the default values are used. -### Cluster Type tab +### Cluster Info tab 1. Select which type of cluster to deploy. - - [Single node](bigamimal/release/03_security/#single-node) creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. + - [Single node](bigamimal/release/03_security/#single-node) creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. You can create single node clusters running EDB Postgres Advanced Server or PostgreSQL. - - [High availability](bigamimal/release/03_security/#high-availability) creates a cluster with one primary and two standby replicas in different availability zones. + - [High availability](bigamimal/release/03_security/#high-availability) creates a cluster with one primary and two standby replicas in different availability zones. You can create high availability clusters running EDB Postgres Advanced Server or PostgreSQL. - - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. + - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. You can create extreme high availability clusters running EDB Postgres Advanced Server or EDB Postgres Extended Server. See [Supported architectures](/biganimal/release/overview/03_security) for more information about the different cluster types. diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 5176d9a7b37..38b59d5af47 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -11,6 +11,14 @@ BigAnimal supports three deployment architectures: You choose which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. +Postgres distribution type support varies by architecture. + +| Postgres distribution | Versions | Supported architectures | +| ---------------------------- | ------------ | ------------------------------------------------------------- | +| PostgreSQL | 11–14 | Single node, high availability | +| EDB Postgres Advanced Server | 11–14 | Single node, high availability, and extreme high availability | +| EDB Postgres Extended Server | 12-14 | Extreme high availability | + ## Single node For nonproduction use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one primary with no standby servers for failover or read-only workloads. diff --git a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx index 4855b5ada61..c08c24b6977 100644 --- a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx +++ b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx @@ -6,16 +6,8 @@ PostgreSQL and EDB Postgres Advanced Server major versions are supported from th ## Supported Postgres types and versions -**Single node and high availability clusters** - -| **Postgres type** | **Versions** | -| ---------------------------- | ------------ | -| PostgreSQL | 11–14 | -| EDB Postgres Advanced Server | 11–14 | - - -**Extreme high availability clusters (beta)** - -| **Postgres type** | **Versions** | -| ---------------------------- | ------------ | -| EDB Postgres Extended | 11-14 | +| Postgres distribution | Versions | +| ---------------------------- | ------------ | +| PostgreSQL | 11–14 | +| EDB Postgres Advanced Server | 11–14 | +| EDB Postgres Extended Server | 12-14 | From 17e2bd9bc732ffb5cc590eccc143286cc3999e61 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 19 May 2022 16:49:15 -0400 Subject: [PATCH 16/31] incorporated Natalia's comments --- .../docs/biganimal/release/overview/02_high_availability.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 38b59d5af47..5e92e1f01be 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -48,7 +48,7 @@ Extreme high availability clusters can be deployed with either EDB Postgres Adva During the beta, the components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. -The leader node exists in one availability zone along with a shadow node. In another availability zone, there are two more *shadow* nodes. A third availability zone contains a witness node. The shadow nodes wait to take over when needed. If a node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. +The leader node exists in one availability zone along with a *shadow* node. In another availability zone, there are two more shadow nodes. A third availability zone contains a *witness* node. The shadow nodes wait to take over when needed. If the leader node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. This architecture allows for higher performance and faster failover recovery compared to standard high availability. From 2258ab3a9bd4df12ff5d329878baf95415973caa Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 24 May 2022 05:59:20 -0400 Subject: [PATCH 17/31] Incorporating Ben's comments Co-authored-by: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> --- .../release/getting_started/creating_a_cluster/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 602616d5089..d04537fa257 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -61,7 +61,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. -1. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). +1. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB strongly recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). 1. In the **Instance Type** section, 1. Select the category that works best for your applications and workload: - Memory optimized for large data sets From 58e83ecee959d0f2fea444f96915877692a6d4ac Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 24 May 2022 06:07:57 -0400 Subject: [PATCH 18/31] Incorporating Ben's comments --- .../docs/biganimal/release/overview/02_high_availability.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 5e92e1f01be..17e0c66ae39 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -29,7 +29,7 @@ In case of permanent unavailability of the primary, a restore from a backup is r ## Standard high availability -The high availability option is provided to minimize downtime in cases of failures. High-availability clusters—one *primary* and two *replicas*—are configured automatically, with replicas staying up to date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across multiple availability zones to provide fault tolerance in the face of a datacenter failure. +The high availability option is provided to minimize downtime in cases of failures. High-availability clusters—one *primary* and two *replicas*—are configured automatically, with replicas staying up to date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across zones to provide fault tolerance in the face of a datacenter failure. - Replicas are usually called *standby servers*. - In case of temporary or permanent unavailability of the primary, a standby replica becomes the primary. From dc139966eff42130d5734802f6e08fc8f52c4a27 Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 24 May 2022 06:22:07 -0400 Subject: [PATCH 19/31] Incorporating Ben's comments --- .../docs/biganimal/release/overview/02_high_availability.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 17e0c66ae39..56525735b76 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -46,7 +46,7 @@ Extreme high availability clusters are powered by EDB Postgres Distributed, a lo Extreme high availability clusters can be deployed with either EDB Postgres Advanced Server or EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is compatible with open source PostgreSQL. -During the beta, the components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. +The components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. The leader node exists in one availability zone along with a *shadow* node. In another availability zone, there are two more shadow nodes. A third availability zone contains a *witness* node. The shadow nodes wait to take over when needed. If the leader node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. From f466121cfd94cbe5e91ee270e336d99c9e76647a Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 24 May 2022 11:00:52 -0400 Subject: [PATCH 20/31] Incorporating Ben's comments --- .../release/getting_started/creating_a_cluster/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index d04537fa257..c202b50e471 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -35,7 +35,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno - [High availability](bigamimal/release/03_security/#high-availability) creates a cluster with one primary and two standby replicas in different availability zones. You can create high availability clusters running EDB Postgres Advanced Server or PostgreSQL. - - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses logical replication to deliver faster failover and recovery. You can create extreme high availability clusters running EDB Postgres Advanced Server or EDB Postgres Extended Server. + - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses EDB Postgres Distributed's logical replication to deliver faster failover and recovery. You can create extreme high availability clusters running EDB Postgres Advanced Server or EDB Postgres Extended Server. See [Supported architectures](/biganimal/release/overview/03_security) for more information about the different cluster types. From f025a2fba09a2fe0b148ddec1255b2e13c9ba263 Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Tue, 24 May 2022 13:28:58 -0400 Subject: [PATCH 21/31] Incorporating Ben's comments --- .../release/getting_started/creating_a_cluster/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index c202b50e471..1097c133768 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -53,9 +53,9 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select the type of Postgres you want to use in the **Postgres Type** field: - - **Oracle Compatible** is powered by [EDB Postgres Advanced Server](/epas/latest/). View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). - - - [PostgreSQL](/supported-open-source/postgresql/) is an open-source object-relational database management system. + - [EDB Postgres Advanced Server](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). EDB Postgres Advanced Server is compatible with all three cluster types. + + - [PostgreSQL](/supported-open-source/postgresql/) is an open-source object-relational database management system. PostgreSQL is compatible with single node and high availability cluster types. - [EDB Postgres Extended](https://www.enterprisedb.com/products/edb-postgres-extended) is a Postgres distribution that uses advanced logical replication of data and schema. It is only available if you select extreme high availability as your cluster type. From 1a84bb979a9ac17e8135fbbee8792a5a168578ff Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 26 May 2022 14:57:55 -0400 Subject: [PATCH 22/31] Incorporated Aislinn's changes --- .../docs/biganimal/release/overview/02_high_availability.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 56525735b76..610bc758b8a 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -42,14 +42,13 @@ By default, replication is synchronous to one replica and asynchronous to the ot ## Extreme high availability (beta) -Extreme high availability clusters are powered by EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension providing multi-leader replication and data distribution with advanced conflict management, data-loss protection, and throughput up to 5X faster than native logical replication, and enables distributed PostgreSQL clusters with high availability up to five 9s. +Extreme high availability clusters are powered by EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension enabling higher performance and faster failover recovery compared to standard high availability. -Extreme high availability clusters can be deployed with either EDB Postgres Advanced Server or EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is compatible with open source PostgreSQL. +Extreme high availability clusters can be deployed with either EDB Postgres Advanced Server or EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is PostgreSQL compatible. The components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. The leader node exists in one availability zone along with a *shadow* node. In another availability zone, there are two more shadow nodes. A third availability zone contains a *witness* node. The shadow nodes wait to take over when needed. If the leader node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. -This architecture allows for higher performance and faster failover recovery compared to standard high availability. ![*BigAnimal Cluster4*](images/Extreme-HA-Diagram-2x.png) From 00b1d6dd9923d16a5085c22605ae32524984f0d8 Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 1 Jun 2022 04:46:55 -0400 Subject: [PATCH 23/31] Incorporating Ben's comments-round 2 Incorporating Ben's comments-2nd round Incorporating Ben's comments-round 2 Incorporating Ben's comments Incorporated Ben's comments-round 2 Incorporated Ben's comments-round 2 Incorporated Ben's comments-round 2 Co-Authored-By: Benjamin Anderson <79652654+ba-edb@users.noreply.github.com> --- .../getting_started/creating_a_cluster/index.mdx | 12 ++++++------ .../release/overview/02_high_availability.mdx | 14 +++++++------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 1097c133768..8798a170e33 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -35,12 +35,12 @@ Prior to creating your cluster, make sure you have enough resources. Without eno - [High availability](bigamimal/release/03_security/#high-availability) creates a cluster with one primary and two standby replicas in different availability zones. You can create high availability clusters running EDB Postgres Advanced Server or PostgreSQL. - - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses EDB Postgres Distributed's logical replication to deliver faster failover and recovery. You can create extreme high availability clusters running EDB Postgres Advanced Server or EDB Postgres Extended Server. + - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses EDB Postgres Distributed to deliver higher performance and faster recovery. You can create extreme high availability clusters with either Postgres-compatible or Oracle-compatible database engines. See [Supported architectures](/biganimal/release/overview/03_security) for more information about the different cluster types. !!! Note - You can't switch from a single node cluster or a high availability node to an extreme high availability node or vice versa. + You can't switch from a single node or high availability cluster to an extreme high availability cluster or vice versa. 1. Select the cloud provider for your cluster. If you're using your own account and haven't connected it to BigAnimal yet, see [Set up your cloud service provider](/biganimal/latest/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud/#setting-up-your-cloud-service-provider). @@ -53,15 +53,15 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select the type of Postgres you want to use in the **Postgres Type** field: - - [EDB Postgres Advanced Server](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). EDB Postgres Advanced Server is compatible with all three cluster types. + - **Oracle Compatible** is powered by [EDB Postgres Advanced Server](/epas/latest/). View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). EDB Postgres Advanced Server is compatible with all three cluster types. - - [PostgreSQL](/supported-open-source/postgresql/) is an open-source object-relational database management system. PostgreSQL is compatible with single node and high availability cluster types. + - **[PostgreSQL](/supported-open-source/postgresql/)** is an open-source object-relational database management system. PostgreSQL is compatible with single node and high availability cluster types. - - [EDB Postgres Extended](https://www.enterprisedb.com/products/edb-postgres-extended) is a Postgres distribution that uses advanced logical replication of data and schema. It is only available if you select extreme high availability as your cluster type. + - **PostgreSQL Compatible** is powered by [EDB Postgres Extended Server](https://www.enterprisedb.com/products/edb-postgres-extended). It uses advanced logical replication of data and schema. It is only available if you select extreme high availability as your cluster type. 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. -1. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB strongly recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). +1. In the **Region** section, select the region where you want to deploy your cluster. For the best performance, EDB strongly recommends that this region be the same as your other resources that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). If you are interested in deploying a cluster to a region that isn't currently available, contact [Support](docs/biganimal/latest/overview/support/). 1. In the **Instance Type** section, 1. Select the category that works best for your applications and workload: - Memory optimized for large data sets diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 610bc758b8a..b0663238730 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -9,21 +9,21 @@ BigAnimal supports three deployment architectures: - Standard high availability - Extreme high availability (beta) -You choose which type of deployment you want when creating your cluster on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. +You choose which type of cluster you want on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. Postgres distribution type support varies by architecture. | Postgres distribution | Versions | Supported architectures | | ---------------------------- | ------------ | ------------------------------------------------------------- | | PostgreSQL | 11–14 | Single node, high availability | -| EDB Postgres Advanced Server | 11–14 | Single node, high availability, and extreme high availability | -| EDB Postgres Extended Server | 12-14 | Extreme high availability | +| Oracle Compatible | 11–14 | Single node, high availability, and extreme high availability | +| PostgreSQL Compatible | 12-14 | Extreme high availability | ## Single node For nonproduction use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one primary with no standby servers for failover or read-only workloads. -In case of permanent unavailability of the primary, a restore from a backup is required. +In case of unrecoverable failure of the primary, a restore from a backup is required. ![*BigAnimal Cluster4*](images/Single-Node-Diagram-2x.png) @@ -42,13 +42,13 @@ By default, replication is synchronous to one replica and asynchronous to the ot ## Extreme high availability (beta) -Extreme high availability clusters are powered by EDB Postgres Distributed, a logical replication tool that delivers more advanced cluster management compared to a physical replication based system. The primary component of EDB Postgres Distributed is Bi-Directional Replication (BDR). BDR is a PostgreSQL extension enabling higher performance and faster failover recovery compared to standard high availability. +Extreme high availability clusters are powered by EDB Postgres Distributed, a logical replication platform that delivers more advanced cluster management compared to a physical replication based system. Extreme high availability clusters can be deployed with either EDB Postgres Advanced Server or EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is PostgreSQL compatible. -The components of an extreme high availability cluster are all in one cloud region with the nodes distributed among three availability zones (A, B, C). One BDR node is designated the *leader* node (A.1). High Availability Routing for Postgres (HARP) routes all application traffic in a single data center or region to the leader node, which acts as the principle write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. +Extreme High Availability clusters are deployed with nodes distributed among three availability zones (A, B, and C in the diagram below). The "BDR" nodes host customer data; one BDR node is designated the *leader* node (A.1 in the diagram). The EDB Distributed Postgres router (HARP) routes all application traffic to the leader node, which acts as the principal write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. -The leader node exists in one availability zone along with a *shadow* node. In another availability zone, there are two more shadow nodes. A third availability zone contains a *witness* node. The shadow nodes wait to take over when needed. If the leader node loses contact, BigAnimal switches immediately to a shadow node to continue processing. The witness node, as an odd numbered node, can make decisions that require consensus, such as generating new global sequences or distributed DDL operations. This is a normal BDR node that is deliberately set up not to replicate any tables or data to it. +Extreme High Availability clusters deploy four data-hosting "BDR" nodes across two availability zones. One of these nodes will be the leader at any given time. The rest are typically referred to as "shadow" nodes. Any shadow node can be promoted to leadership at any time by the HARP router. The third availability zone contains one node called the "witness". This node does not host data; it exists only for management purposes, to support operations that require consensus in case of an availability zone failure. ![*BigAnimal Cluster4*](images/Extreme-HA-Diagram-2x.png) From 2f082bc95ba31b15c84c49c3b900507834ff7a61 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Fri, 3 Jun 2022 18:24:04 -0400 Subject: [PATCH 24/31] Incorporated Kelly's feedback and standardized terminology --- .../creating_a_cluster/index.mdx | 8 +++--- .../01_preparing_azure/index.mdx | 2 +- .../02_preparing_aws.mdx | 2 +- .../release/overview/02_high_availability.mdx | 26 ++++++++--------- .../overview/04_responsibility_model.mdx | 2 +- .../release/pricing_and_billing/index.mdx | 2 +- .../metrics/index.mdx | 28 +++++++++---------- .../monitoring_from_aws/index.mdx | 2 +- .../monitoring_from_azure/index.mdx | 2 +- 9 files changed, 36 insertions(+), 38 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index 8798a170e33..d1d73b86c90 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -31,13 +31,13 @@ Prior to creating your cluster, make sure you have enough resources. Without eno 1. Select which type of cluster to deploy. - - [Single node](bigamimal/release/03_security/#single-node) creates a cluster with one primary and no standby servers. Suited for test environments where high availability might not be required. You can create single node clusters running EDB Postgres Advanced Server or PostgreSQL. + - [Single node](bigamimal/release/03_security/#single-node) creates a cluster with one primary and no standby replicas. Suited for test environments where high availability might not be required. You can create single node clusters running EDB Postgres Advanced Server or PostgreSQL. - [High availability](bigamimal/release/03_security/#high-availability) creates a cluster with one primary and two standby replicas in different availability zones. You can create high availability clusters running EDB Postgres Advanced Server or PostgreSQL. - - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses EDB Postgres Distributed to deliver higher performance and faster recovery. You can create extreme high availability clusters with either Postgres-compatible or Oracle-compatible database engines. + - [Extreme high availability (beta)](bigamimal/release/03_security/#extreme-high-availability-beta) creates a cluster configured with a leader node, three shadow nodes, and one witness node. This cluster uses EDB Postgres Distributed to deliver higher performance and faster recovery. You can create extreme high availability clusters with either PostgreSQL or Oracle compatibility. - See [Supported architectures](/biganimal/release/overview/03_security) for more information about the different cluster types. + See [Supported cluster types](/biganimal/release/overview/03_security) for more information about the different cluster types. !!! Note You can't switch from a single node or high availability cluster to an extreme high availability cluster or vice versa. @@ -57,7 +57,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno - **[PostgreSQL](/supported-open-source/postgresql/)** is an open-source object-relational database management system. PostgreSQL is compatible with single node and high availability cluster types. - - **PostgreSQL Compatible** is powered by [EDB Postgres Extended Server](https://www.enterprisedb.com/products/edb-postgres-extended). It uses advanced logical replication of data and schema. It is only available if you select extreme high availability as your cluster type. + - **PostgreSQL Compatible** uses advanced logical replication of data and schema. It is only available if you select extreme high availability as your cluster type. 1. In the **Postgres Version** list, select the version of Postgres that you want to use. See [Database version policy](../../overview/05_database_version_policy) for more information. diff --git a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx index 6de93232668..640519ff23a 100644 --- a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx @@ -44,7 +44,7 @@ EDB provides a shell script, called [`biganimal-preflight-azure`](https://github | ------- | ----------- | | `-h` or `--help`| Displays the command help. | | `-i` or `--instance-type` | Azure VM instance type for the BigAnimal cluster. The `help` command provides a list of possible VM instance types. Choose the instance type that best suits your application and workload. Choose an instance type in the memory optimized ESv3 or ESv4 series for large data sets. Choose from the compute optimized FSv2 series for compute-bound applications. Choose from the general purpose DSv3 or DSv4 series if you don't require memory or compute optimization. See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for information to help you choose the appropriate instance type. | - | `-a` or `--high-availability` | Enables high availability for the cluster. See [Supported architectures](/biganimal/release/overview/02_high_availability) for more information.| + | `-a` or `--high-availability` | Enables high availability for the cluster. See [Supported cluster types](/biganimal/release/overview/02_high_availability) for more information.| | `-e` or `--endpoint` | Type of network endpoint for the BigAnimal cluster, either `public` or `private`. See [Cluster networking architecture](/biganimal/release/getting_started/creating_a_cluster/01_cluster_networking) for more information. | | `-r` or `--activate-region` | Specifies region activation if no clusters currently exist in the region. | | `--onboard` | Checks if the user and subscription are correctly configured. diff --git a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx index 2612f1ecb2d..7cca53dc7c1 100644 --- a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx +++ b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx @@ -30,7 +30,7 @@ EDB provides a shell script, called [biganimal-csp-preflight](https://github.com | ------- | ----------- | | `-h` or `--help`| Displays the command help. | | `-i` or `--instance-type` | AWS instance type for the BigAnimal cluster. The help command provides a list of possible VM instance types. Choose the instance type that best suits your application and workload. Choose an instance type in the memory optimized R5, R5B, or R6I series for large data sets. Choose from the compute-optimized C5 or C6I series for compute-bound applications. Choose from the general purpose M5 or M6I series if you don't require memory or compute optimization.| - | `-a` or `--high-availability` | Enables high availability for the cluster. See [Supported architectures](../../overview/02_high_availability) for more information.| + | `-a` or `--high-availability` | Enables high availability for the cluster. See [Supported cluster types(../../overview/02_high_availability) for more information.| | `-e` or `--endpoint` | Type of network endpoint for the BigAnimal cluster, either `public` or `private`. See [Cluster networking architecture](../creating_a_cluster/01_cluster_networking) for more information. | | `-r` or `--activate-region` | Specifies region activation if no clusters currently exist in the region. | | `--onboard` | Checks if the user and subscription are correctly configured. diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index b0663238730..21b05acb0af 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -1,19 +1,19 @@ --- -title: "Supported architectures" +title: "Supported cluster types" redirects: - 02_high_availibility --- -BigAnimal supports three deployment architectures: +BigAnimal supports three cluster types: - Single node - Standard high availability - Extreme high availability (beta) You choose which type of cluster you want on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal. -Postgres distribution type support varies by architecture. +Postgres distribution and version support varies by cluster type. -| Postgres distribution | Versions | Supported architectures | +| Postgres distribution | Versions | Cluster type | | ---------------------------- | ------------ | ------------------------------------------------------------- | | PostgreSQL | 11–14 | Single node, high availability | | Oracle Compatible | 11–14 | Single node, high availability, and extreme high availability | @@ -21,7 +21,7 @@ Postgres distribution type support varies by architecture. ## Single node -For nonproduction use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one primary with no standby servers for failover or read-only workloads. +For nonproduction use cases where high availability is not a primary concern, a cluster deployment with high availability not enabled provides one primary with no standby replicas for failover or read-only workloads. In case of unrecoverable failure of the primary, a restore from a backup is required. @@ -29,26 +29,24 @@ In case of unrecoverable failure of the primary, a restore from a backup is requ ## Standard high availability -The high availability option is provided to minimize downtime in cases of failures. High-availability clusters—one *primary* and two *replicas*—are configured automatically, with replicas staying up to date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across zones to provide fault tolerance in the face of a datacenter failure. +The high availability option is provided to minimize downtime in cases of failures. High-availability clusters—one *primary* and two *standby replicas*—are configured automatically, with standby replicas staying up to date through physical streaming replication. In cloud regions with availability zones, clusters are provisioned across zones to provide fault tolerance in the face of a datacenter failure. -- Replicas are usually called *standby servers*. -- In case of temporary or permanent unavailability of the primary, a standby replica becomes the primary. +In case of temporary or permanent unavailability of the primary, a standby replica becomes the primary. ![*BigAnimal Cluster4*](images/HA-diagram-2x.png) -Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica is automatically promoted to primary, and new connections are routed to the new primary. When the old primary recovers, it rejoins the cluster as a replica. +Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica is automatically promoted to primary, and new connections are routed to the new primary. When the old primary recovers, it rejoins the cluster as a standby replica. -By default, replication is synchronous to one replica and asynchronous to the other. That is, one replica must confirm that a transaction record was written to disk before the client receives acknowledgment of a successful commit. In PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. You can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. +By default, replication is synchronous to one standby replica and asynchronous to the other. That is, one standby replica must confirm that a transaction record was written to disk before the client receives acknowledgment of a successful commit. In PostgreSQL terms, `synchronous_commit` is set to `on` and `synchronous_standby_names` is set to `ANY 1 (replica-1, replica-2)`. You can modify this behavior on a per-transaction, per-session, per-user, or per-database basis with appropriate `SET` or `ALTER` commands. ## Extreme high availability (beta) Extreme high availability clusters are powered by EDB Postgres Distributed, a logical replication platform that delivers more advanced cluster management compared to a physical replication based system. -Extreme high availability clusters can be deployed with either EDB Postgres Advanced Server or EDB Postgres Extended Server as the database type. EDB Postgres Extended Server is PostgreSQL compatible. +Extreme high availability clusters can be deployed with either PostgreSQL or Oracle compatibility. -Extreme High Availability clusters are deployed with nodes distributed among three availability zones (A, B, and C in the diagram below). The "BDR" nodes host customer data; one BDR node is designated the *leader* node (A.1 in the diagram). The EDB Distributed Postgres router (HARP) routes all application traffic to the leader node, which acts as the principal write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. - -Extreme High Availability clusters deploy four data-hosting "BDR" nodes across two availability zones. One of these nodes will be the leader at any given time. The rest are typically referred to as "shadow" nodes. Any shadow node can be promoted to leadership at any time by the HARP router. The third availability zone contains one node called the "witness". This node does not host data; it exists only for management purposes, to support operations that require consensus in case of an availability zone failure. +Extreme High Availability clusters deploy four data-hosting "BDR" nodes across two availability zones (A and B in the diagram below). One of these nodes will be the leader at any given time (A.1 in the diagram). The rest are typically referred to as "shadow" nodes. Any shadow node can be promoted to leadership at any time by the HARP router. The third availability zone (C) contains one node called the "witness". This node does not host data; it exists only for management purposes, to support operations that require consensus in case of an availability zone failure. +The EDB Postgres Distributed router (HARP) routes all application traffic to the leader node, which acts as the principal write target to reduce the potential for data conflicts. HARP leverages a distributed consensus model to determine availability of the BDR nodes in the cluster. On failure or unavailability of the leader, HARP elects a new leader and redirects application traffic. Together with the core capabilities of BDR, this mechanism of routing application traffic to the leader node enables fast failover and switchover without risk of data loss. ![*BigAnimal Cluster4*](images/Extreme-HA-Diagram-2x.png) diff --git a/product_docs/docs/biganimal/release/overview/04_responsibility_model.mdx b/product_docs/docs/biganimal/release/overview/04_responsibility_model.mdx index 62fa359e257..fa037245e8a 100644 --- a/product_docs/docs/biganimal/release/overview/04_responsibility_model.mdx +++ b/product_docs/docs/biganimal/release/overview/04_responsibility_model.mdx @@ -8,7 +8,7 @@ The following responsibility model describes the distribution of specific respon ## High availability -- EDB is responsible for deploying clusters with one primary and two replicas. In cloud regions with availability zones, clusters are deployed across multiple availability zones. +- EDB is responsible for deploying clusters with one primary and two standby replicas. In cloud regions with availability zones, clusters are deployed across multiple availability zones. - You are responsible for choosing whether to enable high availability. - You are responsible for ensuring your applications reconnect when network connectivity is interrupted. diff --git a/product_docs/docs/biganimal/release/pricing_and_billing/index.mdx b/product_docs/docs/biganimal/release/pricing_and_billing/index.mdx index d7f20a1abd5..29403ca1312 100644 --- a/product_docs/docs/biganimal/release/pricing_and_billing/index.mdx +++ b/product_docs/docs/biganimal/release/pricing_and_billing/index.mdx @@ -6,7 +6,7 @@ The costs include database pricing for BigAnimal and the associated costs from o ## Database pricing -Pricing is based on the number of virtual central processing units (vCPUs) provisioned for the database software offering. Consumption of vCPUs is metered hourly. A deployment is made up of either one instance or one primary and two replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, multiply the number of vCPUs per instance by three to calculate the full price for all resources used. The table shows the cost breakdown: +Pricing is based on the number of virtual central processing units (vCPUs) provisioned for the database software offering. Consumption of vCPUs is metered hourly. A deployment is made up of either one instance or one primary and two standby replica instances of either PostgreSQL or EDB Postgres Advanced Server. When high availability is enabled, multiply the number of vCPUs per instance by three to calculate the full price for all resources used. The table shows the cost breakdown: | Database type | Hourly price | Monthly price\* | | ---------------------------- | -------------- | --------------- | diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/index.mdx index ca21f92b6f1..4a6a48731ae 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/index.mdx @@ -109,12 +109,12 @@ Derived from the `pg_postmaster_start_time()` function. #### Group `cnp_pg_replication` -Physical replication details for a standby postgres instance -as captured from the standby. +Physical replication details for a standby reolica postgres instance +as captured from the standby replica. Derived from the `pg_last_xact_replay_timestamp()` function. -Relevant only on standby servers. +Relevant only on standby replicas. See also `cnp_pg_stat_replication`, `cnp_pg_replication_slots`. @@ -263,18 +263,18 @@ This group of metrics can have these labels: #### Group `cnp_pg_stat_database_conflicts` -These metrics provide information on conflicts between queries on a standby -and the standby's replay of the change-stream from the primary. These are +These metrics provide information on conflicts between queries on a standby replica +and the standby replica's replay of the change-stream from the primary. These are called recovery conflicts. These metrics are unrelated to "INSERT ... ON CONFLICT" conflicts or multi-master replication row conflicts. They are relevant only on standby -servers. +replicas. Metrics in this section are reset when a postgres stats reset is issued on the db server. -Only defined on standby servers. +Only defined on standby replicas. Derived from the `pg_stat_database_conflicts` view. @@ -359,14 +359,14 @@ See also `cnp_pg_replication_slots`, `cnp_pg_replication`. | Metric | Usage | Description | | -------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `cnp_pg_stat_replication_backend_start` | COUNTER | Time when this process started | -| `cnp_pg_stat_replication_backend_xmin_age` | COUNTER | The age of this standby's xmin horizon | +| `cnp_pg_stat_replication_backend_xmin_age` | COUNTER | The age of this standby replica's xmin horizon | | `cnp_pg_stat_replication_sent_diff_bytes` | GAUGE | Difference in bytes from the last write-ahead log location sent on this connection | -| `cnp_pg_stat_replication_write_diff_bytes` | GAUGE | Difference in bytes from the last write-ahead log location written to disk by this standby server | -| `cnp_pg_stat_replication_flush_diff_bytes` | GAUGE | Difference in bytes from the last write-ahead log location flushed to disk by this standby server | -| `cnp_pg_stat_replication_replay_diff_bytes` | GAUGE | Difference in bytes from the last write-ahead log location replayed into the database on this standby server | -| `cnp_pg_stat_replication_write_lag_seconds` | GAUGE | Time elapsed between flushing recent WAL locally and receiving notification that this standby server wrote it | -| `cnp_pg_stat_replication_flush_lag_seconds` | GAUGE | Time elapsed between flushing recent WAL locally and receiving notification that this standby server wrote and flushed it | -| `cnp_pg_stat_replication_replay_lag_seconds` | GAUGE | Time elapsed between flushing recent WAL locally and receiving notification that this standby server wrote, flushed, and applied it | +| `cnp_pg_stat_replication_write_diff_bytes` | GAUGE | Difference in bytes from the last write-ahead log location written to disk by this standby replica | +| `cnp_pg_stat_replication_flush_diff_bytes` | GAUGE | Difference in bytes from the last write-ahead log location flushed to disk by this standby replica | +| `cnp_pg_stat_replication_replay_diff_bytes` | GAUGE | Difference in bytes from the last write-ahead log location replayed into the database on this standby replica | +| `cnp_pg_stat_replication_write_lag_seconds` | GAUGE | Time elapsed between flushing recent WAL locally and receiving notification that this standby replica wrote it | +| `cnp_pg_stat_replication_flush_lag_seconds` | GAUGE | Time elapsed between flushing recent WAL locally and receiving notification that this standby replica wrote and flushed it | +| `cnp_pg_stat_replication_replay_lag_seconds` | GAUGE | Time elapsed between flushing recent WAL locally and receiving notification that this standby replica wrote, flushed, and applied it | ##### Labels diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_aws/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_aws/index.mdx index 645723f1640..3c3a14c1322 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_aws/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_aws/index.mdx @@ -91,7 +91,7 @@ have at least the following labels: | ---------------------------- | ------------------------------------------------------------- | | instance | IP address of the host the metric originated from | | postgresql | BigAnimal postgres cluster identifier, e.g., `p-abcdef012345` | -| role | Postgres instance role, "primary" or "replica" | +| role | Postgres instance role, "primary" or "standby replica" | | datname | Postgres database name (where applicable) | | pod | k8s pod name | | aks_cluster_name | AKS cluster name | diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_azure/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_azure/index.mdx index 592f623c7a7..cb4e412c092 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_azure/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/monitoring_from_azure/index.mdx @@ -98,7 +98,7 @@ have at least the following labels: | ---------------------------- | ------------------------------------------------------------- | | instance | IP address of the host the metric originated from | | postgresql | BigAnimal postgres cluster identifier, e.g., `p-abcdef012345` | -| role | Postgres instance role, "primary" or "replica" | +| role | Postgres instance role, "primary" or "standby replica" | | datname | Postgres database name (where applicable) | | pod | k8s pod name | | aks_cluster_name | AKS cluster name | From fc4ab4818b7a6b426a11547b29c9f16269c77bfd Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 15 Jun 2022 18:37:39 -0400 Subject: [PATCH 25/31] updated database version support --- .../biganimal/release/overview/05_database_version_policy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx index c08c24b6977..1f5512cfd5b 100644 --- a/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx +++ b/product_docs/docs/biganimal/release/overview/05_database_version_policy.mdx @@ -9,5 +9,5 @@ PostgreSQL and EDB Postgres Advanced Server major versions are supported from th | Postgres distribution | Versions | | ---------------------------- | ------------ | | PostgreSQL | 11–14 | -| EDB Postgres Advanced Server | 11–14 | +| EDB Postgres Advanced Server | 11–14, 12-14 for extreme high availability clusters | | EDB Postgres Extended Server | 12-14 | From ee15681c88b4c9a2f171b48ce8b5a20cef28f101 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Thu, 16 Jun 2022 13:49:01 +0530 Subject: [PATCH 26/31] EPAS 14.4 New release branch - Added release notes --- .../epas/14/epas_rel_notes/epas14_3_0_rel_notes.mdx | 2 +- .../epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx | 13 +++++++++++++ product_docs/docs/epas/14/epas_rel_notes/index.mdx | 6 ++++-- 3 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx diff --git a/product_docs/docs/epas/14/epas_rel_notes/epas14_3_0_rel_notes.mdx b/product_docs/docs/epas/14/epas_rel_notes/epas14_3_0_rel_notes.mdx index c391662a6fe..861191c4c14 100644 --- a/product_docs/docs/epas/14/epas_rel_notes/epas14_3_0_rel_notes.mdx +++ b/product_docs/docs/epas/14/epas_rel_notes/epas14_3_0_rel_notes.mdx @@ -6,7 +6,7 @@ EDB Postgres Advanced Server 14.3.0 includes the following bug fixes: | Type | Description | ID | Category | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------| ------- | ---------------- | -| Upstream merge | Merged with community PostgreSQL 14.2. See the community [Release Notes](https://www.postgresql.org/docs/release/14.3/) for details. | | | +| Upstream merge | Merged with community PostgreSQL 14.3. See the community [Release Notes](https://www.postgresql.org/docs/release/14.3/) for details. | | | | Bug fix | Add syntax check for TABLE(...) clause. [Support Ticket: #81624] | DB-1752 | | | Bug fix | Add an appropriate cast for const TIMESTAMP and TIMESTAMPTZ to the query pushed to the remote servers. [Support Ticket: #72928] | DB-1493 | oci_dblink | | Bug fix | Do not push expressions to remote servers involving INTERVAL data type since representation in EPAS/PostgreSQL is different. | DB-1493 | oci_dblink | diff --git a/product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx b/product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx new file mode 100644 index 00000000000..259417479a7 --- /dev/null +++ b/product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx @@ -0,0 +1,13 @@ +--- +title: "Version 14.4.0" +--- + +EDB Postgres Advanced Server 14.4.0 includes the following bug fixes: + +| Type | Description | ID | Category | +| -------------- | -------------------------------------------------------------------------------------------------------------------------------------| ------- | --------------------- | +| Upstream merge | Merged with community PostgreSQL 14.4. See the community [Release Notes](https://www.postgresql.org/docs/release/14.4/) for details. | | | +| Bug fix | Fix server crash while executing the function which returns TABLE and requires casting on attributes. [Support Ticket: #81924] | DB-1778 | | +| Bug fix | psql: Fix \dn command query. | DB-1777 | General functionality | + + diff --git a/product_docs/docs/epas/14/epas_rel_notes/index.mdx b/product_docs/docs/epas/14/epas_rel_notes/index.mdx index 86ffc19db3c..89bb211b0fd 100644 --- a/product_docs/docs/epas/14/epas_rel_notes/index.mdx +++ b/product_docs/docs/epas/14/epas_rel_notes/index.mdx @@ -2,6 +2,7 @@ navTitle: Release notes title: "EDB Postgres Advanced Server release notes" navigation: +- epas14_4_0_rel_notes - epas14_3_0_rel_notes - 19_epas14.2.1_rel_notes - 20_epas14_rel_notes @@ -13,6 +14,7 @@ The EDB Postgres Advanced Server (EDB Postgres Advanced Server) documentation de | Version | Release date | Upstream merges | | ------------------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------- | -| [14.3.0](epas14_3_0_rel_notes) | 2022 May 12 | [14.3](https://www.postgresql.org/docs/14/release-14-2.html) | +| [14.4.0](epas14_4_0_rel_notes) | 2022 Jun 16 | [14.4](https://www.postgresql.org/docs/14/release-14-4.html) | +| [14.3.0](epas14_3_0_rel_notes) | 2022 May 12 | [14.3](https://www.postgresql.org/docs/14/release-14-3.html) | | [14.2.1](19_epas14.2.1_rel_notes) | 2022 Feb 10 | [14.2](https://www.postgresql.org/docs/14/release-14-2.html) | -| [14.1.0](20_epas14_rel_notes) | 2021 Dec 01 | [14.0](https://www.postgresql.org/docs/14/release-14.html), [14.1](https://www.postgresql.org/docs/14/release-14-1.html) | +| [14.1.0](20_epas14_rel_notes) | 2021 Dec 01 | [14.0](https://www.postgresql.org/docs/14/release-14.html), [14.1](https://www.postgresql.org/docs/14/release-14-1.html) | From 6f0d75d38d021327d644f39437b2dd1bb78ac514 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 16 Jun 2022 05:17:23 -0400 Subject: [PATCH 27/31] updated db support for eha on supported cluster types topic --- .../release/overview/02_high_availability.mdx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 21b05acb0af..57dc4a69032 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -13,11 +13,12 @@ You choose which type of cluster you want on the [Create Cluster](https://portal Postgres distribution and version support varies by cluster type. -| Postgres distribution | Versions | Cluster type | -| ---------------------------- | ------------ | ------------------------------------------------------------- | -| PostgreSQL | 11–14 | Single node, high availability | -| Oracle Compatible | 11–14 | Single node, high availability, and extreme high availability | -| PostgreSQL Compatible | 12-14 | Extreme high availability | +| Postgres distribution | Versions | Cluster type | +| ---------------------------- | ------------ | ------------------------------ | +| PostgreSQL | 11–14 | Single node, high availability | +| Oracle Compatible | 11–14 | Single node, high availability | +| Oracle Compatible | 12–14 | Extreme high availability | +| PostgreSQL Compatible | 12-14 | Extreme high availability | ## Single node From 0423915b62d70da55d86548ecb67233b6bfe6e4c Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Thu, 16 Jun 2022 15:29:35 +0530 Subject: [PATCH 28/31] Updated as per DeeDee's comment --- .../docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx b/product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx index 259417479a7..78171c5578f 100644 --- a/product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx +++ b/product_docs/docs/epas/14/epas_rel_notes/epas14_4_0_rel_notes.mdx @@ -8,6 +8,6 @@ EDB Postgres Advanced Server 14.4.0 includes the following bug fixes: | -------------- | -------------------------------------------------------------------------------------------------------------------------------------| ------- | --------------------- | | Upstream merge | Merged with community PostgreSQL 14.4. See the community [Release Notes](https://www.postgresql.org/docs/release/14.4/) for details. | | | | Bug fix | Fix server crash while executing the function which returns TABLE and requires casting on attributes. [Support Ticket: #81924] | DB-1778 | | -| Bug fix | psql: Fix \dn command query. | DB-1777 | General functionality | +| Bug fix | Fix \dn command query. | DB-1777 | psql | From 6bda14032a76c015692a3abcb5721b07a688c444 Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Thu, 16 Jun 2022 19:40:02 +0530 Subject: [PATCH 29/31] Added 55.2.3 release notes --- .../migration_toolkit/55/mtk_rel_notes/index.mdx | 8 ++++++++ .../55/mtk_rel_notes/mtk_5523_rel_notes.mdx | 15 +++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx diff --git a/product_docs/docs/migration_toolkit/55/mtk_rel_notes/index.mdx b/product_docs/docs/migration_toolkit/55/mtk_rel_notes/index.mdx index 7ce3840a455..abb3f11b07e 100644 --- a/product_docs/docs/migration_toolkit/55/mtk_rel_notes/index.mdx +++ b/product_docs/docs/migration_toolkit/55/mtk_rel_notes/index.mdx @@ -2,12 +2,20 @@ title: "Release notes" redirects: - ../01_whats_new/ +navigation: + - mtk_5523_rel_notes + - 05_mkt_5522_rel_notes + - 06_mkt_5521_rel_notes + - 07_mkt_552_rel_notes + - 08_mkt_551_rel_notes + - 09_mkt_55_rel_notes --- The Migration Toolkit documentation describes the latest version of Migration Toolkit 55 including minor releases and patches. The release notes in this section provide information on what was new in each release. For new functionality introduced in a minor or patch release, there are also indicators within the content about what release introduced the feature. | Version | Release Date | | ------- | ------------ | +| [55.2.3](mtk_5523_rel_notes) | 2022 Jun 16 | | [55.2.2](05_mkt_5522_rel_notes) | 2022 Mar 10 | | [55.2.1](06_mkt_5521_rel_notes) | 2022 Jan 13 | | [55.2.0](07_mkt_552_rel_notes) | 2021 Dec 2 | diff --git a/product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx b/product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx new file mode 100644 index 00000000000..63dc02e4316 --- /dev/null +++ b/product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx @@ -0,0 +1,15 @@ +--- +title: "Version 55.2.3" +--- + +New features, enhancements, bug fixes, and other changes in Migration Toolkit 55.2.3 include: + +| Type | Description | +| ------------ |------------ | +| Bug Fix | Fixed an issue where the Oracle table migration to EPAS fails when a column definition includes a sequence with NEXTVAL call as the default clause. | +| Bug Fix | Fixed an issue that caused a migration failure for a table with a column named after the POSITION keyword. | +| Bug Fix | Corrected the MTK Windows installer so that it removes the older version of commons-lang library as part of the upgrade process. | +| Bug Fix | Corrected some of the information/error messages to report schema-qualified table names. | + + + From f97796fc43ad0d1fd55c937e4d14d65bc0ab6fca Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Wed, 15 Jun 2022 14:39:44 +0530 Subject: [PATCH 30/31] Updated URL based on slack conversation and added link to jtds driver Updated based on feedback from Zahid --- .../55/06_building_toolkit.properties_file.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/migration_toolkit/55/06_building_toolkit.properties_file.mdx b/product_docs/docs/migration_toolkit/55/06_building_toolkit.properties_file.mdx index 37cdd5f461c..1074f8c75ac 100644 --- a/product_docs/docs/migration_toolkit/55/06_building_toolkit.properties_file.mdx +++ b/product_docs/docs/migration_toolkit/55/06_building_toolkit.properties_file.mdx @@ -210,8 +210,6 @@ When migrating from MySQL, `SRC_DB_URL` takes the form of a JDBC URL. For exampl jdbc:mysql://[:]/ ``` - - The URL contains the following information: - `jdbc` — The protocol is always `jdbc`. @@ -262,6 +260,8 @@ When migrating from Sybase, `SRC_DB_URL` takes the form of a JTDS URL. For examp ```text jdbc:jtds:sybase://[:]/ ``` +!!! Tip + For an open source JDBC 3.0 type 4 driver for Microsoft SQL Server and Sybase ASE, see [http://jtds.sourceforge.net/](http://jtds.sourceforge.net/). A Sybase URL contains the following information: @@ -300,8 +300,10 @@ Migration Toolkit reads connection specifications for the source database from t If you're connecting to a SQL Server database, `SRC_DB_URL` takes the form of a JTDS URL. For example: ```text -jdbc:jtds:sqlserver:\\[:]\ +jdbc:jtds:sqlserver://:/ ``` +!!! Tip + For an open source JDBC 3.0 type 4 driver for Microsoft SQL Server and Sybase ASE, see [http://jtds.sourceforge.net/](http://jtds.sourceforge.net/). A SQL server URL contains the following information: From cba1e982310fe0d9b0086cb3fac5c56d543d994d Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Thu, 16 Jun 2022 11:59:16 -0400 Subject: [PATCH 31/31] Used full product names --- .../migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx b/product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx index 63dc02e4316..40aee90c62c 100644 --- a/product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx +++ b/product_docs/docs/migration_toolkit/55/mtk_rel_notes/mtk_5523_rel_notes.mdx @@ -6,9 +6,9 @@ New features, enhancements, bug fixes, and other changes in Migration Toolkit 55 | Type | Description | | ------------ |------------ | -| Bug Fix | Fixed an issue where the Oracle table migration to EPAS fails when a column definition includes a sequence with NEXTVAL call as the default clause. | +| Bug Fix | Fixed an issue where the Oracle table migration to EDB Postgres Advanced Server fails when a column definition includes a sequence with NEXTVAL call as the default clause. | | Bug Fix | Fixed an issue that caused a migration failure for a table with a column named after the POSITION keyword. | -| Bug Fix | Corrected the MTK Windows installer so that it removes the older version of commons-lang library as part of the upgrade process. | +| Bug Fix | Corrected the Migration Toolkit Windows installer so that it removes the older version of commons-lang library as part of the upgrade process. | | Bug Fix | Corrected some of the information/error messages to report schema-qualified table names. |