Skip to content

Commit 5c7148b

Browse files
committed
updated terragrunt.md
1 parent a6ca5cd commit 5c7148b

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

terragrunt.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,21 @@
22

33
https://terragrunt.gruntwork.io/
44

5-
Thin wrapper around [Terraform](terraform.md), uses the same arguments as Terraform and passes them to the `terraform` command.
5+
"Thin wrapper around [Terraform](terraform.md)" but adds lots of sourcing and templating capabilities.
6+
7+
Uses the same arguments as Terraform and passes them to the `terraform` command.
68

79
This was designed to reduce duplication when using Terraform code
810
and support things like variables, expressions, functions and relative roots in `provider` and `backend` blocks.
911

10-
This is mainly applicable where people are deploying modules individually instead of from one larger code base run,
11-
because Terraform is slow
12-
(usually because it has to make lots of calls to cloud APIs to determine what changes need to be made).
12+
Especially useful or running Terraform modules individually to save run time.
13+
14+
In CI/CD pipelines you often only want to deploy the modules which have changed individually instead of the entire
15+
terraform code base, because Terraform is slow (usually because it has to make lots of calls to cloud APIs to determine
16+
what changes need to be made).
1317

14-
In that case each module then needs its own backend configuration which is almost the same apart from key file path and is otherwise all duplication, which Terragrunt can source to deduplicate.
18+
In that case each module then needs its own backend configuration which is almost the same apart from key file path and
19+
is otherwise all duplication, which Terragrunt can source to deduplicate.
1520

1621
Advocates DRY configuration every 10 seconds, which ironically stands for Don't Repeat Yourself.
1722

@@ -21,20 +26,22 @@ Someone needs to create a doc tool to DRY out all the Terragrunt documentation r
2126

2227
[Install doc](https://terragrunt.gruntwork.io/docs/getting-started/install/)
2328

24-
Quickly, if you've got [DevOps-Bash-tools](devops-bash-tools.md), find and install the latest version:
29+
Quicker if you've got [DevOps-Bash-tools](devops-bash-tools.md) - finds and installs the latest version:
2530

2631
```shell
2732
install_terragrunt.sh
2833
```
2934

30-
Install autocomplete:
35+
Install shell autocomplete:
3136

3237
```shell
3338
terragrunt --install-autocomplete
3439
```
3540

3641
## Terragrunt Template
3742

43+
Heavily commented with advanced knowledge.
44+
3845
Edit to suit your needs:
3946

4047
[HariSekhon/Terraform - terragrunt.hcl](https://github.com/HariSekhon/Terraform/blob/master/terragrunt.hcl)
@@ -43,7 +50,7 @@ Then run...
4350

4451
## Plan & Apply
4552

46-
Almost the same commands just swap `terraform` for `terragrunt`:
53+
Almost the same commands, just swap `terraform` for `terragrunt`:
4754

4855
```shell
4956
terragrunt plan

0 commit comments

Comments
 (0)