Preparing your Google Cloud account
Prerequisites
Ensure you have at least the following combined roles:
- roles/iam.serviceAccountCreator
- roles/iam.serviceAccountKeyAdmin
- roles/iam.roleAdmin
- roles/resourcemanager.projectIamAdmin
- roles/compute.viewer
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. 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:
- autoscaling.googleapis.com
- cloudapis.googleapis.com
- cloudresourcemanager.googleapis.com
- compute.googleapis.com
- container.googleapis.com
- iam.googleapis.com
- iamcredentials.googleapis.com
- run.googleapis.com
- secretmanager.googleapis.com
- storage.googleapis.com
- vpcaccess.googleapis.com
Check Google Cloud resource limits for running BigAnimal
EDB provides a shell script, called biganimal-csp-preflight, which checks whether requirements and resource limits are met in your Google Cloud account based on the clusters you plan to deploy.
Open Google Cloud Shell in your browser.
From Google Cloud Shell, run the following command:
The required arguments are:
Argument Description <project-id> Google Cloud project ID of your BigAnimal deployment. <region> Google Cloud region where your clusters are being deployed. See Supported regions for a list of possible regions. Possible options are:
Options Description -h
or--help
Displays the command help. -i
or--instance-type
Google Cloud instance type for the BigAnimal cluster. The help command provides a list of possible VM instance types. Choose the instance type that best suits your application and workload. Choose an instance type in the memory optimized M1, M2, or M3 series for large data sets. Choose from the compute-optimized C2 series for compute-bound applications. Choose from the general purpose E2, N2, and N2D series if you don't require memory or compute optimization. -x
or--cluster-architecture
Defines the Cluster architecture and can be single
,ha
, oreha
. See Supported cluster types for more information.-e
or--networking
Type of network endpoint for the BigAnimal cluster, either public
orprivate
. See Cluster networking architecture for more information.-r
or--activate-region
Specifies region activation if no clusters currently exist in the region. --onboard
Checks if the user and subscription are correctly configured. The behavior of the script defaults to
--onboard
if you provide no other options.For example, if you want to deploy a cluster in a Google Cloud account having an ID of
1234-5678-9012
, with an instance type ofn2-standard-8
, in theus-east1
region, with apublic
endpoint, and with no existing cluster deployed, run the following command:
The script displays the following output:
Configure your Google Cloud account
If any APIs are listed as not enabled, see Enabling and Disabling Services in the Google Cloud documentation to enable the required APIs.
If you need to increase your quotas, see Request a higher quota limit.