Terratag is a CLI tool that enables users of Terraform to automatically create and maintain tags across their entire set of AWS, Azure, and GCP resources
Terratag is brought to you with ❤️ by Let your team manage their own environment in AWS, Azure and Google.
Governed by your policies and with complete visibility and cost management.
Terratag is a CLI tool allowing for tags or labels to be applied across an entire set of OpenTofu/Terraform files. Terratag will apply tags or labels to any AWS, GCP and Azure resources.
Maintaining tags across your application is hard, especially when done manually. Terratag enables you to easily add tags to your existing IaC and benefit from some cross-resource tag applications you wish you had thought of when you had just started writing your OpenTofu/Terraform, saving you tons of time and making future updates easy. Read more on why tagging is important.
Install from homebrew:
brew install env0/terratag/terratag
Or download the latest release binary .
Initialize Opentofu/Terraform modules to get provider schema and pull child modules:
tofu init
terraform init
Run Terratag
terratag -dir=foo/bar -tags={\"environment_id\": \"prod\"}
or
terratag -dir=foo/bar -tags="environment_id=prod,some-tag=value"
|- aws.tf
|- gcp.tf
# aws.tf
provider "aws" {
version = "~> 2.0"
region = "us-east-1"
}
resource "aws_s3_bucket" "b" {
bucket = "my-tf-test-bucket"
acl = "private"
tags {
Name = "My bucket"
}
}
#gcp.tf
resource "google_storage_bucket" "static-site" {
name = "image-store.com"
location = "EU"
force_destroy = true
bucket_policy_only = true
website {
main_page_suffix = "index.html"
not_found_page = "404.html"
}
cors {
origin = ["http://image-store.com"]
method = ["GET", "HEAD", "PUT", "POST", "DELETE"]
response_header = ["*"]
max_age_seconds = 3600
}
labels = {
"foo" = "bar"
}
}
Running terratag -tags={\"env0_environment_id\":\"dev\",\"env0_project_id\":\"clientA\"}
will output:
|- aws.terratag.tf
|- gcp.terratag.tf
|- aws.tf.bak
|- gcp.tf.bak
# aws.terratag.tf
provider "aws" {
version = "~> 2.0"
region = "us-east-1"
}
resource "aws_s3_bucket" "b" {
bucket = "my-tf-test-bucket"
acl = "private"
tags = merge( map("Name", "My bucket" ), local.terratag_added_main)
}
locals {
terratag_added_main = {"env0_environment_id"="dev","env0_project_id"="clientA"}
}
# gcp.terratag.tf
resource "google_storage_bucket" "static-site" {
name = "image-store.com"
location = "EU"
force_destroy = true
bucket_policy_only = true
website {
main_page_suffix = "index.html"
not_found_page = "404.html"
}
cors {
origin = ["http://image-store.com"]
method = ["GET", "HEAD", "PUT", "POST", "DELETE"]
response_header = ["*"]
max_age_seconds = 3600
}
labels = merge( map("foo" , "bar"), local.terratag_added_main)
}
locals {
terratag_added_main = {"env0_environment_id"="dev","env0_project_id"="clientA"}
}
-dir=<path>
- defaults to .
. Sets the opentofu/terraform folder to tag .tf
files in-skipTerratagFiles=false
- Dont skip processing *.terratag.tf
files (when running terratag a second time for the same directory)-rename=false
- Instead of replacing files named <basename>.tf
with <basename>.terratag.tf
, keep the original filename-filter=<regular expression>
- defaults to .*
. Only apply tags to the resource types matched by the regular expression-type=<terraform or terragrunt>
- defaults to terraform
(and opentofu
). If terragrunt
is used, tags the files under .terragrunt-cache
folder. Note: if Terragrunt does not create a .terragrunt-cache
folder, use the default or omit.-verbose
- Turn on verbose logging-default-to-terraform
By default uses OpenTofu (if installed), if set will use Terraform even when Opentofu is installedSetting options via enviroment variables is also supported. CLI flags have a precedence over envrionment variables.
TERRATAG_TAGS
TERRATAG_DIR
TERRATAG_SKIPTERRATAGFILES
TERRATAG_FILTER
TERRATAG_SKIP
TERRATAG_VERBOSE
TERRATAG_RENAME
TERRATAG_TYPE
TERRATAG_DEFAULT_TO_TERRAFORM
Issues and Pull Requests are very welcome!
git clone https://github.com/env0/terratag
cd terratag
go mod tidy
go build ./cmd/terratag
The test cases are located under test/tests
Each test case placed there should have the following directory structure:
my_test
|+ input
... // any depth under /input
|- main.tf // this is where we will run all terraform/terratag commands
|- expected
input
is where you should place the terraform files of your test.
All commands will be executed wherever down the hierarchy where main.tf
is located.
We do that to allow cases where complex nested submodule resolution may take place, and one would like to test how a directory higher up the hierarchy gets resolved.expected
is a directory in which all .terratag.tf
files will be matched with the output directoryEach terraform version has it's own config file containing the list of test suites to run.
The config file is under test/fixtures/terraform_xx/config.yaml
where xx
is the terraform version.
Each test will run:
terraform init
terratag
terraform validate
And finally, will compare the results in out
with the expected
directory
Tests can only run on a specific Terraform version -
go test -run TestTerraformXX
We use tfenv to switch between versions. The exact versions used in the CI tests can be found under test/tfenvconf
.
git tag v0.1.32 && git push origin --tags
.github/workflows/release.yml