Terraform boilerplate

Boilerplate repo for terraform projects.

Features:

• CircleCi configuration

Tools to configure:

• Configure CircleCi at https://circleci.com
• Install terraform-docs locally. You can manually run it by:

terraform-docs md . > README.md

• Configure pre-commit hook. Before every commit the hook will properly format your tf files and also regenerate README.md using terraform-docs.

brew install pre-commit
pre-commit install # In project folder

Best practices

• Use kebab-case to separate words. Do not use PascalCase, camelCase, snake_case or any other casing approach.
• Use the global_tags map variable to specify tags that you want to apply to all provisioned resources. App, Instance, and Stage tags will be automatically included so do not pass them in.
• Do not request ACCOUNT_NUMBER to user through variables. Such data can be fetched by data sources. If you need to use ACCOUNT_NUMBER you can use the local variable that comes predefined in locals.tf file. You can use it like ${local.account_id}.
• When naming resources use the handy local variable name_prefix that comes predefined in locals.tf. Such variable results in app_name-app_instance-app_stage. You can use it like ${local.name_prefix}-vpc and it will create a resource like the following: wordpress-customer_x-prod-vpc.