tfgen - Terraform boilerplate generator

Terragrunt alternative to keep your Terraform code consistent and DRY

Overview

What is tfgen

tfgen is useful for maintaining and scaling a Terraform Monorepo, in which you provision resources in a multi environment/account setup. It is designed to create consistent Terraform definitions, like backend (with dynamic key), provider, and variables for each environment/account, as defined in a set of yaml configuration files.

Why tfgen

Terragrunt - a thin wrapper for Terraform that provides extra tools for working with multiple Terraform modules - is a great tool and inspired me a lot to create tfgen, but instead of being a wrapper for the Terraform binary, tfgen just creates Terraform files from templates and doesn't interact with Terraform at all. Terraform will be used independently on your local environment or in your CI system to deploy the resources.

• This is not just a tool, it's a way of doing things
• Keep your Terraform configuration consistent across the environments
• Reduce the risk of making mistakes while copying+pasting your backend, provider and other common Terraform definitions
• Increase your productivity
• Scale your monorepo following the same pattern across the modules

Features

• Builtin functionallity to provide the remote state key dynamically
• YAML file configuration
• Templates are parsed using Go templates

Getting Started

Prereqs

• Docker or Go

Installation

git clone --depth 1 [email protected]:refl3ction/tfgen.git
cd tfgen

# Using Docker
docker run --rm -v $PWD:/src -w /src -e GOOS=darwin -e GOARCH=amd64 golang:alpine go build

# Using Go
go build

mv tfgen /usr/local/bin

Note: when building using Docker, change GOOS=darwin to GOOS=linux or GOOS=windows based on your system

Usage

Basic Usage

# executing the templates
$ tfgen exec <target dir>

$ tfgen help
tfgen is a devtool to keep your Terraform code consistent and DRY

Usage:
  tfgen [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  exec        Execute the templates in the given target directory.
  help        Help about any command

Flags:
  -h, --help   help for tfgen

Use "tfgen [command] --help" for more information about a command.

Quick Tutorial

Before we start, let's clone our terraform-monorepo-example repository. All the examples bellow are based on the structure of this repo:

.
├── infra-live
│   ├── dev
│   │   ├── networking
│   │   ├── s3
│   │   ├── security
│   │   ├── stacks
│   │   └── .tfgen.yaml     # Environment specific config
│   ├── prod
│   │   ├── networking
│   │   ├── s3
│   │   ├── security
│   │   ├── stacks
│   │   └── .tfgen.yaml     # Environment specific config
│   └── .tfgen.yaml         # Root config file
└── modules
    └── my-custom-module

Inside our infra-live folder, we have two environments, dev and prod. They are deployed in different aws accounts, and each one have a different role that needs to be assumed in the provider configuration. Instead of copying the files back and forth every time we need to create a new module, we'll let tfgen create it for us based on our .tfgen.yaml config files.

Configuration files

How config files are parsed

tfgen will recursively look for all .tfgen.yaml files from the working directory up to the parent directories until it finds the root config file, if it doesn't find the file it will exit with an error. All the other files found on the way up are merged into the root config file, and the inner configuration have precedence over the outer.

We have two types of configuration files:

1. Root config
2. Environment specific config

Root config

In the root config file, you can set variables and templates that can be reused across all environments. You need at least 1 root config file.

# infra-live/.tfgen.yaml
---
root_file: true
vars:
  company: acme
template_files:
  _backend.tf: |
    terraform {
      backend "s3" {
        bucket         = "my-state-bucket"
        dynamodb_table = "my-lock-table"
        encrypt        = true
        key            = "{{ .tfgen_working_dir }}/terraform.tfstate"
        region         = "{{ .aws_region }}"
        role_arn       = "arn:aws:iam::{{ .aws_account_id }}:role/terraformRole"
      }
    }
  _provider.tf: |
    provider "aws" {
      region = "{{ .aws_region }}"
      allowed_account_ids = [
        "{{ .aws_account_id }}"
      ]
    }
  _vars.tf: |
    variable "env" {
      type    = string
      default = "{{ .env }}"
    }

Note that aws_region, aws_account and env are variables that you need to provide in the environment specific config. tfgen_working_dir is provided by the tfgen, it will be explained below.

Environment specific config

In the environment specific config file (non root), you can pass additional configuration, or override configuration from the root config file. You can have multiple specific config files, all of them will be merged into the root one.

# infra-live/dev/.tfgen.yaml
---
root_file: false
vars:
  aws_account_id: 111111111111
  aws_region: us-east-1
  env: dev

# infra-live/prod/.tfgen.yaml
---
root_file: false
vars:
  aws_account_id: 222222222222
  aws_region: us-east-2
  env: prod
template_files:
  additional.tf: |
    # I'll just be created on modules inside the prod folder

Internal variables

These variables are automatically injected into the templates:

• tfgen_working_dir: The path from the root config file to the working directory

Running

Let's create the common files to start writing our Terraform module

# If you didn't clone the example repo yet
git clone [email protected]:refl3ction/terraform-monorepo-example.git
cd terraform-monorepo-example

# Create a folder for our new module
mkdir -p infra-live/dev/s3/dev-tfgen-bucket
cd infra-live/dev/s3/dev-tfgen-bucket

# Generate the files
tfgen exec .

# Checking the result (See Output section)
cat _backend.tf _provider.tf _vars.tf

This execution will create all the files inside the working directory, executing the templates and passing in all the variables declared in the config files.

Output

This will be the content of the files created by tfgen:

_backend.tf

terraform {
  backend "s3" {
    bucket         = "my-state-bucket"
    dynamodb_table = "my-lock-table"
    encrypt        = true
    key            = "dev/s3/dev-tfgen-bucket/terraform.tfstate"
    region         = "us-east-1"
    role_arn       = "arn:aws:iam::111111111111:role/terraformRole"
  }
}

_provider.tf

provider "aws" {
  region = "us-east-1"
  allowed_account_ids = [
    "111111111111"
  ]
}

_vars.tf

variable "env" {
  type    = string
  default = "dev"
}

Next steps

After creating the common Terraform files, probably you'll start writing your main.tf file. So at this point, you already know what to do.

terraform init

terraform plan -out tf.out

terraform apply tf.out

Related

• terraform-monorepo-example - Example repo used in the tutorial
• Terragrunt - Tool that inspired me to create tfgen

Have fun!