terraform-module-template

Cookiecutter template for a Terraform module.

Usage

Setup

Install the latest Cookiecutter if you haven't installed it yet:

pip install -U cookiecutter

Or, if you are using Mac OS:

brew install cookiecutter

For alternate installations, see cookiecutter installation.

Generate a Terraform module:

cookiecutter [email protected]:ponceps/terraform-module-template

Pushing to Github

Create a new repository on Github and at the module directory:

make setup

Module Conventions

• GitHub: the module must be on GitHub and must be a private repo.
• Named terraform-<PROVIDER>-<NAME>: module repositories must use this three-part name format, where reflects the type of infrastructure the module manages and is the main provider where it creates that infrastructure. The segment can contain additional hyphens. Examples: terraform-google-vault or terraform-aws-ec2-instance.
• x.y.z tags for releases: release tag names must be a semantic version prefixed with a v. For example, v1.0.4.