swcc/terraform-makefile repository overview

⁠Makefile for Terraform users

This repository provides a Makefile to give you a simple interface for Terraform⁠.

⁠Why?

• Simplify your CLI terraform runs
• Don't Repeat Yourself while typing terraform commands
• Easier adoption for people that are not used to Terraform
• Document common usage
• Unique entrypoint script for credentials management (only for AWS, Azure, DigitalOcean, Google, Hetzner and Scaleway for now)
  • either passing ENV variables. E.g. <PROVIDER>_<ENV>_SECRET will be mapped to DIGITALOCEAN_TOKEN if provider=do is provided as variable
  • either using pass⁠ as local secret manager. E.g. password terraform/<provider>/<env>/secret will be mapped to DIGITALOCEAN_TOKEN if provider=do is provided as variable
  • either using vault⁠ as distributed secret manager (Only for AWS credentials for now). E.g. by using VAULT_ADDR and either VAULT_ROLE_ID + VAULT_SECRET_ID or directly a VAULT_TOKEN your credentials will automatically be fetched into your vault.

⁠Installation

⁠Package install

(for now packages are only published in Github releases⁠)

wget https://github.com/paulRbr/terraform-makefile/releases/download/<version>/tf-make_<version>_amd64.deb
dpkg -i tf-make_<version>.deb

⁠Manual install

Simply download the Makefile and the terraform.sh files in safe place.

mkdir -p /opt/terraform
cd /opt/terraform
wget -N https://raw.githubusercontent.com/paulRbr/terraform-makefile/master/{Makefile,terraform.sh}

Then you will need to add the tf-make binary (it's a simple bash script) in your $PATH. WARNING: you'll need to change the Makefile path in the tf-make file.

⁠Convention

This makefile assumes your terraform configuration files are stored in a specific directory structure:

I.e. providers/<provider>/<env>/*.tf

E.g. example for all supported providers:

providers/
├── aws
│   ├── prod
│   │   └── config.tf
│   └── test
│       └── config.tf
├── do
│   └── prod
│       └── config.tf
├── google
│   ├── prod
│   │   └── config.tf
│   └── test
│       └── config.tf
├── hetzner,scaleway
│   └── test
│       └── config.tf
├── hetzner
│   └── prod
│       └── config.tf
└── scaleway
    └── prod
        └── config.tf

Note: the provider name can be a combination of multiple providers when you are in a multi-cloud environment. E.g. providers/hetzner,scaleway/prod/config.tf.

⁠Commands

List of commands made available

> make
Terraform-makefile v0.14.7

console                        Console infra resources
destroy                        Destroy resources
dry-run                        Dry run resources changes
fmt                            Rewrites config to canonical format
import                         Import infra resources
install                        Install terraform and dependencies
lint                           Lint the HCL code
raw                            Raw command sent to terraform
refresh                        Refresh infra resources
run                            Execute resources changes
show                           List infra resources
state                          Inspect or change the remote state of your resources
taint                          Taint infra resources
validate                       Basic syntax check
workspace                      Workspace infra resources

⁠Variables

Details of the variables that can be passed to commands: