Terraform Labels
This terraform module is designed to generate consistent label names and tags for resources. You can use terraform-labels to implement a strict naming convention.
We eat, drink, sleep and most importantly love DevOps. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure.
This module is basically combination of Terraform open source and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.
We have fifty plus terraform modules. A few of them are comepleted and are available for open source usage while a few others are in progress.
Prerequisites
This module has a few dependencies:
- Terraform 0.13
- Go
- github.com/stretchr/testify/assert
- github.com/gruntwork-io/terratest/modules/terraform
Examples
IMPORTANT: Since the master branch used in source varies based on new modifications, we suggest that you use the release versions here.
Simple Example
Here is an example of how you can use this module in your inventory structure:
module "label" {
source = "git::https://github.com/clouddrove/terraform-labels.git?ref=tags/0.15.0"
name = "labels"
environment = "prod"
managedby = "[email protected]"
repository = "https://github.com/clouddrove/terraform-labels"
label_order = ["name","attributes","environment"]
delimiter = "-"
tags = {
"Terraform Version" = "0.15.0"
"created_date" = "4-Apr-21"
}
}Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| attributes | Additional attributes (e.g. 1). |
list(string) |
[] |
no |
| delimiter | Delimiter to be used between organization, name, environment and attributes. |
string |
"-" |
no |
| enabled | Set to false to prevent the module from creating any resources. | bool |
true |
no |
| environment | Environment (e.g. prod, dev, staging). |
string |
"" |
no |
| extra_tags | Additional tags (e.g. map(BusinessUnit,XYZ). |
map(string) |
{} |
no |
| label_order | Label order, e.g. sequence of application name and environment name,environment,'attribute' [webserver,qa,devops,public,] . |
list(any) |
[] |
no |
| managedby | ManagedBy, eg 'CloudDrove'. | string |
"[email protected]" |
no |
| name | Name (e.g. app or cluster). |
string |
"" |
no |
| repository | Terraform current module repo | string |
"https://github.com/clouddrove/terraform-labels" |
no |
Outputs
| Name | Description |
|---|---|
| attributes | Normalized attributes. |
| environment | Normalized environment |
| id | Disambiguated ID. |
| label_order | Normalized Tag map. |
| name | Normalized name. |
| repository | Terraform current module repo |
| tags | Normalized Tag map. |
Testing
In this module testing is performed with terratest and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a GO environment in your system.
You need to run the following command in the testing folder:
go test -run TestFeedback
If you come accross a bug or have any feedback, please log it in our issue tracker, or feel free to drop us an email at [email protected].
If you have found it worth your time, go ahead and give us a ★ on our GitHub!
About us
At CloudDrove, we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.
We are The Cloud Experts!
We