Merge pull request #3184 from EnterpriseDB/release/2022-09-21

Release: 2022-09-21
EnterpriseDB · Sep 21, 2022 · cb3d02c · cb3d02c
2 parents 7f2beab + f0b64c3
commit cb3d02c
Show file tree

Hide file tree

Showing 15 changed files with 117 additions and 114 deletions.
diff --git a/...s/partner_docs/Markdown Implementation Guide Template/02-PartnerInformation.mdx b/...s/partner_docs/Markdown Implementation Guide Template/02-PartnerInformation.mdx
@@ -1,12 +1,12 @@
 ---
 title: 'Partner Information'
-description: 'Details for <PartnerName> and <PartnerProductName>'
+description: 'Details for (Partner Name) (Partner Product)'
 
 ---
 | &nbsp;     | &nbsp; |
 | ----------- | ----------- |
 | **Partner Name**      |        |
 | **Partner Product**   |        |
 | **Web Site**      |      |
-| **Version & Platform**   |        |
-| **Product Description**      |       |
+| **Version**   |       |
+| **Product Description**      |     |
diff --git a/...docs/partner_docs/Markdown Implementation Guide Template/03-SolutionSummary.mdx b/...docs/partner_docs/Markdown Implementation Guide Template/03-SolutionSummary.mdx
@@ -2,13 +2,10 @@
 title: 'Solution Summary'
 description: 'Brief explanation of the solution and its purpose'
 ---
-(Insert explanation of solution and diagram of solution below)
-
-<p align="center">
-  <img  src="Images/PlaceholderImage.png">
-</p>
 
+(Insert explanation of solution and diagram of solution below)
 
+![Placeholder Image](Images/PlaceholderImage.png)
 
 !!! Note
-    (Insert text for your note here)
+    (Insert text for your note here)
diff --git a/...kdown Implementation Guide Template/04-ConfiguringPartnerNamePartnerProduct.mdx b/...kdown Implementation Guide Template/04-ConfiguringPartnerNamePartnerProduct.mdx
@@ -0,0 +1,12 @@
+---
+title: 'Configuring (Partner Name) (Partner Product)'
+description: 'Walkthrough on configuring (Partner Name) (Partner Product)'
+---
+
+Implementing (Partner Name) (Partner Product) with (EDB Product) requires the following components:
+
+- 
+- 
+- 
+
+
diff --git a/...er_docs/Markdown Implementation Guide Template/04-ConfiguringTheIntegration.mdx b/...er_docs/Markdown Implementation Guide Template/04-ConfiguringTheIntegration.mdx
diff --git a/...ocs/partner_docs/Markdown Implementation Guide Template/05-UsingPartnerName.mdx b/...ocs/partner_docs/Markdown Implementation Guide Template/05-UsingPartnerName.mdx
diff --git a/...cs/Markdown Implementation Guide Template/05-UsingPartnerNamePartnerProduct.mdx b/...cs/Markdown Implementation Guide Template/05-UsingPartnerNamePartnerProduct.mdx
@@ -0,0 +1,35 @@
+---
+title: 'Using (Partner Name) (Partner Product)'
+description: 'Walkthroughs of multiple (Partner Name) (Partner Product) usage scenarios'
+---
+
+The examples below will walk you though some of the common usage scenarios that can be used with (EDB Product Name). These are examples to help get you started and show how the products can work together.
+
+1. Usage case one
+    - blank
+    - blank
+    - blank
+2. Usage case two
+    - blank
+    - blank
+    - blank
+
+## Usage case one
+
+1. blank
+
+   ![Placeholder Image](Images/PlaceholderImage.png)
+
+2. blank
+
+   ![Placeholder Image](Images/PlaceholderImage.png)
+
+## Usage case two
+
+1. blank
+
+   ![Placeholder Image](Images/PlaceholderImage.png)
+
+2. blank
+
+   ![Placeholder Image](Images/PlaceholderImage.png)
diff --git a/...ner_docs/Markdown Implementation Guide Template/06-CertificationEnvironment.mdx b/...ner_docs/Markdown Implementation Guide Template/06-CertificationEnvironment.mdx
@@ -1,28 +1,11 @@
 ---
 title: 'Certification Environment'
-description: 'Overview of the certification environment used in the certification of <PartnerProductName>'
+description: 'Overview of the certification environment used in the certification of (Partner Name) (Partner Product)'
 ---
 
 |  &nbsp;    | &nbsp; |
 | ----------- | ----------- |
 | **Certification Test Date**      |       |
 | **EDB Postgres Advanced Server**  |      |
