Merge pull request #4737 from EnterpriseDB/docs/biganimal/planning

BigAnimal: planning section
EnterpriseDB · Sep 11, 2023 · 3c3265e · 3c3265e · github-actions · Sep 11, 2023
2 parents 514a8be + 1451fef
commit 3c3265e
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 41 deletions.
diff --git a/...cs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx b/...cs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx
@@ -6,7 +6,7 @@ redirects:
   - /biganimal/release/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud
 ---
 
-Use these techniques to connect your cloud if you're using your own cloud account as your [deployment option](/biganimal/release/overview/deployment_options).
+Use these techniques to connect your cloud if you're using your own cloud account as your [deployment option](/biganimal/release/planning/deployment_options).
 
 
 ## BigAnimal access requirements

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
@@ -52,7 +52,7 @@ The following options aren't available when creating your cluster:
 
 1. Select the number of standby replicas for your primary/standby high-availability cluster. 
 
-1. Select the type of cloud account for your cluster. You can choose BigAnimal's cloud account or set up your own. For more information, see [Deployment options](../../overview/deployment_options).
+1. Select the type of cloud account for your cluster. You can choose BigAnimal's cloud account or set up your own. For more information, see [Deployment options](../../planning/deployment_options).
 
     !!! Note
          If you use BigAnimal's cloud account, your estimated cloud infrastructure costs are calculated into your cluster's estimated monthly price shown at the bottom of the page. 

diff --git a/...al/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx b/...al/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx
@@ -4,7 +4,7 @@ redirects:
  - /biganimal/latest/getting_started/01_preparing_azure/
 ---
 
-BigAnimal requires you to check the readiness of your Azure subscription before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/overview/deployment_options).) The checks that you perform ensure that your Azure subscription is prepared to meet your clusters' requirements and resource limits, such as:
+BigAnimal requires you to check the readiness of your Azure subscription before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/planning/deployment_options).) The checks that you perform ensure that your Azure subscription is prepared to meet your clusters' requirements and resource limits, such as:
 
 -   Are the necessary Azure resource providers registered for your subscription?
 -   Is there a restriction on SKUs for the standard Esv3 family and standard D2_v4 VM size?

diff --git a/.../biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx b/.../biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx
@@ -3,7 +3,7 @@ title: "Preparing your AWS account"
 ---
 
 
-BigAnimal requires you to check the readiness of your AWS account before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/overview/deployment_options).) The checks that you perform ensure that your AWS account is prepared to meet your clusters' requirements and resource limits, such as:
+BigAnimal requires you to check the readiness of your AWS account before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/planning/deployment_options).) The checks that you perform ensure that your AWS account is prepared to meet your clusters' requirements and resource limits, such as:
 
    - Is the AWS CLI configured to access your AWS account?
    - Is there a sufficient limit on the number of vCPUs and Network Load Balancers (NLBs) left in your region?

diff --git a/...t_docs/docs/biganimal/release/getting_started/preparing_cloud_account/index.mdx b/...t_docs/docs/biganimal/release/getting_started/preparing_cloud_account/index.mdx
@@ -10,4 +10,4 @@ navigation:
  - preparing_gcp
 ---
 
-When using your cloud account, each time you create a cluster, you must ensure the readiness of your cloud to work with BigAnimal. You need to perform this check only if you're not using BigAnimal's cloud account as your [deployment option](/biganimal/release/overview/deployment_options).
+When using your cloud account, each time you create a cluster, you must ensure the readiness of your cloud to work with BigAnimal. You need to perform this check only if you're not using BigAnimal's cloud account as your [deployment option](/biganimal/release/planning/deployment_options).
diff --git a/...ganimal/release/getting_started/preparing_cloud_account/preparing_gcp/index.mdx b/...ganimal/release/getting_started/preparing_cloud_account/preparing_gcp/index.mdx
@@ -2,7 +2,7 @@
 title: Preparing your Google Cloud account 
 ---
 
-BigAnimal requires you to check the readiness of your Google Cloud (GCP) account before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/overview/deployment_options).) The checks that you perform ensure that your Google Cloud account is prepared to meet your clusters' requirements and resource limits.
+BigAnimal requires you to check the readiness of your Google Cloud (GCP) account before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/planning/deployment_options).) The checks that you perform ensure that your Google Cloud account is prepared to meet your clusters' requirements and resource limits.
 
 !!! Note
     Before proceeding, see [Understanding requirements in Google Cloud](understanding_quotas_in_gcp) for details on planning for your clusters' requirements and resource limits in Google Cloud.

diff --git a/product_docs/docs/biganimal/release/index.mdx b/product_docs/docs/biganimal/release/index.mdx
@@ -10,6 +10,7 @@ directoryDefaults:
 navigation:
   - free_trial
   - overview
+  - planning
   - getting_started
   - using_cluster
   - administering_cluster

diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx
@@ -8,45 +8,20 @@ redirects:
 BigAnimal supports three cluster types: 
 - Single node
 - Primary/standby high availability
-- Distributed high availability)
+- Distributed high availability
 
 You choose the type of cluster you want on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal.  
 
