From 1aa76a17f1338e392343c93fb7d70ed3fa04dbe8 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman <93718720+ebgitelman@users.noreply.github.com> Date: Fri, 6 Oct 2023 14:46:35 -0400 Subject: [PATCH 1/6] Edits needed for PostGis addition --- .../docs/biganimal/release/using_cluster/extensions.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/extensions.mdx b/product_docs/docs/biganimal/release/using_cluster/extensions.mdx index bb6bacf17f9..771cca60523 100644 --- a/product_docs/docs/biganimal/release/using_cluster/extensions.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/extensions.mdx @@ -42,6 +42,7 @@ PostgreSQL contrib extensions/modules: - pglogical3 (PostgreSQL v12 and v13 only) - pgrowlocks - pgstattupple +- postgis - postgres_fdw - seg (PostgreSQL v12 only) - sslinfo @@ -69,7 +70,7 @@ EDB extensions: ## Installing extensions -Use the [`CREATE EXTENSION`](https://www.postgresql.org/docs/current/sql-createextension.html) command to install extensions, except for the EDB Postgres Tuner (pg_tuner) extension. You enable edb_pg_tuner on the **DB Configuration** tab of the Create or Edit Cluster page of the BigAnimal portal. +Use the [`CREATE EXTENSION`](https://www.postgresql.org/docs/current/sql-createextension.html) command to install most extensions. You must enable certain extensions, including the EDB Postgres Tuner (pg_tuner) extension and PostGIS on the **DB Configuration** tab of the Create or Edit Cluster page of the BigAnimal portal. ### Example: Installing multiple extensions From e99a2fe230b6ef1a69268b67af86fc9431e0e6ab Mon Sep 17 00:00:00 2001 From: francoughlin Date: Fri, 8 Sep 2023 15:21:25 -0400 Subject: [PATCH 2/6] BigAnimal-UPM-23034-Create-credentials-for-alternative-organizations Added new section to the Using the BigAnimal CLI topic for "Creating credentials for an alternative organization" --- .../biganimal/release/reference/cli/index.mdx | 43 ++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/index.mdx b/product_docs/docs/biganimal/release/reference/cli/index.mdx index 88d2576049d..8abaef51b1c 100644 --- a/product_docs/docs/biganimal/release/reference/cli/index.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/index.mdx @@ -48,7 +48,7 @@ chmod +x biganimal ``` -## Authenticate as a valid user +## Authenticating as a valid user Before using the CLI to manage BigAnimal, you need to authenticate as a valid BigAnimal user. Use the `credential create` command to authenticate through the BigAnimal website and assign a refresh token and an access token to a local credential. For example: @@ -95,6 +95,47 @@ The credential ba-user1 has been set up ```shell biganimal config set context_credential ba-user1 +``` +## Creating credentials for an alternative organization + +The BigAnimal CLI supports the capability to create credentials for an alternative organization to which you have been invited to or are already a member. + +If you been invited to join an organization (from the **Invite New User** option on the **Users** page in the BigAnimal portal) and want to create credentials for that organization, do one of the following: + +1. Specify the organization name when using the `credential create` command: + +```shell +biganimal credential create -name ba-user2 --organization "org_aNR8SNuNbUN4vGSn" +``` + +2. Select the organization from the list in interactive mode: + +```shell +biganimal credential create +__OUTPUT__ +? Credential Name: ba-user2 +? Organization: [Use arrows to move, type to filter] + My_Organization +> org_aNR9SNuNcUN6vGSn + +? Organization: org_aNR9SNuNcUN6vGSn +Credential "ba-user2" is created operation succeeded +Switched the context credential to "ba-user2". +``` + +You can verify the operation by calling `credential show`: + +```shell +biganimal credential show +__OUTPUT__ +┌────────────────────────────────────────────────────────────────────────────────────┐ +│ Credentials │ +├──────────┬──────────────────────┬──────────────────────┬──────┬────────────────────┤ +│ name │ Organization │ address │ port │ context credential │ +├──────────┼──────────────────────┼──────────────────────┼──────┼────────────────────┤ +│ ba-user2 │ org_aNR9SNuNcUN6vGSn │ portal.biganimal.com │ 443 │ x │ +└──────────┴──────────────────────┴──────────────────────┴──────┴────────────────────┘ + ``` ## Configuring From cb2772e215a458a1f587c57f20ad6ec60ebbbbc0 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Fri, 8 Sep 2023 15:53:57 -0400 Subject: [PATCH 3/6] Updated output for credential show Added new organization column to the table --- .../biganimal/release/reference/cli/index.mdx | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/index.mdx b/product_docs/docs/biganimal/release/reference/cli/index.mdx index 8abaef51b1c..e78a88eaa94 100644 --- a/product_docs/docs/biganimal/release/reference/cli/index.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/index.mdx @@ -82,14 +82,15 @@ You can create multiple credentials for different BigAnimal accounts and then se ```shell biganimal credential show __OUTPUT__ -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Credentials ┃ -┣━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┫ -┃ name ┃ address ┃ port ┃ context credential ┃ -┃━━━━━━━━━━┃━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┃━━━━━━┃━━━━━━━━━━━━━━━━━━━━━━━━━┃ -┃ ba-user1 ┃ portal.biganimal.com ┃ 443 ┃ x ┃ -┃ ba-user2 ┃ portal.biganimal.com ┃ 443 ┃ ┃ -┗━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┌────────────────────────────────────────────────────────────────────────────────────┐ +│ Credentials │ +├──────────┬──────────────────────┬──────────────────────┬──────┬────────────────────┤ +│ name │ Organization │ address │ port │ context credential │ +├──────────┼──────────────────────┼──────────────────────┼──────┼────────────────────┤ +│ ba-user1 │ My_organization │ portal.biganimal.com │ 443 │ x │ +│ ba-user2 │ My_organization │ portal.biganimal.com │ 443 │ │ +└──────────┴──────────────────────┴──────────────────────┴──────┴────────────────────┘ + The credential ba-user1 has been set up ``` From b9ae2e19a59c84fe9e656e35c4c8adb560178a7b Mon Sep 17 00:00:00 2001 From: francoughlin Date: Fri, 8 Sep 2023 17:09:55 -0400 Subject: [PATCH 4/6] Feedback from Dee Dee Multiple edits --- .../biganimal/release/reference/cli/index.mdx | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/index.mdx b/product_docs/docs/biganimal/release/reference/cli/index.mdx index e78a88eaa94..2a7c468d1c3 100644 --- a/product_docs/docs/biganimal/release/reference/cli/index.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/index.mdx @@ -99,32 +99,32 @@ biganimal config set context_credential ba-user1 ``` ## Creating credentials for an alternative organization -The BigAnimal CLI supports the capability to create credentials for an alternative organization to which you have been invited to or are already a member. +The BigAnimal CLI supports the capability to create credentials for an alternative organization to which you have been invited or are already a member. You can invite users that have an EDB account to join an organization by selecting the **Invite New User** option on the Users page in the BigAnimal portal. -If you been invited to join an organization (from the **Invite New User** option on the **Users** page in the BigAnimal portal) and want to create credentials for that organization, do one of the following: +To create credentials for an alternative organization, you can use either interactive mode or specify the settings with flags on the command line: -1. Specify the organization name when using the `credential create` command: +- Select the organization from the list in interactive mode: -```shell -biganimal credential create -name ba-user2 --organization "org_aNR8SNuNbUN4vGSn" -``` + ```shell + biganimal credential create + __OUTPUT__ + ? Credential Name: ba-user2 + ? Organization: [Use arrows to move, type to filter] + My_Organization + > org_aNR9SNuNcUN6vGSn + + ? Organization: org_aNR9SNuNcUN6vGSn + Credential "ba-user2" is created operation succeeded + Switched the context credential to "ba-user2". + ``` -2. Select the organization from the list in interactive mode: +- Specify the organization name in the `credential create` command: -```shell -biganimal credential create -__OUTPUT__ -? Credential Name: ba-user2 -? Organization: [Use arrows to move, type to filter] - My_Organization -> org_aNR9SNuNcUN6vGSn - -? Organization: org_aNR9SNuNcUN6vGSn -Credential "ba-user2" is created operation succeeded -Switched the context credential to "ba-user2". -``` + ```shell + biganimal credential create -name ba-user2 --organization "org_aNR8SNuNbUN4vGSn" + ``` -You can verify the operation by calling `credential show`: +You can verify the operation using `credential show`: ```shell biganimal credential show From 96f005a96b8dbfdd21e490e58754b7c510d93081 Mon Sep 17 00:00:00 2001 From: francoughlin Date: Tue, 12 Sep 2023 09:21:10 -0400 Subject: [PATCH 5/6] Updated code sample per review comment --- product_docs/docs/biganimal/release/reference/cli/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/index.mdx b/product_docs/docs/biganimal/release/reference/cli/index.mdx index 2a7c468d1c3..3991b6f7c9b 100644 --- a/product_docs/docs/biganimal/release/reference/cli/index.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/index.mdx @@ -111,9 +111,9 @@ To create credentials for an alternative organization, you can use either intera ? Credential Name: ba-user2 ? Organization: [Use arrows to move, type to filter] My_Organization - > org_aNR9SNuNcUN6vGSn + > My_Organization_2 - ? Organization: org_aNR9SNuNcUN6vGSn + ? Organization: My_Organization_2 Credential "ba-user2" is created operation succeeded Switched the context credential to "ba-user2". ``` @@ -121,7 +121,7 @@ To create credentials for an alternative organization, you can use either intera - Specify the organization name in the `credential create` command: ```shell - biganimal credential create -name ba-user2 --organization "org_aNR8SNuNbUN4vGSn" + biganimal credential create -name ba-user2 --organization "My_Organization_2" ``` You can verify the operation using `credential show`: From 8bbae7e26de34ab081f163937d9b445d49a7d722 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Wed, 11 Oct 2023 15:58:03 +0530 Subject: [PATCH 6/6] Removed the cross-csp content from develop --- .../release/overview/02_high_availability.mdx | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx index 5d232f90a8c..d85a4212719 100644 --- a/product_docs/docs/biganimal/release/overview/02_high_availability.mdx +++ b/product_docs/docs/biganimal/release/overview/02_high_availability.mdx @@ -76,16 +76,6 @@ A true active-active solution that protects against regional failures, a two dat ![region(2 data + 1 shadow) + region(2 data + 1 shadow) + region(1 witness)](images/Multi-Region-3Nodes.png) -### Cross-Cloud Service Providers(CSP) data groups - -Cross-CSP witness groups are available with AWS, Azure and GCP, on BYOA and BAH. It is enabled by default and applies to both multi-region configurations available with PGD. The database price is not charged for witness groups, it is charged for the infrastructure it uses. The cost of the cross-CSP witness group is reflected in the pricing estimate footer. - -By default, the CSP selected for the data groups is pre-selected for the witness group. Now users can change the CSP of the witness group to be one of the other two CSPs. - -### Cross-Cloud Service Providers(CSP) witness groups - -Users select the CSP for their data groups at the time of creating the data group, before selecting the number of nodes. The default selected CSP is AWS. Once user selects the CSP for the first data group, it is automatically selected for the next created data groups and the witness group. Users can't edit the CSP after creating the cluster. - ## For more information For instructions on creating a distributed high-availability cluster using the BigAnimal portal, see [Creating a distributed high-availability cluster](../getting_started/creating_a_cluster/creating_an_eha_cluster/).