This is a Cookiecutter template to create a Terraform infrastructure project.
It is important to note that you should not try to git clone this project but use cookiecutter CLI instead as {{cookiecutter.project_slug}} will be rendered based on your input and therefore all variables and files will be rendered properly.
Install cookiecutter command line:
Pip users:
pip install cookiecutter
Homebrew users:
brew install cookiecutter
Windows or Pipenv users:
pipenv install cookiecutter
NOTE: Pipenv is the new and recommended Python packaging tool that works across multiple platforms and makes Windows a first-class citizen.
Generate a new Terraform infrastructure project: cookiecutter gh:flow-lab/terraform-template (or if you want to authenticate with ssh: `cookiecutter git+ssh://[email protected]/flow-lab/terraform-template).
You'll be prompted a few questions to help this cookiecutter template to scaffold this project and after its completed you should see a new folder at your current path with the name of the project you gave as input.
After project has been generated, cd into it and push to github (make sure you have created the repository first):
$ cd <project-name>
$ git init .
$ git remote add origin [email protected]:<github-user>/<project-name>.git
$ git add . && git commit -m 'Initial commit' && git push origin master
To update existing project run cookiecutter gh:flow-lab/terraform-template -f --replay.
NOTE: After you understand how cookiecutter works (cookiecutter.json, mainly), you can fork this repo and apply your own mechanisms to accelerate your development process and this can be followed for any programming language and OS.
| Option | Description |
|---|---|
project_name |
Project name |
project_slug |
Project slug |
project_description |
Short project description |
aws_region |
The aws region for deployment |
terraform_state_s3 |
The terraform state s3 bucket |
terraform_version |
The version of Terraform |
