From 4b83c79de9222603244c38f0b9c2efdcb9320738 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 2 Nov 2021 06:15:00 -0400 Subject: [PATCH 1/6] added get cluster info use case --- .../docs/biganimal/release/reference/cli.mdx | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/product_docs/docs/biganimal/release/reference/cli.mdx b/product_docs/docs/biganimal/release/reference/cli.mdx index db02729f37c..6d5b1ea5b20 100644 --- a/product_docs/docs/biganimal/release/reference/cli.mdx +++ b/product_docs/docs/biganimal/release/reference/cli.mdx @@ -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://edb_admin@p-c5vtkei9slcqhepufrd0.brcxzr08qr7rbei1.biganimal.com: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. From 3f9becc40dfb189f503caf8ad14807cae85b83f4 Mon Sep 17 00:00:00 2001 From: Moiz Nalwalla Date: Mon, 1 Nov 2021 22:16:02 +0530 Subject: [PATCH 2/6] Replaced screenshot with new hostname --- .../01_connecting_from_azure/03_vnet_vnet.mdx | 2 +- .../using_cluster/connecting_your_cluster/images/image6.png | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx b/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx index 3beb1b65582..a0543aabddc 100644 --- a/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx @@ -50,7 +50,7 @@ To walk through an example in your own environment, you need: ![](../images/image8.png) !!! Note - The VPN gateway automatically creates a dedicated subnet to accommodate its gateway VMs. Ensure that your cluster's virtual network address space has sufficient IP range for the subnet to prevent errors in the virtual network. For more information, see [Plan virtual networks](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-vnet-plan-design-arm#subnets). + The VPN gateway automatically creates a dedicated subnet to accommodate its gateway VMs. Ensure that your cluster's virtual network address space has sufficient IP range for the subnet to prevent errors in the virtual network. For more information, see [Add a subnet](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-manage-subnet#add-a-subnet). #### Step 2: Create a VPN gateway for the client VM virtual network diff --git a/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/images/image6.png b/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/images/image6.png index 97c8a340f46..b0c56aa85d5 100644 --- a/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/images/image6.png +++ b/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/images/image6.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0b737d6e0a1bf6da7210c7fd8f995efd20275827836cf0c50385067d675ab112 -size 70442 +oid sha256:9092c7c311cb9e34677814b092262840077a3379d6f31ab305fed39e43659c11 +size 70274 From aaaf9737b936c351e6f20e9d37adacb644cf7885 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 2 Nov 2021 06:22:13 -0400 Subject: [PATCH 3/6] fixed typo --- product_docs/docs/biganimal/release/reference/cli.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli.mdx b/product_docs/docs/biganimal/release/reference/cli.mdx index 6d5b1ea5b20..f60f6db949a 100644 --- a/product_docs/docs/biganimal/release/reference/cli.mdx +++ b/product_docs/docs/biganimal/release/reference/cli.mdx @@ -194,7 +194,7 @@ You can turn off the confirmation step with the `biganimal disable-confirm` comm 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 +$ biganimal show-cluster-connection --name my-biganimal-cluster --provider azure --region eastus ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Connection String ┃ ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ From aa1117b0e94dc65e45e438bb2f4472e0ccd1c0cf Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 2 Nov 2021 06:55:15 -0400 Subject: [PATCH 4/6] quick edit --- .../06_metrics.mdx | 29 +++++++++---------- .../index.mdx} | 2 +- 2 files changed, 15 insertions(+), 16 deletions(-) rename product_docs/docs/biganimal/release/using_cluster/{ => 05_monitoring_and_logging}/06_metrics.mdx (96%) rename product_docs/docs/biganimal/release/using_cluster/{05_monitoring_and_logging.mdx => 05_monitoring_and_logging/index.mdx} (97%) diff --git a/product_docs/docs/biganimal/release/using_cluster/06_metrics.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/06_metrics.mdx similarity index 96% rename from product_docs/docs/biganimal/release/using_cluster/06_metrics.mdx rename to product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/06_metrics.mdx index dce8e228c51..5e35840927c 100644 --- a/product_docs/docs/biganimal/release/using_cluster/06_metrics.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/06_metrics.mdx @@ -1,18 +1,18 @@ --- -title: "Metrics Details" +title: "Metrics details" --- A variety of metrics are collected by the BigAnimal instance and made available to the customer's Azure subscription for dashboarding, alerting, querying and other analytics. -See [Monitoring and Logging](#monitoring-and-logging) for an introduction to +See [Monitoring and logging](#monitoring-and-logging) for an introduction to the available monitoring capabilities. This section explains how to find and interpret the available metrics and logs. It also lists and describes the individual metrics provided. -## Understanding BigAnimal Logs and Metrics +## Understanding BigAnimal logs and metrics You can see example queries over these metrics by editing the predefined dashboard panels in the default shared dashboard. Some pre-defined queries @@ -27,9 +27,9 @@ Azure Monitor. A wide variety of analytics capabilities are available including time-series functions, seasonally adjusted statistics, alert generation and more. -## Available Logs and Metrics +## Available logs and metrics -The following tables in the _Customer Log Analytic workspace_ contain entries +The following tables in the Customer Log Analytic workspace contain entries specific to BigAnimal: | Table name | Description | @@ -50,20 +50,20 @@ Logs are split into structured fields matching those of the Postgres with a `record_` prefix and a type-suffix. For example the `application_name` is in the `record_application_name_s` log field. -The `pg_cluster_id_s` field identifies the specific postgres cluster +The `pg_cluster_id_s` field identifies the specific Postgres cluster that originated the log message. -## Metrics Overview +## Metrics overview -BigAnimal collects a wide set of metrics about postgres instances into the +BigAnimal collects a wide set of metrics about Postgres instances into the `InsightsMetrics` log analytics table. Most of these metrics are acquired -directly from postgres system tables, views, and functions. The postgres +directly from Postgres system tables, views, and functions. The Postgres documentation serves as the main reference for these metrics. KQL can be used to analyze time-series metrics, report latest samples of metrics, etc by querying the `InsightsMetrics` table. -Some data from postgres monitoring system views, tables and functions are +Some data from Postgres monitoring system views, tables and functions are transformed to be easier to consume in Prometheus metrics format. For example, timestamp fields are generally converted to unix epoch time and/or accompanied by a relative time-interval metric. Other metrics are aggregated into @@ -91,13 +91,13 @@ meaning or type of existing metrics without also changing the metric name. At time of writing all metrics forwarded from Prometheus are in the `prometheus` namespace. This may change in a future release. -Effective use of the available metrics will require an understanding of Azure +Effective use of the available metrics requires an understanding of Azure time-series data, metrics dimensions, and of the tagging conventions used in the metrics streams. ### Metrics tags -All postgres metrics share a common tagging scheme. Entries will generally +All Postgres metrics share a common tagging scheme. Entries will generally have at least the following tags: | Name | Description | @@ -582,10 +582,9 @@ See also: Additional streams of metrics may be supplied by the cloud platform itself directly to the customer's metrics, analytics and dashboarding endpoint. -### Dive Deeper +### Dive deeper -The capabilities available in the Azure portal are too broad to fully cover in this -documentation. They include the ability to: +Other capabilities available in the Azure portal, outside the scope of this documentation, include the ability to: * Discover metrics in the Azure Monitor Metrics Explorer (Monitor -> Metrics) * Query logs and metrics from the Azure Monitor Logs view (Monitor -> Logs) diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/index.mdx similarity index 97% rename from product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging.mdx rename to product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/index.mdx index 1615ab0b58b..6b57f89d6cb 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/index.mdx @@ -4,7 +4,7 @@ title: "Monitoring and logging" You can monitor your Postgres clusters by viewing the metrics and logs from Azure. For existing Postgres Enterprise Manager (PEM) users who wish to monitor EDB Cloud clusters alongside self-managed Postgres clusters, you can use the remote Remote Monitoring capability of PEM. For more information on using PEM to monitor your clusters see [Remote Monitoring](../../../../../pem/latest/pem_admin/02a_pem_remote_monitoring). -The following sections describe viewing metrics and logs directly from Azure. +The following sections describe viewing metrics and logs directly from Azure. See [Metrics details](06_metrics) for more information. ## Viewing metrics and logs from Azure From a183c0e63f456484ab18b6d930c539e485482070 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 2 Nov 2021 07:10:24 -0400 Subject: [PATCH 5/6] fixed instances of Big Cloud that snuck in with Criag's PR --- product_docs/docs/biganimal/release/reference/cli.mdx | 2 +- product_docs/docs/biganimal/release/reference/index.mdx | 2 +- .../release/using_cluster/05_monitoring_and_logging/index.mdx | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/biganimal/release/reference/cli.mdx b/product_docs/docs/biganimal/release/reference/cli.mdx index db02729f37c..bd28d7609c3 100644 --- a/product_docs/docs/biganimal/release/reference/cli.mdx +++ b/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. diff --git a/product_docs/docs/biganimal/release/reference/index.mdx b/product_docs/docs/biganimal/release/reference/index.mdx index b37ae2f2480..e1342dc9262 100644 --- a/product_docs/docs/biganimal/release/reference/index.mdx +++ b/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. \ No newline at end of file +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. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/index.mdx index 6b57f89d6cb..16ccbc66fa1 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/index.mdx @@ -2,13 +2,13 @@ title: "Monitoring and logging" --- -You can monitor your Postgres clusters by viewing the metrics and logs from Azure. For existing Postgres Enterprise Manager (PEM) users who wish to monitor EDB Cloud clusters alongside self-managed Postgres clusters, you can use the remote Remote Monitoring capability of PEM. For more information on using PEM to monitor your clusters see [Remote Monitoring](../../../../../pem/latest/pem_admin/02a_pem_remote_monitoring). +You can monitor your Postgres clusters by viewing the metrics and logs from Azure. For existing Postgres Enterprise Manager (PEM) users who wish to monitor BigAnimal clusters alongside self-managed Postgres clusters, you can use the remote Remote Monitoring capability of PEM. For more information on using PEM to monitor your clusters see [Remote Monitoring](../../../../../pem/latest/pem_admin/02a_pem_remote_monitoring). The following sections describe viewing metrics and logs directly from Azure. See [Metrics details](06_metrics) for more information. ## Viewing metrics and logs from Azure -EDB Cloud sends all metrics and logs from PostgreSQL clusters to Azure. The following describes what metrics and logs are sent and how to view them. +BigAnimal sends all metrics and logs from PostgreSQL clusters to Azure. The following describes what metrics and logs are sent and how to view them. ### Azure log analytics From c4a06f336afecb85e2772c9d29c58eaf9614b555 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Tue, 2 Nov 2021 12:12:33 -0400 Subject: [PATCH 6/6] rebranding fixes --- .../administering_cluster/01_portal_access.mdx | 18 +++++++++--------- .../03_account_activity.mdx | 4 ++-- .../release/administering_cluster/index.mdx | 2 +- .../02_connect_cloud_account.mdx | 18 +++++++++--------- .../creating_a_cluster/index.mdx | 4 ++-- .../release/getting_started/index.mdx | 2 +- .../connecting_your_cluster/index.mdx | 16 ++++++++-------- 7 files changed, 32 insertions(+), 32 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/01_portal_access.mdx b/product_docs/docs/biganimal/release/administering_cluster/01_portal_access.mdx index a45fa4bfc59..8b5936257d9 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/01_portal_access.mdx +++ b/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. diff --git a/product_docs/docs/biganimal/release/administering_cluster/03_account_activity.mdx b/product_docs/docs/biganimal/release/administering_cluster/03_account_activity.mdx index c0246fd4681..ab18200d676 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/03_account_activity.mdx +++ b/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: diff --git a/product_docs/docs/biganimal/release/administering_cluster/index.mdx b/product_docs/docs/biganimal/release/administering_cluster/index.mdx index e5088568d9b..2345981577a 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/index.mdx +++ b/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. diff --git a/product_docs/docs/biganimal/release/getting_started/02_connect_cloud_account.mdx b/product_docs/docs/biganimal/release/getting_started/02_connect_cloud_account.mdx index 3b893b9d097..aa66d53ab50 100644 --- a/product_docs/docs/biganimal/release/getting_started/02_connect_cloud_account.mdx +++ b/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,8 +112,8 @@ 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.** @@ -121,11 +121,11 @@ To connect your cloud account with your Azure subscription: ### 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. 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 index a321dae91f4..41243bca278 100644 --- 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 @@ -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**. diff --git a/product_docs/docs/biganimal/release/getting_started/index.mdx b/product_docs/docs/biganimal/release/getting_started/index.mdx index e5010697056..afded0078d2 100644 --- a/product_docs/docs/biganimal/release/getting_started/index.mdx +++ b/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. diff --git a/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/index.mdx b/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/index.mdx index 47ce260e249..e366640782a 100644 --- a/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/connecting_your_cluster/index.mdx @@ -11,9 +11,9 @@ You can connect to your cluster using [`psql`](http://postgresguide.com/utilitie ## Using `psql` To connect to your cluster using `psql`: -1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal. +1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. -1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. +1. Go to the [**Clusters**](https://portal.biganimal.com/clusters) page. 3. Select the name of your cluster. 4. On the **Overview** tab, select the copy icon to the right of the **Quick Connect** field to copy the command for connecting to your cluster using `psql` to your clipboard. `psql` will prompt for the edb_admin user password you selected at cluster creation time. @@ -21,9 +21,9 @@ To connect to your cluster using `psql`: ## Using another client To connect to your cluster using a client other than `psql`: -1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal. +1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. -1. Go to the [**Clusters**](https://portal.edbcloud.com/clusters) page. +1. Go to the [**Clusters**](https://portal.biganimal.com/clusters) page. 2. Select the name of your cluster. 3. Select the **Connect** tab. You can review and copy all the relevant information you need from this screen except for the edb_admin user password. Please consult the client driver documentation for the connection string format the driver uses. @@ -32,17 +32,17 @@ To connect to your cluster using a client other than `psql`: Different clients can have different default TLS/SSL modes (sslmode). For example, `psql` defaults to `prefer`, which means the client will attempt to establish a TLS connection but fall back to non-TLS if the server does not support it. In the `psql` example provided by EDB in the **Quick Connect** field, `sslmode` is explicitly set to `require`, which means the client will attempt a TLS connection and fail if the connection to the server can't be encrypted. -For public connections and in most environments, EDB recommends setting `sslmode` to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. EDB Cloud generates certificates with LetsEncrypt, a widely trusted certificate authority. Your client machine may already have a bundled CA certificate for LetsEncrypt, for example, at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine needs a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection: +For public connections and in most environments, EDB recommends setting `sslmode` to `verify-full`. This ensures that you connect to the server you specified and that the connection is encrypted. BigAnimal generates certificates with LetsEncrypt, a widely trusted certificate authority. Your client machine may already have a bundled CA certificate for LetsEncrypt, for example, at `/etc/ssl/certs/ca-certificates.crt` or `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`. If it doesn't, your client machine needs a [CA certificate for Let's Encrypt](https://letsencrypt.org/certificates/). Once the CA certificate is in place on your client machine, configure the `sslrootcert` parameter to its location and set the `sslmode` parameter to `verify-full` to verify the certificate to fully validate the connection: ``` -psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.edbcloud.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/isrgrootx1.pem" +psql -W "postgres://edb_admin@xxxxxxxxx.xxxxx.biganimal.io:5432/edb_admin?sslmode=verify-full&sslrootcert=/usr/share/ca-certificates/isrgrootx1.pem" ``` -Once connected to the cluster using `psql`, the `conninfo` meta-command shows the encryption protocol being used for communication. In the case of EDB Cloud, TLS (v1.2+) is supported: +Once connected to the cluster using `psql`, the `conninfo` meta-command shows the encryption protocol being used for communication. In the case of BigAnimal, TLS (v1.2+) is supported: ``` edb_admin=> \conninfo -You are connected to database "edb_admin" as user "edb_admin" on host "xxxxxxxxx.xxxxx.edbcloud.io" at port "5432". +You are connected to database "edb_admin" as user "edb_admin" on host "xxxxxxxxx.xxxxx.biganimal.io" at port "5432". SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) ```