-## Choosing your Postgres distribution 
 
-Postgres distribution and version support varies by [cluster](#choosing-your-cluster-type-and-configuration) and [deployment](deployment_options) type.
-
-|    Postgres distribution     | Versions |          Cluster type          |     Deployment type     |
-| ---------------------------- | -------- | ------------------------------ | ----------------------- |
-| PostgreSQL                   | 11–15    | Single-node, primary/standby high-availability | Your cloud account  |
-| PostgreSQL                   | 12–15    | Single-node, primary/standby high-availability | BigAnimal cloud account  |
-| EDB Postgres Advanced Server | 12–15    | Single-node, primary/standby high-availability | Your cloud account  |
-| EDB Postgres Advanced Server | 14–15    | Single node, primary/standby high availability | BigAnimal cloud account |
-| EDB Postgres Advanced Server | 14–15    | Distributed high-availability      | Your cloud account  |
-| EDB Postgres Extended Server | 14-15 | Distributed high-availability | Your cloud account |
-
-## Choosing your cluster type and configuration 
-
-| Consideration            | [Single node](#single-node) |[Primary/standby HA](#primarystandby-high-availability) | [HA + standby replica](#standby-replicas) | [Distributed HA single region](#single-data-location) | [Distributed HA multi-region](#two-data-locations-and-witness) |
-|--------------------------|-----------|------------------|--------------------|----------------------------|---------------------------|
-| Data replication         |     None    |      Physical      |       Physical       |           Logical            |           Logical           |
-| Region                   |    Single   |       Single       |         Multi        |            Single            |            Multi            |
-| VM failure tolerance     |      ✅      |          ✅         |           ✅          |               ✅              |              ✅              |
-| AZ failure tolerance     |      TBD      |          ✅         |           ✅          |               ✅              |              ✅              |
-| Region failure tolerance |      TBD      |          TBD         |           ✅          |               TBD              |              ✅              |
-| Recovery time objective  |    varies   |       35s-60s      |        varies        |               0              |              0              |
-| Recovery point objective |    &lt;5 min   |          0         |        &lt;5 min        |               0              |      30s (configurable)     |
-| Service level agreement  |    99.5%    |       99.99%       |        99.99%        |            99.99%            |           99.995%           |
-
-### Single node
+## Single node
 
 For nonproduction use cases where high availability isn't 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. 
 
 ![BigAnimal Cluster4](images/single-node.png)
 
-### Primary/standby high availability
+## Primary/standby high availability
 
 The Primary/Standby High Availability option is provided to minimize downtime in cases of failures. Primary/standby high-availability clusters&mdash;one *primary* and one or two *standby replicas*&mdash;are configured automatically, with standby replicas staying up to date through physical streaming replication. 
 
@@ -60,7 +35,7 @@ In case of temporary or permanent unavailability of the primary, a standby repli
 
 Incoming client connections are always routed to the current primary. In case of failure of the primary, a standby replica is 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.
 
-#### Standby replicas
+### Standby replicas
 
 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. 
 
@@ -87,11 +62,11 @@ The witness node/witness group doesn't host data but exists for management purpo
 !!!Note
    Operations against a distributed high-availability cluster leverage the [EDB Postgres Distributed switchover](/pgd/latest/cli/command_ref/pgd_switchover/) feature which provides sub-second interruptions during planned lifecycle operations.
 
-#### Single data location 
+### Single data location 
 
 A single data location configuration has three data nodes with one lead and two shadow nodes each in separate availability zones. 
 
-#### Two data locations and witness
+### Two data locations and witness
 
 A true active-active solution that protects against regional failures, a two data locations configuration has:
 
@@ -103,7 +78,7 @@ A true active-active solution that protects against regional failures, a two dat
 
 
 
-### For more information
+## For more information
 
 For instructions on creating a distributed high-availability cluster using the BigAnimal portal, see [Creating a distributed high-availability cluster](../getting_started/creating_a_cluster/creating_an_eha_cluster/).
 

diff --git a/product_docs/docs/biganimal/release/overview/03_security/index.mdx b/product_docs/docs/biganimal/release/overview/03_security/index.mdx
@@ -2,7 +2,7 @@
 title: "Security"
 ---
 
-BigAnimal runs in your own cloud account or BigAnimal's cloud account. Every BigAnimal cluster is logically isolated from other BigAnimal clusters, but the security properties of the system are different in each [deployment option](/biganimal/release/overview/deployment_options). The key security features are:
+BigAnimal runs in your own cloud account or BigAnimal's cloud account. Every BigAnimal cluster is logically isolated from other BigAnimal clusters, but the security properties of the system are different in each [deployment option](/biganimal/release/planning/deployment_options). The key security features are:
 
 -   **Data isolation:** With both deployment options, data is fully isolated between separate clusters. No two BigAnimal clusters share a Postgres process, virtual machine, or storage volume. The implementation of this isolation depends on the deployment option.
     -   **Your own cloud account:** Clusters are installed and managed on virtual machines and storage volumes deployed by BigAnimal on your behalf in your cloud environment. Complete segregation of your data is assured. Your data never leaves your cloud account, and your clusters don't share network segments with other customers' clusters.

diff --git a/product_docs/docs/biganimal/release/overview/03a_region_support/index.mdx b/product_docs/docs/biganimal/release/overview/03a_region_support/index.mdx
@@ -3,7 +3,7 @@ title: "Supported regions"
 deepToC: true
 ---
 
-Region support varies by whether you're using [your cloud account](#your-cloud-account) or [Biganimal's cloud account](#biganimals-cloud-account) as your [deployment option](/biganimal/release/overview/deployment_options).
+Region support varies by whether you're using [your cloud account](#your-cloud-account) or [Biganimal's cloud account](#biganimals-cloud-account) as your [deployment option](/biganimal/release/planning/deployment_options).
 
 See [Country and geographical region reference](country_reference) for information on geographical region short names and the countries that are in each geographical region.
 

diff --git a/product_docs/docs/biganimal/release/planning/choosing_cluster_type.mdx b/product_docs/docs/biganimal/release/planning/choosing_cluster_type.mdx
@@ -0,0 +1,19 @@
+---
+title: Choosing your cluster type
+description: Choose the cluster type and configuration that meets your availability requirements.
+---
+
+Choose the cluster type and configuration that meets your availability requirements.
+
+Select the cluster type names in the table heading for more information on each type and configuration. 
+
+|      Consideration       | [Single node](../overview/02_high_availability/#single-node) | [Primary/Standby HA](../overview/02_high_availability/#primarystandby-high-availability) | [HA + standby replica](../overview/02_high_availability/#standby-replicas) | [Distributed HA single region](../overview/02_high_availability/#single-data-location) | [Distributed HA multi-region](../overview/02_high_availability/#two-data-locations-and-witness) |
+| ------------------------ | --------------------------- | ------------------------------------------------------ | ----------------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------- |
+| Data replication         | None                        | Physical                                               | Physical                                  | Logical                                               | Logical                                                        |
+| Region                   | Single                      | Single                                                 | Multi                                     | Single                                                | Multi                                                          |
+| VM failure tolerance     | ✅                           | ✅                                                      | ✅                                         | ✅                                                     | ✅                                                              |
+| AZ failure tolerance     | TBD                         | ✅                                                      | ✅                                         | ✅                                                     | ✅                                                              |
+| Region failure tolerance | TBD                         | TBD                                                    | ✅                                         | TBD                                                   | ✅                                                              |
+| Recovery time objective  | varies                      | 35s-60s                                                | varies                                    | 0                                                     | 0                                                              |
+| Recovery point objective | &lt;5 min                   | 0                                                      | &lt;5 min                                 | 0                                                     | 30s (configurable)                                             |
+| Service level agreement  | 99.5%                       | 99.99%                                                 | 99.99%                                    | 99.99%                                                | 99.995%                                                        |
diff --git a/product_docs/docs/biganimal/release/planning/choosing_postgres_distro.mdx b/product_docs/docs/biganimal/release/planning/choosing_postgres_distro.mdx
@@ -0,0 +1,21 @@
+---
+title: Choosing your Postgres distribution
+description: See what Postgres distributions and versions are available based on your deployment and availability choices.
+---
+
+Postgres distribution and version support varies by [cluster](../overview/02_high_availability) and [deployment](deployment_options) type.
+
+## Postgres distribution using your cloud account
+
+| Postgres distribution        | Versions | Cluster type                                   |
+|------------------------------|----------|------------------------------------------------|
+| PostgreSQL                   | 11–15    | Single-node, primary/standby high-availability |
+| EDB Postgres Advanced Server | 12–15    | Single-node, primary/standby high-availability |
+| EDB Postgres Advanced Server | 14–15    | Distributed high-availability                  |
+
+## Postgres distribution using the BigAnimal cloud account
+
+| Postgres distribution        | Versions | Cluster type                                   |
+|------------------------------|----------|------------------------------------------------|
+| PostgreSQL                   | 12–15    | Single-node, primary/standby high-availability |
+| EDB Postgres Advanced Server | 14–15    | Single node, primary/standby high availability |
diff --git a/...ase/overview/deployment_options/index.mdx → ...ase/planning/deployment_options/index.mdx b/...ase/overview/deployment_options/index.mdx → ...ase/planning/deployment_options/index.mdx
@@ -1,5 +1,8 @@
 ---
-title: Deployment options
+title: Choosing your deployment option
+description: Choose to use either your cloud account or BigAnimal's.
+redirects: 
+ - /biganimal/release/overview/deployment_options/
 ---
 
 You have two deployment options with BigAnimal. You can deploy clusters in your cloud account, or you can deploy in BigAnimal's cloud account.

diff --git a/product_docs/docs/biganimal/release/planning/index.mdx b/product_docs/docs/biganimal/release/planning/index.mdx
@@ -0,0 +1,8 @@
+---
+title: Planning
+indexCards: simple
+navigation: 
+- deployment_options
+- choosing_cluster_type
+- choosing_postgres_distro
+---