Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meteorops/terragrunt-gcp-projects
A Terragrunt boilerplate to minimize regrets on GCP
https://github.com/meteorops/terragrunt-gcp-projects
google-cloud terraform terragrunt
Last synced: about 21 hours ago
JSON representation
A Terragrunt boilerplate to minimize regrets on GCP
- Host: GitHub
- URL: https://github.com/meteorops/terragrunt-gcp-projects
- Owner: MeteorOps
- License: mit
- Created: 2021-07-26T07:24:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T11:51:03.000Z (9 months ago)
- Last Synced: 2024-04-29T12:56:13.813Z (9 months ago)
- Topics: google-cloud, terraform, terragrunt
- Language: HCL
- Homepage: https://www.meteorops.com/blog/terraform-starter-boilerplate-for-gcp-using-terragrunt
- Size: 12.7 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Example GCP projects infrastructure for Terragrunt
[](https://meteorops.com)
[](./LICENSE)
This repo, along with the [terraform-gcp-modules](https://github.com/meteorops/terraform-gcp-modules), show an example file/folder structure
you can use with [Terragrunt](https://github.com/gruntwork-io/terragrunt) to keep your
[Terraform](https://www.terraform.io) code DRY. For background information, check out the [Keep your Terraform code
DRY](https://github.com/gruntwork-io/terragrunt#keep-your-terraform-code-dry) section of the Terragrunt documentation.
## How do you deploy the infrastructure in this repo?
### Pre-requisites
1. Install [Terraform](https://www.terraform.io/) version `0.13.0` or newer and
[Terragrunt](https://github.com/gruntwork-io/terragrunt) version `v0.25.1` or newer.
1. Fill in your GCP Project ID in `my-project/project.hcl`.
1. Make sure gcloud CLI is installed and you are authenticated,otherwise run `gcloud auth login`.
### Deploying a single module
1. `cd` into the module's folder (e.g. `cd my-project/us-central1/rnd-1/vpc`).
1. Run `terragrunt plan` to see the changes you're about to apply.
1. If the plan looks good, run `terragrunt apply`.
### Deploying all modules in an environment
1. `cd` into the environment folder (e.g. `cd my-project/us-central1/rnd-1`).
1. Run `terragrunt run-all plan` to see all the changes you're about to apply.
1. If the plan looks good, run `terragrunt run-all apply`.
### Testing the infrastructure after it's deployed
After each module is finished deploying, it will write a bunch of outputs to the screen. For example, the my-app will
output something like the following:
```
Outputs:
ip = "35.240.219.84"
```
A minute or two after the deployment finishes, you should
be able to test the `ip` output in your browser or with `curl`:
```
curl 35.240.219.84
Contact MeteorOps for DevOps & Cloud Consulting!
```
### Destroying all modules in an environment
1. `cd` into the environment folder (e.g. `cd my-project/us-central1/rnd-1`).
1. Run `terragrunt run-all plan -destroy` to see all the destroy changes you're about to apply.
1. If the plan looks good, run `terragrunt run-all destroy`.
## How is the code in this repo organized?
The code in this repo uses the following folder hierarchy:
```
project
└ _global
└ region
└ _global
└ environment
└ resource
```
## Creating and using root (project) level variables
In the situation where you have multiple GCP projects or regions, you often have to pass common variables down to each
of your modules. Rather than copy/pasting the same variables into each `terragrunt.hcl` file, in every region, and in
every environment, you can inherit them from the `inputs` defined in the root `terragrunt.hcl` file.