From 67769a07be0f5aa54de9364b80dc898f0e904bc7 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 6 Jul 2022 19:07:08 -0400 Subject: [PATCH 1/5] BigAnimal: new Azure flow adjustments --- .../getting_started/02_azure_market_setup.mdx | 63 +++++++ .../01_connecting_your_own_cloud.mdx | 98 ---------- .../02_azure_market_setup.mdx | 172 ------------------ .../02_connecting_to_your_cloud/index.mdx | 101 +++++++++- .../identity_provider/index.mdx | 1 + .../release/getting_started/index.mdx | 5 + 6 files changed, 163 insertions(+), 277 deletions(-) create mode 100644 product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx delete mode 100644 product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud.mdx delete mode 100644 product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/02_azure_market_setup.mdx diff --git a/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx new file mode 100644 index 00000000000..1f3853dc505 --- /dev/null +++ b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx @@ -0,0 +1,63 @@ +--- +title: "Setting up your Azure Marketplace account" +description: "Applies when you purchased BigAnimal from Azure Marketplace" +redirects: +- /biganimal/latest/getting_started/02_connecting_to_your_cloud/02_azure_market_setup/ +--- + + +Connect your cloud account with your Azure subscription. + +## 1. Select the EDB offer in the Azure portal. + +1. Sign in to the [Azure portal](https://portal.azure.com/) and go to Azure **Marketplace**. + +2. Find an offer from **EnterpriseDB Corporation** and select it. + +3. From the **Select Plan** list, select an available plan. + +4. Select **Set up + subscribe**. + +## 2. Fill out the details for your plan. + +1. In the **Project details** section, enter or create a resource group for your subscription. See [What is a resource group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for more information. + +2. In the **SaaS details** section, enter the SaaS subscription name. + +3. Select **Review + subscribe**. + +## 3. Accept terms of use. + +1. Review the terms of use provided by EDB. + +2. Select **Subscribe**. + +## 4. Configure your account. + +!!! Note + After step 1, you are prompted for approval by an Azure AD administrator with either the Global Administrator or Privileged Role Administrator role. + +1. To configure BigAnimal to use your Azure subscription and your Azure AD Application, select **Configure account now**. + +2. Fill in the **Your BigAnimal Organization Name** parameter with the SaaS Subscription Name you assigned as your BigAnimal Organization. + +3. Select **Submit**. + +## What's next + +You are now able to: + +- [log in to BigAnimal](log-in) +- [invite new users] +- [Set up your cloud service provider](02_connecting_to_your_cloud/01_connecting_your_own_cloud) + +### Log in + +You can now log in to your BigAnimal account using your Azure AD identity. + +### Invite users + +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 can assign them a role with permissions to BigAnimal. See [Assign roles to users](/biganimal/release/administering_cluster/01_portal_access/#assign-roles-to-users) for instructions. + +!!! Note + Azure AD email domain is likely different from the email domain regularly used by your organization. diff --git a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud.mdx b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud.mdx deleted file mode 100644 index de917a4441d..00000000000 --- a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Connecting your own cloud account -navTitle: Connecting your own cloud -description: "Use BigAnimal with your own cloud account" ---- - -You can connect BigAnimal to your own Azure subscription or AWS account. To connect to your own cloud account, EDB provides a command that automatically sets up your account. - -**Prerequisites**: - -Before connecting to your cloud account, ensure that: - - - **If connecting to an AWS account:** - - You are assigned the following AWS managed policies (or an equivalent custom policy granting full access to resources): - - - arn:aws:iam::aws:policy/IAMFullAccess - - - arn:aws:iam::aws:policy/ServiceQuotasFullAccess - - - **If connecting to an Azure subscription:** - - You are assigned either of the following roles in Azure AD: - - - Global Administrator - - - Privileged Role Administrator - - - In [Azure Cloud Shell](https://shell.azure.com/) or [AWS Cloud Shell](https://console.aws.amazon.com/cloudshell), your environment is running: - - - 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). - - - 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. - - ```shell - biganimal create-credential --name --address portal.biganimal.com --port 443 - ``` - -1. Run the `setup-csp` command to set up your cloud provider. The synatx is: - - ```shell - setup-csp --provider - {--account-id | --subscription-id} - --region - [--instance-type --high-availability --networking | --skip-preflight] - [--run] - ``` - - 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 --high-availability --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 --high-availability --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 - ``` - -1. The command checks for cloud account readiness and displays the results. You need to manually increase resource limits or perform required configurations in your cloud, if either of the following readiness checks are not met: - * **If connecting to Azure**: - - Are the necessary Azure resource providers registered for your subscription? - - Is there a restriction on SKUs for the standard Esv3 family and standard D2_v4 VM size? - - Is the limit on the number of vCPU and public IP addresses in your region sufficient for your clusters? - * **If connecting to AWS**: - - Is the AWS CLI configured to access your AWS account? - - Is the limit on the number of vCPUs and Network Load Balancers (NLBs) in your region sufficient for your clusters? - - !!! Important - You need to configure your cloud, if any of the readiness checks are not met, see [Configure your Azure subscription](/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure#configure-your-azure-subscription) or [Configure your AWS account](/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws/#configure-your-aws-account). - -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 - ``` - -Once your cloud account is successfully connected to BigAnimal, you and other users can log in using your identity provider credentials. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/02_azure_market_setup.mdx b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/02_azure_market_setup.mdx deleted file mode 100644 index c163bdac6e7..00000000000 --- a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/02_azure_market_setup.mdx +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: "Connecting your Azure Marketplace account" -description: "Use your Azure Marketplace account to connect to BigAnimal" ---- - -Your Azure subscription for BigAnimal is where you create and manage Postgres clusters. -Set up your BigAnimal account on Azure Marketplace, as follows: - -1. Ensure you have an active Microsoft Azure subscription. If you need to create one, see [Create an additional Azure subscription](https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/create-subscription). - -2. In Azure Active Directory, ensure your role is owner and your user type is member (not guest) for the subscription you are using. - -3. Create an Azure Active Directory Application client to delegate Identity and Access Management functions to Azure Active Directory (AD). You can create the Azure Active Directory Application using the Azure Portal, but a simpler and less error-prone approach is to use the `create-spn` script (see [Create Azure Active Directory Application using `create-spn`](#create-azure-active-directory-application-using-create-spn)). The script approach requires the Azure API. - -!!! Note - Some steps of the subscription process require approval of an Azure AD administrator. - Your Azure role in the Azure AD must be either: - - - Global Administrator - - Privileged Role Administrator - - or you need the cooperation of a user with one of those roles in your organization. - -### Create Azure Active Directory Application using the Azure portal - -!!! Note - Create your Azure AD Application in the same tenant as the subscription you want to associate it with.  - -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**, as you need it to configure your BigAnimal account. Also take note of the **Display name** value of the Azure AD application. You need to enter this value later. - -2. Select *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, as you need it to configure your cloud account. - -3. Select *API permissions* to configure API permissions for the application. See [Configure a client application to access Azure Active Directory API](https://docs.microsoft.com/en-us/azure/active-directory/reports-monitoring/howto-configure-prerequisites-for-reporting-api) for instructions. Add Application permissions with Microsoft Graph *Application.ReadWrite.OwnedBy* and *Directory.Read.All* to your application and grant admin consent for your cloud account. - -4. 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. In the **Select** field of the **Add role assignment** panel, enter the display name of the Azure AD application. 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` - -To simplify the process of creating an Azure AD Application, EDB provides the `create-spn` script for Azure API users (available [here](https://github.com/EnterpriseDB/cloud-utilities/blob/main/azure)). The script automates the creation of the Active Directory Application. -Before using the script, ensure that these utilities are installed on your machine: - -- [jq command-line JSON processor](https://stedolan.github.io/jq/) -- [azure cli](https://docs.microsoft.com/en-us/cli/azure/) v2.26 or above - -Alternatively, you can run the script in [Azure Cloud Shell](https://azure.microsoft.com/en-us/features/cloud-shell/?ef_id=CjwKCAiA3L6PBhBvEiwAINlJ9Pj1wF0QH8KpGtC5Z4qIy21h5fcsP7tDYtBPxNLP-UMFaIiQY-EEuhoCppEQAvD_BwE%3AG%3As&OCID=AID2200202_SEM_CjwKCAiA3L6PBhBvEiwAINlJ9Pj1wF0QH8KpGtC5Z4qIy21h5fcsP7tDYtBPxNLP-UMFaIiQY-EEuhoCppEQAvD_BwE%3AG%3As&gclid=CjwKCAiA3L6PBhBvEiwAINlJ9Pj1wF0QH8KpGtC5Z4qIy21h5fcsP7tDYtBPxNLP-UMFaIiQY-EEuhoCppEQAvD_BwE#overview). - -The syntax of the command is: - -```shell -curl -sL https://raw.githubusercontent.com/EnterpriseDB/cloud-utilities/main/azure/create-spn.sh | bash -s -- \ ---display-name \ ---subscription \ ---years -``` - -Flag and option details: - -| Flag/option shortcut | Flag/option long name | Description | -| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| -d <display-name> | --display-name <display-name> | Name of Azure AD Application. | -| -s <subscription> | --subscription <subscription> | 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. | - -The script creates the Azure AD Service Principal and configures its access to Azure resources in the specified subscription. - -The specific output includes the client ID and client secret you use when you configure your account. See [Step 4. Configure your account](#4-configure-your-account). - -#### Example - -To create an Azure AD Application with the subscription ID `c808xxxx-xxxx-xxxx-xxxx-xxxxxxxxb712` and display name `hello-s`: - -``` -curl -sL https://raw.githubusercontent.com/EnterpriseDB/cloud-utilities/main/azure/create-spn.sh | bash -s -- \ ---display-name "hello-s" \ ---subscription c808xxxx-xxxx-xxxx-xxxx-xxxxxxxxb712 \ ---years 2 -Change to use Azure Subscription c808xxxx-xxxx-xxxx-xxxx-xxxxxxxxb712... -{ - "environmentName": "AzureCloud", - "homeTenantId": "fb0cxxxx-xxxx-xxxx-xxxx-xxxxxxxx3d0f", - "id": "c808xxxx-xxxx-xxxx-xxxx-xxxxxxxxb712", - "isDefault": true, - "managedByTenants": [], - "name": "development", - "state": "Enabled", - "tenantId": "fb0cxxxx-xxxx-xxxx-xxxx-xxxxxxxx3d0f", - "user": { - "name": "xxxx", - "type": "user" - } -} -Creating Azure AD Service Principal and configuring its access to Azure resources in subscription c808xxxx-xxxx-xxxx-xxxx-xxxxxxxxb712... -Waiting 15 seconds for Azure AD Service Principal to propagate... -Add Azure AD Service Principal Owners... -{ - "client_id": "a756xxxx-xxxx-xxxx-xxxx-xxxxxxxx84da", - "client_secret": "xxxx", - "subscription": "c808xxxx-xxxx-xxxx-xxxx-xxxxxxxxb712" -} -``` - -If you receive the following error message, you need to request admin consent for your cloud account. Only users with the Azure AD Global Administrator or Privileged Role Administrator role can grant admin consent. - -```text -... -Error: Please request Azure AD Global Administrator or Privileged Role Administrator to grant admin consent permissions for Service Principal hello-s(77bbxxxx-xxxx-xxxx-xxxx-xxxxxxxx7c54) -``` - -To grant admin consent you, or another user with the Azure AD Global Administrator or Privileged Role Administrator role, go to [App registrations](https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) in the Azure portal and select **API permissions**. - - -## Connect your cloud account - -Connect your cloud account with your Azure subscription. - -#### 1. Select the EDB offer in the Azure portal. - -1. Sign in to the [Azure portal](https://portal.azure.com/) and go to Azure **Marketplace**. - -2. Find an offer from **EnterpriseDB Corporation** and select it. - -3. From the **Select Plan** list, select an available plan. - -4. Select **Set up + subscribe**. - -#### 2. Fill out the details for your plan. - -1. In the **Project details** section, enter or create a resource group for your subscription. See [What is a resource group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group) for more information. - -2. In the **SaaS details** section, enter the SaaS subscription name. - -3. Select **Review + subscribe**. - -#### 3. Accept terms of use. - -1. Review the terms of use provided by EDB. - -2. Select **Subscribe**. - -#### 4. Configure your account. - -!!! Note - After step 1, you are prompted for approval by an Azure AD administrator with either the Global Administrator or Privileged Role Administrator role. - -1. To configure BigAnimal to use your Azure subscription and your Azure AD Application. select **Configure account now**. - - -2. Fill in the parameters in the form: - - | Parameter | Description | - | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | **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)). | - -3. Select **Submit**. - -## What's next - -### Log in - -If you filled in the parameters correctly, you can now log in to your BigAnimal account using your Azure AD identity. - -### Invite users - -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 can assign them a role with permissions to BigAnimal. See [Assign roles to users](/biganimal/release/administering_cluster/01_portal_access/#assign-roles-to-users) for instructions. - -!!! Note - Azure AD email domain is likely different from the email domain regularly used by your organization. diff --git a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx index de9721a3cb0..7b1d670c2b2 100644 --- a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx @@ -3,18 +3,105 @@ title: Connecting your cloud indexCards: simple redirects: - ../02_connect_cloud_account/ + - /biganimal/release/getting_started/02_connecting_to_your_cloud/01_connecting_your_own_cloud --- -Before connecting to your cloud, you must set permissions to allow BigAnimal to perform maintenance operations in your cloud. + +Before connecting to your cloud, -* **If connecting to Azure**: - Register an application with Azure AD and create a service principal to delegate Identity and Access Management functions to Azure Active Directory (AD). +- You must set permissions to allow BigAnimal to perform maintenance operations in your cloud. -* **If connecting to AWS**: + - **If connecting to AWS**: Create a role EDBOperations and set its *policy/trust* and *policy/policy* boundaries to * with EDB's AWS account. This allows EDB's IAM users to assume the EDBOperations role in your AWS account. -BigAnimal CLI commands used in the procedures for connecting your cloud to BigAnimal automatically sets these permissions for you. For more information, see EDB cloud utilites in GitHub for [Azure](https://github.com/EnterpriseDB/cloud-utilities/tree/main/azure) and [AWS](https://github.com/EnterpriseDB/cloud-utilities/tree/main/aws). + - **If connecting to Azure**: + Register an application with Azure AD and create a service principal to delegate Identity and Access Management functions to Azure Active Directory (AD). + + BigAnimal CLI commands used in the procedures for connecting your cloud to BigAnimal automatically sets these permissions for you. For more information, see EDB cloud utilites in GitHub for [Azure](https://github.com/EnterpriseDB/cloud-utilities/tree/main/azure) and [AWS](https://github.com/EnterpriseDB/cloud-utilities/tree/main/aws). + + - **If connecting to an AWS account, ensure that:** + + You are assigned the following AWS managed policies (or an equivalent custom policy granting full access to resources): + + - arn:aws:iam::aws:policy/IAMFullAccess + + - arn:aws:iam::aws:policy/ServiceQuotasFullAccess + + - **If connecting to an Azure subscription, ensure that:** + + You are assigned either of the following roles in Azure AD: + + - Global Administrator + + - Privileged Role Administrator + + - In [Azure Cloud Shell](https://shell.azure.com/) or [AWS Cloud Shell](https://console.aws.amazon.com/cloudshell), ensure that your environment is running: + + - 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). + + - 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. + + ```shell + biganimal create-credential --name --address portal.biganimal.com --port 443 + ``` + +1. Run the `setup-csp` command to set up your cloud provider. The synatx is: + + ```shell + setup-csp --provider + {--account-id | --subscription-id} + --region + [--instance-type --high-availability --networking | --skip-preflight] + [--run] + ``` + + 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 --high-availability --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 --high-availability --networking private --run + ``` + + For more information on the command arguments, run the following command: -## Connect your cloud to BigAnimal + ```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 + ``` + +1. The command checks for cloud account readiness and displays the results. You need to manually increase resource limits or perform required configurations in your cloud, if either of the following readiness checks are not met: + * **If connecting to Azure**: + - Are the necessary Azure resource providers registered for your subscription? + - Is there a restriction on SKUs for the standard Esv3 family and standard D2_v4 VM size? + - Is the limit on the number of vCPU and public IP addresses in your region sufficient for your clusters? + * **If connecting to AWS**: + - Is the AWS CLI configured to access your AWS account? + - Is the limit on the number of vCPUs and Network Load Balancers (NLBs) in your region sufficient for your clusters? + + !!! Important + You need to configure your cloud, if any of the readiness checks are not met, see [Configure your Azure subscription](/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure#configure-your-azure-subscription) or [Configure your AWS account](/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws/#configure-your-aws-account). + +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 + ``` -How you connect your cloud to BigAnimal depends on if you purchased BigAnimal from the Azure Marketplace or if you purchased it directly from EDB and are connecting your own cloud account. \ No newline at end of file +Once your cloud account is successfully connected to BigAnimal, you and other users can log in using your identity provider credentials. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx b/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx index bf04e97c5fa..ee46a9d3406 100644 --- a/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx @@ -1,6 +1,7 @@ --- title: "Setting up your identity provider" navTitle: "Setting up your identity provider" +description: Applies when you purchased BigAnimal directly from EDB --- If you purchased BigAnimal directly from EDB, you must set up your identity provider (IDP) before accessing BigAnimal for the first time. After setting up your identity provider, you can add users to BigAnimal by adding them to the designated group in your identity provider. Once you've logged into BigAnimal using your identity provider, you can set up your cloud service provider (CSP) in the BigAnimal portal to complete onboarding. If you purchased through Azure Marketplace, BigAnimal authenticates users using Azure Active Directory (AD) and you don't have to complete these steps, as Azure AD is linked during subscription. diff --git a/product_docs/docs/biganimal/release/getting_started/index.mdx b/product_docs/docs/biganimal/release/getting_started/index.mdx index f7b3a1b71ec..c101a343fd3 100644 --- a/product_docs/docs/biganimal/release/getting_started/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/index.mdx @@ -4,9 +4,14 @@ indexCards: simple navigation: - 00_free_trial - identity_provider + - 02_azure_market_setup - 02_connecting_to_your_cloud - preparing_cloud_account - creating_a_cluster --- As a cloud administrator, you can set up BigAnimal with your existing Azure subscription or AWS account, invite others to join you in exploring what EDB has to offer, and create initial clusters as an account owner so that development can begin. + +If you purchase BigAnimal directly from EDB Sales, you need to [set up your own identity provider]. If you purchased from Azure Marketplace, you need to [set up your Azure account]. + +After setting up your organization, you connect your cloud account to BigAnimal. \ No newline at end of file From 221bc16d4188c30594fe4667666bdeeaaf04fb2e Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 7 Jul 2022 05:27:56 -0400 Subject: [PATCH 2/5] Clarifying what users can do after setting up their accounts versus connecting --- .../getting_started/02_connecting_to_your_cloud/index.mdx | 2 +- .../release/getting_started/identity_provider/index.mdx | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx index 7b1d670c2b2..3967fa8fb75 100644 --- a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx @@ -104,4 +104,4 @@ Perform the following steps: biganimal connect-csp --provider ``` -Once your cloud account is successfully connected to BigAnimal, you and other users can log in using your identity provider credentials. \ No newline at end of file +Once your cloud account is successfully connected to BigAnimal, you and, other users with the create permissions, can create clusters. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx b/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx index ee46a9d3406..1d995dd1f3b 100644 --- a/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/identity_provider/index.mdx @@ -83,4 +83,6 @@ For step-by-step instructions for setting up specific identity providers, see: ## Next steps -[Setting up your cloud service provider](02_connecting_to_your_cloud/01_connecting_your_own_cloud) +You and other users can log in to BigAnimal using your identity provider credentials. + +You can [Set up your cloud service provider](02_connecting_to_your_cloud/01_connecting_your_own_cloud) so that you or other users with the correct permissions can create clusters. From 59e7b321ed2b857984a295597c0bb35367bc02e3 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 7 Jul 2022 05:52:47 -0400 Subject: [PATCH 3/5] adding links and adjusting language --- .../getting_started/02_connecting_to_your_cloud/index.mdx | 2 +- product_docs/docs/biganimal/release/getting_started/index.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx index 3967fa8fb75..40bf7130d03 100644 --- a/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/02_connecting_to_your_cloud/index.mdx @@ -104,4 +104,4 @@ Perform the following steps: biganimal connect-csp --provider ``` -Once your cloud account is successfully connected to BigAnimal, you and, other users with the create permissions, can create clusters. \ No newline at end of file +Once your cloud account is successfully connected to BigAnimal, you and, other users with the correct permissions, can create clusters. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/getting_started/index.mdx b/product_docs/docs/biganimal/release/getting_started/index.mdx index c101a343fd3..65d7845dc25 100644 --- a/product_docs/docs/biganimal/release/getting_started/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/index.mdx @@ -12,6 +12,6 @@ navigation: As a cloud administrator, you can set up BigAnimal with your existing Azure subscription or AWS account, invite others to join you in exploring what EDB has to offer, and create initial clusters as an account owner so that development can begin. -If you purchase BigAnimal directly from EDB Sales, you need to [set up your own identity provider]. If you purchased from Azure Marketplace, you need to [set up your Azure account]. +If you purchase BigAnimal directly from EDB Sales, you need to [set up your own identity provider](/biganimal/release/getting_started/identity_provider). If you purchased from Azure Marketplace, you need to [set up your Azure account](/biganimal/release/getting_started/02_azure_market_setup). -After setting up your organization, you connect your cloud account to BigAnimal. \ No newline at end of file +After setting up your organization through your identity provider or Azure Marketplace account, you connect your cloud account to BigAnimal. \ No newline at end of file From 81b73cc5ce9bc48ef1a0a8fe35bfa14d0f0f0492 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 7 Jul 2022 05:58:35 -0400 Subject: [PATCH 4/5] added note about deprecated process --- .../biganimal/release/getting_started/02_azure_market_setup.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx index 1f3853dc505..c9dca1eef61 100644 --- a/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx +++ b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx @@ -5,6 +5,8 @@ redirects: - /biganimal/latest/getting_started/02_connecting_to_your_cloud/02_azure_market_setup/ --- +!!!note + We have deprecated the manual, script-based process for setting up your Azure Marketplace account. For information on the deprecated process, contact [Support](/biganimal/release/overview/support). Connect your cloud account with your Azure subscription. From c176b84d75e94e233dd47106b6fb3227e01ca296 Mon Sep 17 00:00:00 2001 From: moiznalwalla <90263457+moiznalwalla@users.noreply.github.com> Date: Thu, 7 Jul 2022 15:49:27 +0530 Subject: [PATCH 5/5] Fixed links --- .../release/getting_started/02_azure_market_setup.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx index c9dca1eef61..41c54da108a 100644 --- a/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx +++ b/product_docs/docs/biganimal/release/getting_started/02_azure_market_setup.mdx @@ -49,8 +49,8 @@ Connect your cloud account with your Azure subscription. You are now able to: -- [log in to BigAnimal](log-in) -- [invite new users] +- [Log in to BigAnimal](#log-in) +- [Invite new users](#invite-users) - [Set up your cloud service provider](02_connecting_to_your_cloud/01_connecting_your_own_cloud) ### Log in