Merge pull request #2020 from EnterpriseDB/release/2021-11-08

Release: 2021-11-08

product_docs/docs/biganimal/release/administering_cluster/01_portal_access.mdx

@@ -1,5 +1,7 @@
 ---
 title: "Managing portal access"
+redirects:
+    - 01_user_access
 ---
 
 BigAnimal uses Azure Active Directory (AD) to authenticate users and role based access controls to grant users access to different parts of the application.

product_docs/docs/biganimal/release/getting_started/02_connect_cloud_account.mdx

@@ -29,7 +29,7 @@ To create an Azure AD Application:
 Take note of the **Application (client) ID**, you need it to configure your BigAnimal account. Also take note of the **Display name** of the Azure AD application. You need to enter the **Display name** _as is_ in the next step of this procedure.
 
 1. Choose _application secret_ as an authentication option for the application. See [Create a new Azure AD application secret](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#option-2-create-a-new-application-secret) for instructions. Take note of the Azure AD App Secret, you need it to configure your cloud account.
-1. Assign the owner role to the application. See [Assign a role to the application](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application) for instructions. Enter the **Display name** of the Azure AD application in the **Select** field of the **Add role assignment** panel. See [Open the Add role assignment pane](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-pane) for instructions.
+1. Assign the owner role to the application. See [Assign a role to the application](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#assign-a-role-to-the-application) for instructions. Enter the **Display name** of the Azure AD application in the **Select** field of the **Add role assignment** panel. See [Open the Add role assignment pane](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current#step-2-open-the-add-role-assignment-page) for instructions.
 
 ### Create Azure Active Directory Application using `create-spn`
 
@@ -110,8 +110,8 @@ To connect your cloud account with your Azure subscription:
 
    | Parameter                                            | Description                                                                  |
    | ---------------------------------------------------- | ---------------------------------------------------------------------------- |
-   | **Azure AD: Application Client ID**                  | Application client ID you noted when [creating your Azure AD Application](#create-azure-ad-application) or that was generated from the [`create-spn`](#create-azure-active-directory-application-using-create-spn) script.|
-   | **Azure AD: Application Client Secret Value** | Application client secret value you noted when [creating your Azure AD Application](#create-azure-ad-application) or that was generated from the [`create-spn`](#create-azure-active-directory-application-using-create-spn) script.|
+   | **Azure AD: Application Client ID**                  | Application client ID you noted when [creating your Azure AD Application](#create-azure-active-directory-application-using-the-azure-portal) or that was generated from the [`create-spn`](#create-azure-active-directory-application-using-create-spn) script.|
+   | **Azure AD: Application Client Secret Value** | Application client secret value you noted when [creating your Azure AD Application](#create-azure-active-directory-application-using-the-azure-portal) or that was generated from the [`create-spn`](#create-azure-active-directory-application-using-create-spn) script.|
    | **Azure Subscription ID**                            | Azure subscription ID for BigAnimal available from the Subscriptions page of your Azure account.  |
    | **Your BigAnimal Organization Name**                 | SaaS Subscription Name you assigned as your BigAnimal Organization (see [Step 2. Fill out the details for your plan.](#2-fill-out-the-details-for-your-plan))  |
 

product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx

@@ -7,7 +7,7 @@ redirects:
 ---
 
 !!! Note
-Prior to creating your cluster, make sure you have adequate Azure resources or your request to create a cluster will fail. See [Raising your Azure resource limits](01_check_resource_limits).
+Prior to creating your cluster, make sure you have adequate Azure resources or your request to create a cluster will fail. See [Raising your Azure resource limits](../01_check_resource_limits).
 !!!
 
 To create a cluster:
@@ -16,11 +16,11 @@ To create a cluster:
 
 3. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. The **Create Cluster** page opens.
 4. Specify the cluster settings on the following tabs of the **Create Cluster** page:
-   - [**Cluster Info**](#cluster-info)
+   - [**Cluster Info**](#cluster-info-tab)
 
-   - [**Operational Settings**](#operational-settings)
-   - [**DB Configuration** ](#db-configuation) (optional)
-   - [ **Availibility** ](#availibility) (optional)
+   - [**Operational Settings**](#operational-settings-tab)
+   - [**DB Configuration** ](#db-configuration-tab) (optional)
+   - [ **Availability** ](#availability-tab) (optional)
 
 8. Select **Create Cluster**. It might take a few minutes to deploy.
 
@@ -36,40 +36,40 @@ To create a cluster:
 ## Operational Settings tab
 1. In the **Database Type** section,
    1. Select the type of Postgres you want to use in the **Postgres Type** field:
-      - [*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 Advanced Server*](../../../epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL.
+      - [*EDB Postgres Advanced Server*](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on EDB Cloud](../../using_cluster/06_demonstration_oracle_compatibility)
 
-   2. Select the version of Postgres that you want to use in the **Version** field. See [Database Version Policy](../overview/05_database_version_policy) for more information.
+   2. Select the version of Postgres that you want to use in the **Version** field. See [Database Version Policy](../../overview/05_database_version_policy) for more information.
 2. Select the cloud provider for your cluster in the **Provider** field.
    !!! Note
        Microsoft Azure is the only option for the Preview.
 3. Select the region where you want your cluster to be deployed in the **Region** field. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster.
 4. In the the **Instance Type** section, select the number of vCPUs and amount of memory you desire.
 5. In the **Storage** section, select **Volume Type**, and in **Volume Properties** the type and amount of storage needed for your cluster.
    !!! Note
-       BigAnimal currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssd) for more information.
+       BigAnimal currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information.
 6. In the **Networking** 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. 
 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**.
 
 ## DB Configuration tab
 In the **Parameters** section, you can update the value of the database configuration parameters, as needed. 
 
-To update the parameter values, see [Modifying Your Database Configuration Parameters](../using_cluster/03_modifying_your_cluster/05_db_configuration_parameters)
+To update the parameter values, see [Modifying Your Database Configuration Parameters](../../using_cluster/03_modifying_your_cluster/05_db_configuration_parameters).
 
 
 
-## Availability
+## Availability tab
  Enable or disable high availability using the **High Availability** slide button. 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_availibility) for more information.
+ See [Supported Architectures](../../overview/02_high_availability) for more information.
 
 ## What’s next
 
 Now that you’ve created your cluster, here are some additional resources for cluster use and management:
 
-* [Using your cluster]( ../using_cluster/)
-* [Managing Postgres access](../../administering_cluster/02_postgres_access/)
+* [Using your cluster](../../using_cluster/)
+* [Managing Postgres access](../../using_cluster/01_postgres_access/)
 

product_docs/docs/biganimal/release/migration/cold_migration.mdx

@@ -29,7 +29,7 @@ To minimize the downtime, you can test the process as many times as needed befor
 
 Ensure you:
  - Understand the [terminology conventions](#terminology-conventions) used in this topic
- - Have the [required Postgres client binaries and libraries](/#postgres-client-libraries)
+ - Have the [required Postgres client binaries and libraries](#postgres-client-libraries)
  - Can [access the source and target databases](#access-to-the-source-and-target-database)
 
 ### Terminology conventions

product_docs/docs/biganimal/release/migration/index.mdx

@@ -2,18 +2,18 @@
 title: Migrating databases to BigAnimal
 ---
 
-EDB provides migration tools to bring data from Oracle, PostgresSQL, and EDB Postgres Advanced Server databases into BigAnimal. These tools include Migration Portal and Migration Toolkit for Oracle migrations. More sophisticated migration processes can use tools such as [Replication Server](../../../eprs/latest/) for ongoing migrations and [LiveCompare](../../../livecompare/latest/) for data comparisons. 
+EDB provides migration tools to bring data from Oracle, PostgresSQL, and EDB Postgres Advanced Server databases into BigAnimal. These tools include Migration Portal and Migration Toolkit for Oracle migrations. More sophisticated migration processes can use tools such as [Replication Server](/eprs/latest/) for ongoing migrations and [LiveCompare](/livecompare/latest/) for data comparisons. 
 
 
 
 ## Migrating from Oracle
 
-The [Migration Portal documentation](../../../migration_portal/latest) provides the details for executing the migration steps using Migration Portal: 
+The [Migration Portal documentation](/migration_portal/latest) provides the details for executing the migration steps using Migration Portal: 
 
- 1. [Schema extraction](../.../../migration_portal/latest/04_mp_migrating_database/01_mp_schema_extraction/)
- 1. [Schema assessment](../../../migration_portal/latest/04_mp_migrating_database/02_mp_schema_assessment/)
- 1. [Schema migration](../../../migration_portal/latest/04_mp_migrating_database/03_mp_schema_migration/)
- 1. [Data migration](../../../migration_portal/latest/04_mp_migrating_database/04_mp_data_migration/)
+ 1. [Schema extraction](/migration_portal/latest/04_mp_migrating_database/01_mp_schema_extraction/)
+ 1. [Schema assessment](/migration_portal/latest/04_mp_migrating_database/02_mp_schema_assessment/)
+ 1. [Schema migration](/migration_portal/latest/04_mp_migrating_database/03_mp_schema_migration/)
+ 1. [Data migration](/migration_portal/latest/04_mp_migrating_database/04_mp_data_migration/)
 
 The Migration Portal documentation describes how to use Migration Toolkit for the data migration step. This is a good option for smaller databases. 
 

product_docs/docs/biganimal/release/overview/02_high_availibility.mdx → product_docs/docs/biganimal/release/overview/02_high_availability.mdx

@@ -1,5 +1,7 @@
 ---
 title: "Supported architectures"
+redirects:
+  - 02_high_availibility
 ---
 
 BigAnimal enables deploying a cluster with or without high availability. The option is controlled with the **High Availablity** slide button on the [Create Cluster](https://portal.biganimal.com/create-cluster) page in the [BigAnimal](https://portal.biganimal.com) portal.    

product_docs/docs/biganimal/release/overview/03_security.mdx

@@ -5,10 +5,10 @@ title: "Security"
 BigAnimal runs in your own cloud account, isolates your data from other users, and gives you control over our access to it. The key security features are:
 - **Data isolation:** Clusters are installed and managed in your cloud environment. Complete segregation of your data is ensured: your data never leaves your cloud account, and compromise of another BigAnimal customer's systems does not put your data at risk.
 
-- **Granular access control:** You can use Single Sign On (SSO) and define your own sets of roles and Role Based Access Control (RBAC) policies to manage your individual cloud environments. See [Managing portal access](../administering_cluster/01_user_access) for more information. 
+- **Granular access control:** You can use Single Sign On (SSO) and define your own sets of roles and Role Based Access Control (RBAC) policies to manage your individual cloud environments. See [Managing portal access](../administering_cluster/01_portal_access) for more information. 
 - **Data encryption:** All data in BigAnimal is encrypted in motion and at rest. Network traffic is encrypted using Transport Layer Security (TLS) v1.2 or greater, where applicable. Data at rest is encrypted using AES with 256 bit keys. Data encryption keys are envelope encrypted and the wrapped data encryption keys are securely stored in an Azure Key Vault instance in your account. Encryption keys never leave your environment.
 - **Portal audit logging:** Activities in the portal, such as those related to user roles, organization updates, and cluster creation and deletion are tracked automatically and viewed in the activity log.  
 - **Database logging and auditing:** Functionality to track and analyze database activities is enabled automatically. For PostgreSQL, the PostgreSQL Audit Extension (pgAudit) is enabled automatically for you when deploying a Postgres cluster. For EDB Postgres Advanced Server, the EDB Audit extension (edbAudit) is enabled automatically for you. 
     - **pgAudit:** The classes of statements being logged for pgAudit are set globally on a cluster with `pgaudit.log = 'write,ddl'`. The following statements made on tables will be logged by default when the cluster type is PostgreSQL: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, AND `COPY`. All `DDL` will be logged. 
 
-- **Database cluster permissions** The edb_admin account created during the *create cluster* process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the edb_admin account to create a new application user and new application database for further isolation. See [Managing Postgres access](../administering_cluster/02_postgres_access) for more information.
+- **Database cluster permissions** The edb_admin account created during the *create cluster* process includes the `CREATEDB` and `CREATEROLE` database roles. EDB recommends using the edb_admin account to create a new application user and new application database for further isolation. See [Managing Postgres access](../using_cluster/01_postgres_access) for more information.

product_docs/docs/biganimal/release/reference/api.mdx

@@ -65,7 +65,7 @@ curl --request POST \
 
 The response returns:
 
-- `device_code` - the unique code for the device. When you go to the `verification_uri` in your browser-based device, this code is bound to your session. You use this code in your [request for a token](#request-the-token-using-curl).
+- `device_code` - the unique code for the device. When you go to the `verification_uri` in your browser-based device, this code is bound to your session. You use this code in your [request for a token](#request-the-raw-token-using-curl).
 - `user_code` - the code you input at the `verification_uri` to authorize the device. You use this code when you [authorize yourself as a user](#authorize-as-a-user).
 - `verification_uri` - the URL you use to authorize your device.
 - `verification_uri_complete` - the complete URL you use to authorize the device. You can use this URL to embed the user code in your app's URL.
@@ -239,7 +239,7 @@ curl --request POST \
   --data "client_id=$CLIENT_ID" \
   --data "refresh_token=$REFRESH_TOKEN"
 ```
-The `refresh_token` is in the response when you [requested the token](#request-the-device-code).
+The `refresh_token` is in the response when you [requested the token](#request-the-device-code-using-curl).
 
 The `client_id` is always the same one in the response when you [queried the authentication endpoint](#query-the-authentication-endpoint).
 
@@ -265,7 +265,7 @@ REFRESH_TOKEN="v1.MTvuZpu.......sbiionEhtTw"
 The token you obtain from this step is the raw access token, you need to exchange this token for an BigAnimal token. See [Exchange for BigAnimal token](#exchange-the-biganimal-token-using-curl) for more information.
 
 !!! Note
-    You need to save the refresh token retrieved from this response for the next refresh call. The refresh token in the response when you originally [requested the token](#request-the-token) is obsoleted once it has been used.
+    You need to save the refresh token retrieved from this response for the next refresh call. The refresh token in the response when you originally [requested the token](#request-the-raw-token-using-curl) is obsoleted once it has been used.
 
 
 

product_docs/docs/biganimal/release/reference/cli.mdx

@@ -39,7 +39,7 @@ The CLI is available for Linux, MacOS, and Windows operating systems.
      CertUtil -hashfile biganimal.exe SHA256 type biganiml.sha256
     ```
 ## Command reference
-Use the `-h` or `--help` flags for more information on the CLI commands. You can use the flag on the `biganimal` command to get a listing of all the available commands (`biganimal -h`) or on a sub-command to get information on that particular command (for example, `animal create-cluster -h`).
+Use the `-h` or `--help` flags for more information on the CLI commands. You can use the flag on the `biganimal` command to get a listing of all the available commands (`biganimal -h`) or on a sub-command to get information on that particular command (for example, `biganimal create-cluster -h`).
 
 ## Before you begin
 Before using the CLI to manage BigAnimal, you need to authenticate as a valid BigAnimal user. Use the `create-credential` command to authenticate, get an access token, and store it in a local credential. For example:

product_docs/docs/biganimal/release/using_cluster/03_modifying_your_cluster/index.mdx

@@ -14,11 +14,11 @@ redirects:
 
    | Settings | Tab | 
    | ------- | ----------- |
-   | Cluster name and password | [Cluster info](../../getting_started/03_create_cluster/#cluster_info) |
-   | Instance type (vCPUs and memory)* | [Operational settings](../../getting_started/03_create_cluster/#operational_settings) |
-   | Networking type (public or private) | [Operational settings](../../getting_started/03_create_cluster/#operational_settings) |
+   | Cluster name and password | [Cluster info](../../getting_started/03_create_cluster/#cluster-info-tab) |
+   | Instance type (vCPUs and memory)* | [Operational settings](../../getting_started/03_create_cluster/#operational-settings-tab) |
+   | Networking type (public or private) | [Operational settings](../../getting_started/03_create_cluster/#operational-settings-tab) |
    | Database configuration parameters | [Database configuration parameters](05_db_configuration_parameters)
-   | High availability (on or off) | [Availability](../../getting_started/03_create_cluster/#availability) |
+   | High availability (on or off) | [Availability](../../getting_started/03_create_cluster/#availability-tab) |
 
    *Changing the instance type could incur higher cloud infrastructure charges.