Yeoman helps you to kickstart new projects, prescribing best practices and tools to help you stay productive

Generator: Terraform Project

Requirements

In order to run this generator, you will need the following:

• an up-to-date installation of Yeoman
• an up-to-date version of this generator

Installation

• install Yeoman
• install this generator

To install Yeoman, run the following command in your console:

npm install -g yo bower grunt-cli

This will make Yeoman (via yo) as well as the base dependencies of Yeoman, namely Bower and Grunt available.

Note that you might require sudo permissions to install the above modules globally.

To install this generator, run the following command in your console:

npm install -g generator-terraform-project

Alternatively, you can install the generator directly from Git HEAD by running the following command:

npm install -g https://bitbucket.org/frostedio/generator-terraform-project/get/HEAD.tar.gz

Usage

In order to run the included generator, open a console (Terminal.app, PuTTY) and change into the directory you want to generate the project in. Then, run the following command:

yo terraform-project

Should the above command fail, verify that Yeoman does indeed see the generator by executing yo and looking for an entry named "Terraform Project".

On an initial run, when you chose to enable support for a site module, you will be asked to provide a Git user, password (or token) and URL. The user and URL will be stored for future use, the password (or token) will not.

After all questions have been answered, Yeoman will generate the scaffolding needed to kickstart a Terraform project.

The layout for a generated project will look like so:

.
├── .editorconfig
├── .gitignore
├── .release.json
├── README.md
└── landscape
    ├── main.tf
    ├── output.tf
    ├── providers.tf
    ├── site.tf
    ├── terraform.tfvars.sample
    └── variables.tf

The .release.json file is optional and will only be created when Release It! support is enabled during the generation.

The files will be placed in a directory containing the name you provided for the project.

Demo

The following animation shows how the generator looks like, in action:

Maintainers

This generator is currently maintained by the individuals listed below.

• Kerim Satirli