940110b2de
This changeset improves the ergonomics of running the Nomad e2e test provisioning process by defaulting to a blank `nomad_sha` in the Terraform configuration. By default, a user will now need to pass in one of the Nomad version flags. But they won't have to manually edit the `provisioning.json` file for the common case of deploying a released version of Nomad, and won't need to put dummy values for `nomad_sha`. Includes general documentation improvements.
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
# Terraform infrastructure
|
|
|
|
This folder contains terraform resources for provisioning EC2 instances on AWS
|
|
to use as the target of end-to-end tests.
|
|
|
|
Terraform provisions the AWS infrastructure only, whereas the Nomad
|
|
cluster is deployed to that infrastructure by the e2e
|
|
framework. Terraform's output will include a `provisioning` stanza
|
|
that can be written to a JSON file used by the e2e framework's
|
|
provisioning step.
|
|
|
|
You can use Terraform to output the provisioning parameter JSON file the e2e
|
|
framework uses.
|
|
|
|
## Setup
|
|
|
|
You'll need Terraform 0.12+, as well as AWS credentials (`AWS_ACCESS_KEY_ID`
|
|
and `AWS_SECRET_ACCESS_KEY`) to create the Nomad cluster. Use
|
|
[envchain](https://github.com/sorah/envchain) to store your AWS credentials.
|
|
|
|
Optionally, edit the `terraform.tfvars` file to change the number of
|
|
Linux clients or Windows clients.
|
|
|
|
```hcl
|
|
region = "us-east-1"
|
|
instance_type = "t2.medium"
|
|
server_count = "3"
|
|
client_count = "4"
|
|
windows_client_count = "1"
|
|
```
|
|
|
|
Run Terraform apply to deploy the infrastructure:
|
|
|
|
```sh
|
|
cd e2e/terraform/
|
|
envchain nomadaws terraform apply
|
|
```
|
|
|
|
## Outputs
|
|
|
|
After deploying the infrastructure, you can get connection information
|
|
about the cluster:
|
|
|
|
- `$(terraform output environment)` will set your current shell's
|
|
`NOMAD_ADDR` and `CONSUL_HTTP_ADDR` to point to one of the cluster's
|
|
server nodes, and set the `NOMAD_E2E` variable.
|
|
- `terraform output servers` will output the list of server node IPs.
|
|
- `terraform output linux_clients` will output the list of Linux
|
|
client node IPs.
|
|
- `terraform output windows_clients` will output the list of Windows
|
|
client node IPs.
|
|
- `terraform output provisioning | jq .` will output the JSON used by
|
|
the e2e framework for provisioning.
|
|
|
|
## SSH
|
|
|
|
You can use Terraform outputs above to access nodes via ssh:
|
|
|
|
```sh
|
|
ssh -i keys/nomad-e2e-*.pem ubuntu@${EC2_IP_ADDR}
|
|
```
|
|
|
|
The Windows client runs OpenSSH for convenience, but has a different
|
|
user and will drop you into a Powershell shell instead of bash:
|
|
|
|
```sh
|
|
ssh -i keys/nomad-e2e-*.pem Administrator@${EC2_IP_ADDR}
|
|
```
|
|
|
|
## Teardown
|
|
|
|
The terraform state file stores all the info.
|
|
|
|
```sh
|
|
cd e2e/terraform/
|
|
envchain nomadaws terraform destroy
|
|
```
|