Merge pull request #1994 from EnterpriseDB/release/2021-11-02

Release: 2021-11-02

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

@@ -2,18 +2,18 @@
 title: "Managing portal access"
 ---
 
-EDB Cloud uses Azure Active Directory (AD) to authenticate users and role based access controls to grant users access to different parts of the application.
+BigAnimal uses Azure Active Directory (AD) to authenticate users and role based access controls to grant users access to different parts of the application.
 
 ## Organizations
 
 Each subscribed customer has a unique *organization*. Each organization’s database clusters are deployed and managed in the customer's cloud account. This ensures complete segregation of customer data between organizations.
 
-Each EDB Cloud organization is associated with an Azure AD tenant. Azure AD establishes the identity of users that belong to an organization. After Azure AD is linked during subscription, users that belong to that AD can login with minimum access privileges.
+Each BigAnimal organization is associated with an Azure AD tenant. Azure AD establishes the identity of users that belong to an organization. After Azure AD is linked during subscription, users that belong to that AD can login with minimum access privileges.
 
-EDB Cloud supports role based access control policies. A user with the owner role may assign roles to other users in the same organization.
+BigAnimal supports role based access control policies. A user with the owner role may assign roles to other users in the same organization.
 
 ## Roles
-Access to EDB Cloud is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users.
+Access to BigAnimal is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users.
 
 * Each organization will have three default roles available:
   * owner
@@ -81,7 +81,7 @@ To change permissions associated with the role:
 
 ## Users
 
-When you configured your Azure subscription, you also enabled EDB Cloud to authenticate users from your organization using Azure AD. Before users become visible in the EDB Cloud **Users** screen they need to sign in using Azure AD after receiving special emails sent by your organization. New users signed in to EDB Cloud have a minimum set of permissions until you assign them a role.
+When you configured your Azure subscription, you also enabled BigAnimal to authenticate users from your organization using Azure AD. Before users become visible in the BigAnimal **Users** screen they need to sign in using Azure AD after receiving special emails sent by your organization. New users signed in to BigAnimal have a minimum set of permissions until you assign them a role.
 
 ### Assigning roles to users
 To assign appropriate roles to users:
@@ -93,7 +93,7 @@ To assign appropriate roles to users:
 5. Select **Submit**.
 
 !!! Note
-    For a user's role assignment to take effect, the user needs to log out from EDB Cloud and log in again.
+    For a user's role assignment to take effect, the user needs to log out from BigAnimal and log in again.
 
 ### Viewing users
 
@@ -105,10 +105,10 @@ To view all users from your organization that have logged in at least once:
 
 ## Example scenario
 
-1. The EDB Cloud organization is created, and Tom logs in and is granted the owner role.
+1. The BigAnimal organization is created, and Tom logs in and is granted the owner role.
 
-2. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in EDB Cloud is created.
-3. Tom grants Sally the contributor role. Sally logs out and back in, and she can now create EDB Cloud clusters.
+2. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in BigAnimal is created.
+3. Tom grants Sally the contributor role. Sally logs out and back in, and she can now create BigAnimal clusters.
 4. Sally asks Jerry to log in, and grants him the reader role.
 5. Jerry logs out and back in, and he can now see the clusters that Sally has created.
 

product_docs/docs/biganimal/release/administering_cluster/03_account_activity.mdx

@@ -1,7 +1,7 @@
 ---
 title: "Reviewing account activity"
 ---
-The activity log collects EDB Cloud events based on user activity within the portal. It can be used to audit activities performed by users from your organizations or research activities that may have affected your account.
+The activity log collects BigAnimal events based on user activity within the portal. It can be used to audit activities performed by users from your organizations or research activities that may have affected your account.
 
 ## Events
 
@@ -24,7 +24,7 @@ Events are related to the following resource types:
 
 ## Viewing and searching the activity log
 
