Merge pull request #2881 from EnterpriseDB/release/2022-07-01

Release: 2022-07-01
EnterpriseDB · Jul 1, 2022 · 6bc74e3 · 6bc74e3
2 parents 85773bd + bb13b33
commit 6bc74e3
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 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
@@ -42,6 +42,8 @@ Prior to creating your cluster, make sure you have enough resources. Without eno
     !!! Note
        You can't switch from a single node or high availability cluster to an extreme high availability cluster or vice versa. 
 
+1. Select the number of standby replicas for your cluster. 
+
 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
@@ -63,6 +65,7 @@ Prior to creating your cluster, make sure you have enough resources. Without eno
 
 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
 
@@ -71,9 +74,15 @@ Prior to creating your cluster, make sure you have enough resources. Without eno
     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. 
+    - For Azure, in **Volume Type** select either Premium SSD or Ultra Disk. Compared to Premium SSD volumes, Ultra Disks offer lower latency, high-performance options, and direct control over your disk's IOPS (input/output operations per second). BigAnimal recommends using Ultra Disks for workloads that require the most demanding performance. See [Using Azure ultra disks](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd?tabs=azure-portal) for more information. 
+      - For Premium SSD, in **Volume Properties**, select the type and amount of storage needed for your cluster. See [Azure Premium SSD storage types](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. 
+
+      - For Ultra Disk, in **Volume Properties**, select the disk size and IOPS for your cluster. BigAnimal calculates the throughput based on your IOPS settings. 
+
+        !!!important
+        While setting the required IOPS for the disk you should consider the VM limits that are tied to the VM size that you have selected. See [Ultra disk IOPS](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#ultra-disk-iops) for more information.
 
-    - For AWS, BigAnimal currently supports General Purpose SSD (GP3) storage. In **Volume Properties**, select the disk size for your cluster. 
+    - For AWS, BigAnimal currently supports General Purpose SSD (GP3). In **Volume Properties**, select the disk size for your cluster and configure the IOPS. 
 
 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. 
 

diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx
@@ -30,15 +30,25 @@ 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 *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.
+The high availability option is provided to minimize downtime in cases of failures. High-availability clusters—one *primary* and one or 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.
 
 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 standby replica.
 
-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.
+
+### Synchronous replication
+
+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 a cluster with one primary and one replica, the entire system is unavailable for writes if either node goes down.
+
+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. 
+
+Note that BigAnimal automatically disables synchronous replication during maintenance operations of a two-node cluster (to ensure write availability).
+
 
 ## Extreme high availability (beta)
 

diff --git a/...t_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx b/...t_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx
@@ -9,6 +9,7 @@ You can modify your cluster by modifying:
 
 -   Cluster name and password
 -   Instance type
+-   Volume properties
 -   Networking type
 -   Database configuration parameters
 -   High availability
@@ -26,18 +27,22 @@ You can modify your cluster by modifying:
 
 4.  You can modify the following settings on the corresponding tab of the Edit Cluster page:
 
-    | 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) |
-    | Networking type (public or private) \**| [Cluster Settings](../../getting_started/03_create_cluster/#cluster-settings-tab)|
-    | Database configuration parameters   | [DB Configuration](05_db_configuration_parameters)                       |
+    | Settings                                 | Tab                                                                                |
+    | ---------------------------------------- | ---------------------------------------------------------------------------------- |
+    | Number of replicas (for a high availability cluster)           | [Cluster Info tab](../../getting_started/03_create_cluster/#cluster-info-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)  |
+    | Volume properties \**                    | [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)                                 |
 
     \* Changing the instance type could incur higher cloud infrastructure charges.
 
-    \** If you are using Azure and previously setup a private link and want to change to a public network, you must remove the private link resources before making the change.
+    \** It can take up to six hours to tune IOPS or resize the disks of your cluster because AWS requires a cool down period after volume modifications as explained in the [Limitations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-volume-requirements.html) section. The volume properties are disabled and cannot be modified while this is in progress. 
 
-    !!!Note
-    Saving changes might require a database restart.
+    \*** If you are using Azure and previously setup a private link and want to change to a public network, you must remove the private link resources before making the change.
 
 5.  Save your changes.
+
+ !!! Note
+     Saving changes might require a database restart.