Skip to content

Latest commit

 

History

History

terragrunt

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
multiple
multiple
 
 
single
single
 
 
README.md
README.md
 
 

README.md

TerraGrunt Examples

Some simple educational terragrunt work for people to use. Examples will be added as I get around to them.

Terragrunt is a tool for managing many different types of configurations which share common definitions and variables. You can reuse definitions using crude inheritance and then customise variables using a hierarchy of directories. It is similar in concept to kustomize in kubectl.

For more information, refer to the references below.

Dependencies

To run these samples, you will need...

  • Access to an Azure environment able to run Terraform (admin access)
  • Installed Terragrunt and Terraform

How to Install

Install Terragrunt using appropriate instructions for your OS Getting started

Running the samples

To run the simple sample(s), do the following...

cd samples/Azure/terragrunt/single
(cd dev/k8s && terragrunt plan && terragrunt destroy -auto-approve && terragrunt apply -auto-approve && terragrunt destroy -auto-approve)
(cd prod/k8s && terragrunt plan && terragrunt destroy -auto-approve && terragrunt apply -auto-approve && terragrunt destroy -auto-approve)

You can delete all the resources using terragrunt destroy -auto-approve

The sample works by customising the name of the resources created to reflect the environment being used - either dev or prod.

To run the more complex sample(s), do the following...

cd samples/Azure/terragrunt/multiple
(cd dev && terragrunt run-all plan)
(cd dev && echo y | terragrunt run-all apply)
(cd dev && echo y | terragrunt run-all destroy)
(az group delete -n dev_rg_001 -y ; az group delete -n dev_rg_002 -y)
(cd prod && terragrunt run-all plan)
(cd prod && echo y | terragrunt run-all apply)
(cd prod && echo y | terragrunt run-all destroy)
(az group delete -n prod_rg_001 -y ; az group delete -n prod_rg_002 -y)

If the destroy does not work - as it seems to be a little bit flakey - then do the following...

(az group delete -n dev_rg_001 -y ; az group delete -n dev_rg_002 -y)
(az group delete -n prod_rg_001 -y ; az group delete -n prod_rg_002 -y)

The sample works by customising the name of the resources created to reflect the environment being used - either dev or prod. It also deploys multiple modules.

Notes

  • Terragrunt is a solution looking for a problem to solve. It is supposed to be aimed at keeping your code DRY, but you end up copying lots of config files around instead, so review your use-cases before using it as there might be better approaches
  • Terragrunt does cause some perfectly good Terraform modules to fail for some odd reasons
  • Terragrunt run-all does not work very well

References