-To view events, navigate to the [**Activity Log**](https://portal.edbcloud.com/activityLog) page on the [EDB Cloud](https://portal.edbcloud.com) portal. To search events, use the filters at the top of the page.
+To view events, navigate to the [**Activity Log**](https://portal.biganimal.com/activityLog) page on the [BigAnimal](https://portal.biganimal.com) portal. To search events, use the filters at the top of the page.
 
 The following fields are in the activity log:
 

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

@@ -2,4 +2,4 @@
 title: "Administering your account"
 ---
 
-In this section, account owners can find information on administrative activities for the EDB Cloud account including portal and database user access management as well as account activity reviews.
+In this section, account owners can find information on administrative activities for the BigAnimal account including portal and database user access management as well as account activity reviews.

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

@@ -1,8 +1,8 @@
 ---
-title: "Connecting your EDB Cloud account"
+title: "Connecting your BigAnimal account"
 ---
 
-This topic describes how to set up your EDB Cloud account on Azure Marketplace. Your Azure subscription for EDB Cloud is where you create and manage Postgres clusters.
+This topic describes how to set up your BigAnimal account on Azure Marketplace. Your Azure subscription for BigAnimal is where you create and manage Postgres clusters.
 
 ## Before you connect your cloud account
 
@@ -26,7 +26,7 @@ This topic describes how to set up your EDB Cloud account on Azure Marketplace.
 To create an Azure AD Application:
 
 1. Register an application with Azure AD and create a service principal. See [Register an application with Azure AD and create a service principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#register-an-application-with-azure-ad-and-create-a-service-principal) for instructions.
-Take note of the **Application (client) ID**, you need it to configure your EDB cloud 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.
+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.
@@ -47,7 +47,7 @@ Flag and option details:
 | Flag/option shortcut | Flag/option long name | Description |
 | -------------------- | --------------------- | ----------- |
 | -d *NAME* |  --display-name *NAME* | Name of Azure AD Application |
-|  -s *SUBSCRIPTION_ID* | --subscription *SUBSCRIPTION_ID* | Azure Subscription ID used by EDB Cloud |
+|  -s *SUBSCRIPTION_ID* | --subscription *SUBSCRIPTION_ID* | Azure Subscription ID used by BigAnimal |
 |  -y *YEARS* | --years *YEARS* | Integer value specifying the number of years for which the credentials are valid. The default is one year. |
 |  -h | --help | Displays information on the syntax and usage of the script. |
 
@@ -103,7 +103,7 @@ To connect your cloud account with your Azure subscription:
 #### 4. Configure your account.
 !!! Note
     After step 1  you are prompted for approval by an Azure AD global administrator.
-1. Select **Configure account now** to configure EDB Cloud to use your Azure subscription and your Azure AD Application.
+1. Select **Configure account now** to configure BigAnimal to use your Azure subscription and your Azure AD Application.
 
 
 2. Fill in the following parameters in the form:
@@ -112,20 +112,20 @@ To connect your cloud account with your Azure subscription:
    | ---------------------------------------------------- | ---------------------------------------------------------------------------- |
    | **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 Subscription ID**                            | Azure subscription ID for EDB Cloud available from the Subscriptions page of your Azure account.  |
-   | **Your EDB Cloud Organization Name**                 | SaaS Subscription Name you assigned as your EDB Cloud Organization (see [Step 2. Fill out the details for your plan.](#2-fill-out-the-details-for-your-plan))  |
+   | **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))  |
 
 11. Select **Submit.**
 
 ## What's next
 
 ### Login
 
-You can now log in to your EDB Cloud account using your Azure AD identity if you filled in the parameters correctly.
+You can now log in to your BigAnimal account using your Azure AD identity if you filled in the parameters correctly.
 
 ### Invite users
 
-You can invite new users by sharing the link to the EDB Cloud portal and having them log in with their Microsoft Azure Active Directory account. New users are not assigned any roles by default. After they log in the first time, you see them in the User list and are able to assign them a role with permissions to EDB Cloud. See [Assigning roles to users](../administering_cluster/01_portal_access/#assigning-roles-to-users) for instructions.
+You can invite new users by sharing the link to the BigAnimal portal and having them log in with their Microsoft Azure Active Directory account. New users are not assigned any roles by default. After they log in the first time, you see them in the User list and are able to assign them a role with permissions to BigAnimal. See [Assigning roles to users](../administering_cluster/01_portal_access/#assigning-roles-to-users) for instructions.
 
 !!! Note
     Azure AD email domain will likely be different than the email domain regularly used by your organization.

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

@@ -12,7 +12,7 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y
 
 To create a cluster:
 
-1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal.
+1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal.
 
 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:
@@ -48,7 +48,7 @@ To create a 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
-       EDB Cloud 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-ssd) 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**.

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

@@ -3,6 +3,6 @@ title: "Getting started"
 indexCards: simple
 ---
 
-In this section, Azure subscription administrators can learn how to initially set up their EDB Cloud account, invite others to join them in exploring what EDB has to offer, and create initial clusters as an account owner so that development can begin.
+In this section, Azure subscription administrators can learn how to initially set up their BigAnimal account, invite others to join them in exploring what EDB has to offer, and create initial clusters as an account owner so that development can begin.
 
 

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

@@ -3,7 +3,7 @@ title: Using the BigAnimal CLI
 ---
 
 
-Use the Command Line Interface (CLI) for BigAnimal management activities such as cluster provisioning and getting cluster status from your terminal. The CLI is an efficient way to integrate with BigAnimal and enables system administrators and developers to script and automate the EDB Cloud administrative operations.
+Use the Command Line Interface (CLI) for BigAnimal management activities such as cluster provisioning and getting cluster status from your terminal. The CLI is an efficient way to integrate with BigAnimal and enables system administrators and developers to script and automate the BigAnimal administrative operations.
 
 
 
@@ -189,6 +189,25 @@ biganimal create-cluster --clusterConfigFile ./config_file.yaml
 !!! Tip
 You can turn off the confirmation step with the `biganimal disable-confirm` command.
 !!!
+### Get cluster connection information
+
+To use your BigAnimal cluster, you first need to get your cluster's connection information. To get your cluster's connection information, use the `show-cluster-connection` command:
+
+```
+$ biganimal show-cluster-connection --name my-biganimal-cluster --provider azure --region eastus
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Connection String                                                                                                ┃
+┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
+┃ postgres://[email protected]:5432/edb_admin?sslmode=require        ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+!!! tip
+You can query the complete connection information with other output formats, like json, or yaml. For example: 
+```
+biganimal show-cluster-connection --name my-biganimal-cluster --provider azure --region eastus --ouput json
+```
+!!!
 
 ### Update cluster
 After the cluster is created, you can update attributes of the cluster including both the cluster’s profile and its deployment architecture. 

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

@@ -6,4 +6,4 @@ navigation:
  - cli
 ---
 
-In this section, system administrators and developers can learn how to use the EDB Cloud API and EDB Cloud Command Line Interface (CLI) to integrate directly with EDB Cloud for management activities such as cluster provisioning, de-provisioning, and scaling and to automate administrative operations.
+In this section, system administrators and developers can learn how to use the BigAnimal API and BigAnimal Command Line Interface (CLI) to integrate directly with BigAnimal for management activities such as cluster provisioning, de-provisioning, and scaling and to automate administrative operations.