Skip to content

Commit

Permalink
Merge pull request #5350 from EnterpriseDB/docs/biganimal/cs-docs-int…
Browse files Browse the repository at this point in the history
…egration

Integrate CS and Sales articles into technical documentation
  • Loading branch information
nidhibhammar authored Jun 21, 2024
2 parents f335d0a + d028dfb commit d9c45e7
Show file tree
Hide file tree
Showing 12 changed files with 138 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Before connecting your cloud, make sure that you're assigned the following AWS m

- arn:aws:iam::aws:policy/ServiceQuotasFullAccess

!!! note
BigAnimal is deployed in a VPC within your Cloud Service Provider (CSP). To make changes or modify your BigAnimal clusters, use the BigAnimal Portal, the API, or CLI to manage and execute the activity. You can also open a support case if you need help. Making changes in the resources within those dedicated VPCs can impact EDB’s ability to deliver service.


## Connecting your cloud

!!! tip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ navTitle: Azure
!!! note
The BigAnimal CLI commands used for connecting your cloud to BigAnimal register an application with Azure AD and create a service principal to delegate identity and access management functions to Azure Active Directory (AD). For more information, see for [Azure EDB cloud utilities](https://github.com/EnterpriseDB/cloud-utilities/tree/main/azure) in GitHub.

!!! note
BigAnimal is deployed in a dedicated VNET within your Cloud Service Provider (CSP). To make changes or modify your BigAnimal clusters, use the BigAnimal Portal, the API, or CLI to manage and execute the activity. You can also open a support case if you need help. Making changes to the resources within those dedicated VPCs can impact EDB’s ability to deliver service.


## Prerequisites
Before connecting to your cloud, make sure that you're assigned either the Global Administrator role or the Privileged Role Administrator role in Azure AD and that you have the Owner role for your BigAnimal Azure subscription.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Connecting your Google Cloud
navTitle: Google Cloud
---

!!! note
BigAnimal is deployed in a VPC within your Cloud Service Provider (CSP). To make changes or modify your BigAnimal clusters, use the BigAnimal Portal, the API, or CLI to manage and execute the activity. You can also open a support case if you need help. Making changes in the resources within those dedicated VPCs can impact EDB’s ability to deliver service.


## Prerequisites

Ensure you have at least the following combined roles:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,9 @@ The following options aren't available when creating your cluster:

3. To optionally make updates to your database configuration parameters, select **Next: DB Configuration**.

!!! note
Make changes to database or server parameters after cluster creation is complete. *Note that changing some parameters requires a restart*

## DB Configuration tab

In the **Parameters** section, you can update the value of the database configuration parameters as needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Getting started"
indexCards: simple
navigation:
- overview
- 00_free_trial
- identity_provider
- 02_azure_market_setup
Expand Down
93 changes: 93 additions & 0 deletions product_docs/docs/biganimal/release/getting_started/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: "Getting started overview"
navTitle: "Overview"
description: A high level description of the tasks needed to get started with BigAnimal
---

BigAnimal provides two options for setting up and accessing a cloud account for your new database:

- [Using BigAnimal's cloud account](#getting-started-using-a-biganimal-cloud-account)

- [Using your own cloud account with BigAnimal](#getting-started-using-your-own-cloud-account)

## Getting started using a BigAnimal cloud account

Use the following high-level steps to set up a BigAnimal account and begin using your new database.

1. Create an EDB account. For more information see [Create an EDB account](../free_trial/detail/create_an_account/). After setting up the account, you can access the BigAnimal portal, with all of its features and capabilities.

1. Create a cluster. When prompted for **Where to deploy**, select **BigAnimal**. See [Creating a cluster](../creating_a_cluster/).

1. Use your cluster. See [Using your cluster](../using_cluster/)

## Getting started using your own cloud account

Use the following high-level steps to connect BigAnimal to your own cloud account and begin using your new database.

1. Ensure you have the correct access permissions for your cloud account.

- Azure—Global Administrator or Privileged Role Administrator and you must be a Subscription Owner

- AWS—IAMFullAccess policy and ServiceQuotasFullAccess policy

- Google Cloud—roles/owner or at least the following combined roles:

- roles/iam.serviceAccountCreator

- roles/iam.serviceAccountKeyAdmin

- roles/iam.roleAdmin

- roles/resourcemanager.projectIamAdmin

- roles/compute.viewer

1. Create an EDB account. See [Create an EDB account](../free_trial/detail/create_an_account/).

1. Go to [https://portal.biganimal.com](https://portal.biganimal.com).

1. Select **EDB Account**.

1. Under the login boxes, select **Create EDB account**.

1. Complete the required information on the next page.
After providing the account request information, you will receive an email from EDB. Finish your account activation by clicking the activation link in the email. The activation link expires in 72 hours.

1. When prompted, create a password for your new EDB account.


1. Set up your own identity provider. For more information see [Setting up your identity provider](identity_provider/).

1. Set up a CLI. See [Using the BigAnimal CLI](../reference/cli/).
Although we recommend using a CLI, it is not essential.

1. Prepare your cloud to work with BigAnimal. You must do this every time you create a new cluster. The required steps vary by cloud provider:

- [Preparing your Azure account](preparing_cloud_account/01_preparing_azure/).

- [Preparing your AWS account](preparing_cloud_account/02_preparing_aws/).

- [Preparing your Google Cloud account](preparing_cloud_account/preparing_gcp/).

1. Connect to your cloud. See [Connecting to your cloud](02_connecting_to_your_cloud/).

1. Activate and manage regions. See [Managing regions](activating_regions/).

1. Create a cluster. When prompted for **Where to deploy**, select **Your Cloud Account**. See [Creating a cluster](../creating_a_cluster/).

1. Use your cluster. See [Using your cluster](../using_cluster/).

1. Optionally, set up private networking to allow you to connect to your cluster from other applications. Depending on your cloud service provider, see one of the following:

- [Connecting from Azure](../using_cluster/02_connecting_your_cluster/01_connecting_from_azure/)

- [Connecting from AWS](../using_cluster/02_connecting_your_cluster/02_connecting_from_aws/)

- [Connecting from Google Cloud](../using_cluster/02_connecting_your_cluster/connecting_from_gcp/)

1. Provide access to other users. See [Managing user access](../administering_cluster/01_portal_access/).





Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ BigAnimal requires you to check the readiness of your Azure subscription before

- 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 there a sufficient limit on the number of vCPU or public IP addresses in your region?
- Is there a sufficient limit on the number of vCPU or public IP addresses in your region?

## Prerequisites
When preparing your Azure account, make sure that you're assigned either the Global Administrator role or the Privileged Role Administrator role in Azure AD and that you have the Owner role for your BigAnimal Azure subscription.

!!! Note
Before proceeding, see [Understanding requirements in Azure](01_understanding_qotas_in_azure) for details on planning for your clusters' requirements and resource limits in Azure.
Before proceeding, see [Understanding requirements in Azure](01_understanding_qotas_in_azure) for details on planning for your clusters' requirements and resource limits in Azure.

## Check for readiness

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@
title: "Preparing your AWS account"
---


## Prerequisites

Before preparing your cloud account, make sure that you're 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

BigAnimal requires you to check the readiness of your AWS account before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/planning/deployment_options).) The checks that you perform ensure that your AWS account is prepared to meet your clusters' requirements and resource limits, such as:

- Is the AWS CLI configured to access your AWS account?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,7 @@
title: Preparing your Google Cloud account
---

BigAnimal requires you to check the readiness of your Google Cloud (GCP) account before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](/biganimal/release/planning/deployment_options).) The checks that you perform ensure that your Google Cloud account is prepared to meet your clusters' requirements and resource limits.

