python-terrafile

Manages external Terraform modules, controlled by a Terrafile.

This is basically a Python version of the tool described at http://bensnape.com/2016/01/14/terraform-design-patterns-the-terrafile/

Additionally, python-terrafile supports modules from the Terraform Registry, as well as modules in local directories identified by a relative path starting with either ./ or ../ or an absolute path starting with /.

Installation

pip install terrafile

Usage

pterrafile [path]

If path is provided, it must be the path to a Terrafile file, or a directory containing one. If not provided, it looks for the file in the current working directory.

pterrafile --terrafile <path>

Same behavour as pterrafile [path]

Examples terrafile usage

# Terraform Registry module
terraform-aws-lambda:
  source: "claranet/lambda/aws"
  version: "0.7.0"

# Git module (HTTPS)
terraform-aws-lambda:
  source: "https://github.com/claranet/terraform-aws-lambda.git"
  version: "v0.7.0"

# Git module (SSH)
terraform-aws-lambda:
  source: "[email protected]:claranet/terraform-aws-lambda.git"
  version: "v0.7.0"

# Local directory module
terraform-aws-lambda:
  source: "../../modules/terraform-aws-lambda"

Opinionated Terrafile

pterrafile --terrafile <path> --optimizedownloads True

if --optimizedownloads is set to True then this indicates the usage of an opinionated Terrafile. The module names are used as the key in the terrafile and pterrafile will auto-detect the module names within your terrafiles and download only the matching names in your Terrafile. This allows you to utilize a single Terrafile at the top level of an environment. This is useful when you want to easily track the versions of all your modules in a single Terrafile and allows you to call out to this central Terrafile from sub folders, and only download the specific modules you require for terraform apply.

Example using opinionated Terrafile

cd dev/apps
pterrafile --terrafile ../Terrafile --optimizedownloads True

├── dev
│   ├── Terrafile
│   ├── apps
│   │   └── main.tf
│   │   └── modules
│   ├── ec2
│   │   └── main.tf
│   │   └── modules
│   ├── security
│   │   └── main.tf
│   │   └── modules
│   │── vpc
│   │   └── main.tf
│   │   └── modules
│

You run the pterrafile command from /dev/apps/ folder and example.git repo would be cloned into current working directory relative path modules/example thus ending up in dev/apps/modules/example

#main.tf located in apps
module "example" {
source = "modules/example/subfolder1"
}

#Terrafile located in DEV
example:
source: "https://github.com/joeblogs/example.git"
version: "master"

Local installation, useful for Testing (python 3)

git clone <pterrafile repo>
cd <pterrafile repo>
make clean; make install; pip install .