Terraform
Last updated
Was this helpful?
Last updated
Was this helpful?
This page documents the requirements and steps required to install in AWS using Earthly's Terraform module.
Before you begin to provision your BYOC configuration, ensure that you meet the for installation within AWS.
There are also a few additional requirements you will need to make sure you meet:
Terraform is installed, and on your $PATH
.
An AWS account or role that can create all the resources specified in the module.
You have permission to list Terraform outputs.
You can find our module in the . If you're curious about what we're provisioning, you can look at our .
Place the following code into a file named byoc.tf
, in an empty directory:
Open your terminal, and navigate to the directory with byoc.tf
in it. Run terraform init && terraform apply
, and inspect the resources it wants to create. If they appear ok, type yes
to create them.
After Terraform finishes running, you can link this freshly provisioned infrastructure to an Earthly cloud by running:
Assuming the installation reports the status as Green
, you should be good to go!
The installation command is run in the same directory as the module containing your BYOC block.
The automatic_installation
output is exported. The name of the output is the value used for the --name
parameter.
We recommend that the name of the output matches the name in the cloud_name
of the module, to ensure that naming is consistent between AWS, your tooling, and Earthly.
cloud_name
The name to use to identify the cloud installation. Used by Earthly during automatic installation, and to mark related resources in AWS.
subnet
The subnet Earthly will deploy satellites into.
ssh_public_key
(Optional) The SSH key to include in provisioned satellites. If left unspecified, a new key is generated, and the private key is available as an output.
installation_name
The name to use to identify the cloud installation. Used by Earthly during automatic installation, and to mark related resources in AWS.
security_group_id
The ID of the security group for new satellites.
ssh_key_name
The name of the SSH key in AWS that is included in new satellites.
ssh_private_key
(Sensitive) The private key, if ssh_public_key
is unspecified.
instance_profile_arn
The ARN of the instance profile satellite instances will use for logging.
compute_role_arn
The ARN of the role Earthly will assume to orchestrate satellites on your behalf.
automatic_installation
All items needed to perform an automatic installation, bundled into one output.
You can use the module as explained in . However, if you would like to also enable automatic installation, some additional conditions apply: