generator-tf-infra is an opinionated generator for Terraform infrastructure projects. Currently only supports the AWS Provider.
Largely informed by Terraform: Up & Running but with an emphasis on infrastructure being defined once-only with only variables differing across environments.
Also prioritises executing operations from a single common entry point to aid inclusion in CI/CD pipelines and includes supporting tooling, as required.
- Install latest Node LTS.
npm install -g yonpm install -g generator-tf-infra
$ yo tf-infra
$ yo tf-infra --help
NOTE: This template will generate files in the current directory, so be sure to always run it against the correct directory.
The tasks plan, apply and destroy are defined in the generated Makefile.
export AWS_PROFILE=dev_profile
ENV=dev make apply
Where dev is one of the environment names supplied when running the generator and dev_profile is a named profile in the user's .aws/credentials file.
In this case the infrastructure defined by the project is applied using the variables defined in
environments/dev/variables.tfvars
Optionally, you can install pre-commit hooks to validate terraform files, enforce consistent formatting and create module documentation.
Install the pre-commit package and the required dependencies
On MacOSX:
$ brew install pre-commit gawk terraform-docs tflint tfsec coreutils checkov
Run generator-tf-infra with the --precommit option.
$ yo tf-infra --precommit
See README.md in the generated project for further details.
Optionally, you can generate sample tests to accompany the sample module. These are built on the terratest library and prove the correctness of the sample module in isolation of other infrastructure elements.
Tests heavily informed by (https://terratest.gruntwork.io/docs/getting-started/quick-start/#example-2-terraform-and-aws)
To use Terratest, you need to install:
Go (requires version >=1.13)
Run generator-tf-infra with the --tests option (this can be combined with the --precommit option).
$ yo tf-infra --tests
Note: this option does nothing if you opt not to generate the sample module.