!!! Note
Before proceeding, see [Understanding requirements in Google Cloud](understanding_quotas_in_gcp) for details on planning for your clusters' requirements and resource limits in Google Cloud.


## Required roles
## Prerequisites

Ensure you have at least the following combined roles:
- roles/iam.serviceAccountCreator
Expand All @@ -20,6 +14,8 @@ Ensure you have at least the following combined roles:
Alternatively, you can have an equivalent single role, such as:
- roles/owner

BigAnimal requires you to check the readiness of your Google Cloud (GCP) account before you deploy your clusters. (You don't need to perform this check if you're using BigAnimal's cloud account as your [deployment option](../planning/deployment_options). The checks that you perform ensure that your Google Cloud account is prepared to meet your clusters' requirements and resource limits.

## Required APIs and services

Ensure the following Google Cloud APIs are enabled:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Additional EDB tools"
---

Based on your subscription, you may be entitled to a subset of EDB tools that you can access via the EDB Repository. For instructions on using the EDB Repository, see [EDB Repository Access](https://info.enterprisedb.com/rs/069-ALB-339/images/Repository%20Access%2004-09-2019.pdf).
1 change: 1 addition & 0 deletions product_docs/docs/biganimal/release/overview/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ navigation:
- 04_responsibility_model
- 05_database_version_policy
- updates
- additional_tools
- support
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,14 @@ See [Managing your Support cases](01_case_management) for more information.
| Severity 1 | The cloud service is down, or there's an error with critical impact on your production environment. Covers urgent problems including database service outage, data loss, and cluster provisioning failure. |
| Severity 2 | There's a cloud service error or an issue significantly impacting your production environment. The system is functioning but in a severely reduced capacity. Covers problems including database service interruption and backup failures. |
| Severity 3 | There's an error or issue that doesn't have a significant impact on your production environment. Covers problems including API issues, monitoring metrics, and logging issues. |
| Severity 4 | General questions, inquiries, or nontechnical requests. |
| Severity 4 | General questions, inquiries, or nontechnical requests.

## Best practices

- Have at least two account owners assigned to your BigAnimal and cloud service provider accounts.

- Add [email protected] to your email allowed list to avoid missing emails from the BigAnimal support team.

## For more information
- [BigAnimal Terms](https://www.enterprisedb.com/biganimal-terms)
- [Service Level Agreement (SLA) - BigAnimal](https://www.enterprisedb.com/service-level-agreement-sla-biganimal)
Expand Down

1 comment on commit d9c45e7

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.