Amazon Web Services
AttentionThis page documents an earlier version. Go to the latest (v2.3) version.
- You need to have an IAM user who has
- If you are going to create the stack via AWS Console then make sure the user also has
- Create an SSH key pair that you want to attach to the nodes.
- In the region you want to bring up the stack, make sure you can launch new VPCs.
- Download the template file.
$ wget https://raw.githubusercontent.com/yugabyte/aws-cloudformation/master/yugabyte_cloudformation.yaml
NoteWhen using an instance with local disks (not EBS), the
.yamlfile needs to be changed for YugabyteDB to recognize the local disks. Here is an example using i3 instance types that formats and mounts the nvme ssd automatically for each host and installs YugabyteDB on that mount.
AWS Command Line
Create CloudFormation template:
$ aws cloudformation create-stack \ --stack-name <stack-name> \ --template-body file://yugabyte_cloudformation.yaml \ --parameters ParameterKey=DBVersion,ParameterValue=126.96.36.199 ParameterKey=KeyName,ParameterValue=<ssh-key-name> \ --region <aws-region>
Once resource creation completes, check that stack was created:
$ aws cloudformation describe-stacks \ --stack-name <stack-name> \ --region <aws-region>
From this output, you will be able to get the VPC id and YugabyteDB admin URL.
Because the stack creates a security group that restricts access to the database, you might need to update the security group inbound rules if you have trouble connecting to it. if you have trouble connecting to the DB.
- Navigate to your AWS console and open the CloudFormation dashboard. Click Create Stack.
- Prepare template using the downloaded template
- Specify the template file downloaded in Prerequisites:
- Provide the required parameters. Each of these fields are prefilled with information from the configuration YAML file that was uploaded.
LatestAmiIdrefers to the id of the machine image to use, see more.
- Configure Stack options. For more information about these options, click here.
- Finalize changes before creation
- Check stack output in dashboard