-| **OS**      |        |
-| **Memory**      |        |
-| **Processor**   |        |
-| **Cloud Platform**      |       |
-| **CPU(s)**   |       |
-| **Core(s) per socket**  |       |
-| **Socket(s)**  |       |
-| **Storage**  |      |
-| **(Partner Product Name)**  |      |
-
-
-|  &nbsp;    | &nbsp; |
-| ----------- | ----------- |
-| **Certification Test Date**|       |
-| **BDR-Always-ON**|      |
-| **OS**|         |
-| **Cloud Platform**|       |
-| **Deployment Tool**|        |
-| **(Partner Product Name)**  |      |
+| **EDB Postgres Extended Server**  |      |
+| **(Partner Name) (Partner Product)**  |      |
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
@@ -30,53 +30,44 @@ Before connecting to your cloud,
       - bash shell version 4.0 or above.
 
       - [jq](https://stedolan.github.io/jq/) JSON parser.
+
       - BigAnimal CLI version 1.4 or later. For detailed steps, see [Installing the CLI](../../reference/cli/#installing-the-cli).
 
+ - Be aware that BigAnimal requires permissions to run Kubernetes cluster services for PostgreSQL workloads and the associated storage services. It requires a set of supporting permissions:
+
+    - Services for monitoring and logging to produce service telemetry information.
+
+    - To set up networking so PostgreSQL workloads are reachable by customer applications and telemetry data is collected.
+
+    - To provision vaults for safe storage of data at rest encryption keys.
+
+    - To create workload identities and manage their permissions.
+
+    - And, a small set of supporting permissions to ensure access to the services above and availability of cloud account information.
+
+  The scope of these permissions are limited to the associated cloud account. 
+
  - Ensure that the BigAnimal login user running the CLI is assigned either the owner or the contributor role.
 
 Perform the following steps:
 
 1. Open the [Azure Cloud Shell](https://shell.azure.com/) or the [AWS Cloud Shell](https://console.aws.amazon.com/cloudshell) in your browser.
 
-1. Log in to BigAnimal as a user with either the owner or the contributor role.
+1.  Create a BigAnimal CLI credential:
 
    ```shell
-   biganimal create-credential --name <UserLogin> --address portal.biganimal.com --port 443
+   ./biganimal create-credential --name <cred> --address portal.biganimal.com --port 443
    ```
 
-1. Run the `setup-csp` command to set up your cloud provider. The synatx is:
+1. Run the `setup-csp` command to set up your cloud provider:
 
     ```shell
-    setup-csp --provider
-          {--account-id | --subscription-id}
-          --region
-          [--instance-type --cluster-architecture --networking | --skip-preflight]
-          [--run]
+    ./biganimal setup-csp 
     ```
  !!! Important
      Do not delete the `ba-passport.json` file created in your working directory. It contains important identity and access management information used by `connect-csp` while connecting to your cloud.
- Here is an example of setting up an AWS account:
-
-    ```shell
-   biganimal setup-csp --provider aws --account-id 123456789102  --region us-east-1 --instance-type aws:r5.large --cluster-architecture ha --networking private --run
-   ```
-
- Here is an example if setting up an Azure account:
-    ```shell
-   biganimal setup-csp --provider azure --subscription-id abc12345-1234-1234-abcd-12345678901 --region eastus --instance-type azure:Standard_E4s_v3 --cluster-architecture ha --networking private --run
-   ```
-
-   For more information on the command arguments, run the following command:
-
-   ```shell
-   biganimal setup-csp --help
-   ```
-
- Alternatively, you can enable the CLI interactive mode to have the CLI guide you through the process:
-   ```shell
-   biganimal config set interactive_mode on
-   biganimal setup-csp
-   ```
+
+
  !!! Tip
      Your organization might require you to review the scripts that are invoked while setting up your cloud account. To generate the scripts invoked by `setup-csp`, execute the command without the `--run` option. You can now review and manually execute `ba-csp-preflight` and then `ba-csp-setup` from your working directory.
 
@@ -91,6 +82,6 @@ Perform the following steps:
 
 1. If the cloud readiness checks pass, your cloud account is successfully set up. Connect your cloud account to BigAnimal with following command.
    ```shell
-   biganimal connect-csp --provider  <cloud-service-provider>
+   ./biganimal connect-csp --provider  <cloud-service-provider>
    ```
  Once your cloud account is successfully connected to BigAnimal, you, and other users with the correct permissions, can create clusters.
diff --git a/product_docs/docs/biganimal/release/getting_started/index.mdx b/product_docs/docs/biganimal/release/getting_started/index.mdx
@@ -5,8 +5,8 @@ navigation:
  - 00_free_trial
  - identity_provider
  - 02_azure_market_setup
- - 02_connecting_to_your_cloud
  - preparing_cloud_account
+ - 02_connecting_to_your_cloud
  - creating_a_cluster
 ---
 

diff --git a/product_docs/docs/biganimal/release/reference/cli.mdx b/product_docs/docs/biganimal/release/reference/cli.mdx
@@ -39,6 +39,14 @@ The CLI is available for Linux, MacOS, and Windows operating systems.
         echo "$(<biganimal_darwin_amd64.sha256)  biganimal" | shasum -a256 -c
         ```
 
+### Make the CLI command executable within Cloud Shell
+
+Change the permissions of the CLI to make it executable within Cloud Shell:
+
+```shell
+chmod +x biganimal
+```
+
 
 ## Authenticate as a valid user
 
@@ -317,7 +325,7 @@ After the cluster is created, you can update attributes of the cluster including
 For example, to set the public allowed IP range list, use the `--cidr-blocks` flag:
 
 ```shell
-biganimal update-cluster --name my-biganimal-cluster --provider azure \
+./biganimal update-cluster --name my-biganimal-cluster --provider azure \
   --region eastus \
   --cidr-blocks "9.9.9.9/28=Traffic from App A"
 ```

diff --git a/product_docs/docs/biganimal/release/using_cluster/01_postgres_access.mdx b/product_docs/docs/biganimal/release/using_cluster/01_postgres_access.mdx
@@ -12,7 +12,7 @@ psql -W "postgres://[email protected]:5432/edb_admin?sslmod
 
 ## Notes on the edb_admin role
 
-- The `edb_admin` role does not have superuser privileges by default. Contact [Support](../overview/support) to request superuser priviledges for `edb_admin`. If you request superuser privileges, you **must** take care to limit the number of connections used by superusers to avoid degraded service and/or compromising availability.
+- The `edb_admin` role does not have superuser privileges by default. Contact [Support](../overview/support) to request superuser privileges for `edb_admin`. If you request superuser privileges, you **must** take care to limit the number of connections used by superusers to avoid degraded service and/or compromising availability.
 
 - Changes to system configuration (GUCs) made by edb_admin or other Postgres users are not persisted though a reboot or maintenance. Use the BigAnimal portal to modify system configuration.
 

diff --git a/product_docs/docs/efm/4/04_configuring_efm/01_cluster_properties.mdx b/product_docs/docs/efm/4/04_configuring_efm/01_cluster_properties.mdx
@@ -555,7 +555,7 @@ stop.failed.primary=true
 
 <div id="primary_shutdown_as_failure" class="registered_link"></div>
 
-Use the `primary.shutdown.as.failure` property to treat any shutdown of the Failover Manager agent on the primary node as a failure. If this property is set to `true` and the primary agent is shut down, the rest of the cluster treats the shutdown as a failure. This includes any proper shutdown of the agent such as a shutdown of the whole node. None of the timeout properties apply in this case: when the agent exits, the rest of the cluster is notified immediately. After the agent exits, the rest of the cluster performs the regular failover steps that happen in the case of agent failure. The regular failover steps include attempting to connect to the primary database, seeing if the VIP is reachable if used, and so on).
+Use the `primary.shutdown.as.failure` property to treat any shutdown of the Failover Manager agent on the primary node as a failure. If this property is set to `true` and the primary agent is shut down, the rest of the cluster treats the shutdown as a failure. This includes any proper shutdown of the agent such as a shutdown of the whole node. None of the timeout properties apply in this case: when the agent exits, the rest of the cluster is notified immediately. After the agent exits, the rest of the cluster performs [checks](../11_supported_scenarios/#primary_agent_exits) that happen in the case of a primary agent failure. The [checks](../11_supported_scenarios/#primary_agent_exits) include attempting to connect to the primary database, seeing if the VIP is reachable if used, and so on).
 
 -   If the database is reached, a notification is sent informing you of the agent status.
 -   If the database isn't reached, a failover occurs.

diff --git a/product_docs/docs/efm/4/07_using_efm_utility.mdx b/product_docs/docs/efm/4/07_using_efm_utility.mdx
@@ -108,7 +108,7 @@ Invoke the `efm encrypt` command to encrypt the database password before includi
 
 The `efm promote` command instructs Failover Manager to perform a manual failover of standby to primary.
 
-Attempt manual promotion only if the status command reports that the cluster includes a standby node that is up to date with the primary. If there is no up-to-date standby, Failover Manager prompts you before continuing.
+Attempt a manual promotion only during a maintenance window for your database cluster and if the status command reports that all standbys in the cluster are up to date with the primary.
 
 Include the `–switchover` clause to promote a standby node and reconfigure a primary node as a standby node. Include the `-sourcenode` keyword, and specify a node address to indicate the node whose recovery settings to copy to the old primary node, which makes it a standby. Include the `-quiet` keyword to suppress notifications during the switchover process. Include the `-noscripts` keyword to instruct Failover Manager not to invoke fencing or post-promotion scripts.