terraform_exec

PREFACE

The need for terraform exec has passed. Terraform now supports 'environments', called workspaces.

It also supports remote backends so the s3 sync feature of terraform exec is obsolete.

Intent:

A Terraform wrapper that allows terraform projects to have multiple environments, synced to S3.

For example terraform_exec allows a terraform elasticsearch project to have staging and production environments in multiple aws regions.

Installation:

First you need to install terraform

Next install terraform_exec (golang required and setup)

go get github.com/nadnerb/terraform_exec
go install github.com/nadnerb/terraform_exec
terraform_exec --help

terraform_exec

By default you will run terraform_exec within an existing terraform project. It will sync local state with s3, additionally supporting multiple 'environments'.

terraform_exec wraps normal terraform commands such as plan, apply, refresh, taint and destroy.

e.g terraform_exec plan staging

Configuration

All terraform_exec commands will look in the ./config directory for a staging.tfvars file. At a minimum it will need the following variables to save state to s3:

aws_region="ap-southeast-2"
s3_bucket="a-bucket"
s3_key="an-s3-key"

The default config directory location can be overriden using the --config-location='/tmp/blah/' flag.

Examples

apply

terraform_exec apply dc1

Underlying terraform operation:

terraform plan -var-file ./config/dc1.tfvars -state=./tfstate/dc1/terraform.tfstate -var environment=dc0

taint

terraform_exec taint dc2 aws_launch_configuration.elasticsearch --config-location=/tmp/config/elasticsearch

Underlying terraform operation:

terraform taint -var-file /tmp/config/elasticsearch/dc2.tfvars -state=./tfstate/dc2/terraform.tfstate -var environment=dc2 aws_launch_configuration.elasticsearch

AWS security

Out of the box, terraform_exec will look for AWS credentials set in environment variables. If running on an ec2 box in AWS, retrieving credentials via the machines IAM role are supported:

terraform_exec plan staging --security=aws-internal --security-role=your-iam-role

Use terraform_exec run --help for more details.

S3 sync

If for some reason you need to skip the inital sync with s3, the --no-sync=true flag can be used.

terraform_exec upload

Upload existing environment state to s3

See terraform_exec upload --help for more details

terraform_exec download

Download existing environment state from s3

See terraform_exec download --help for more details

Testing terraform_exec

$ go test ./...

Issues

When testing

cannot find package "github.com/stretchr/testify/assert" in any of: ...

You will need to

$ go get github.com/stretchr/testify/assert

TODO

• improve documentation
• improve cli output
• remove unnessessary s3_Key variable
• see github issues