Preparing your AWS account
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.) 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?
- Is there a sufficient limit on the number of vCPUs and Network Load Balancers (NLBs) left in your region?
EDB provides a shell script, called biganimal-csp-preflight, which checks whether requirements and resource limits are met in your AWS account based on the clusters you plan to deploy.
Open the AWS Cloud Shell in your browser.
From the AWS Cloud Shell, run the following command:
The required arguments are:
Argument Description <account-id> AWS account ID of your BigAnimal deployment. <region> AWS region where your clusters are being deployed. See Supported regions for a list of possible regions.
Possible options are:
Displays the command help.
AWS 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 R5, R5B, or R6I series for large data sets. Choose from the compute-optimized C5 or C6I series for compute-bound applications. Choose from the general purpose M5 or M6I series if you don't require memory or compute optimization.
DEPRECATED - Enables high availability for the cluster. See [Supported cluster types(../../overview/02_high_availability) for more information.
Defines the Cluster architecture and can be
eha. See Supported cluster types for more information.
Type of network endpoint for the BigAnimal cluster, either
private. See Cluster networking architecture for more information.
Specifies region activation if no clusters currently exist in the region.
Checks if the user and subscription are correctly configured.
The behavior of the script defaults to
--onboardif you provide no other options.
For example, if you want to deploy a cluster in an AWS account having an ID of
1234-5678-9012, with an instance type of
r5.24xlarge, in the
us-east-1region, in a
publicendpoint, and with no existing cluster deployed, run the following command:
The script displays the following output:
Whether your AWS account restricts vCPUs, elastic IP addresses, VPCs, or NLBs in your region (and availability zone, if HA is enabled). Open an AWS support request to remove restrictions for the resources with
NotAvailabledisplayed in the
Suggestioncolumn. See Request quota increase. For default service quota limits in AWS, see AWS service information
Open an AWS support request to remove restrictions for the resources with
NotAvailable displayed in the
Suggestion column. See Request quota increase. For default service quota limits in AWS, see AWS service information.