https://github.com/cloudposse/terraform-terraform-label

Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])
https://github.com/cloudposse/terraform-terraform-label

hcl2 label naming-convention terraform terraform-module

Last synced: about 2 months ago
JSON representation

Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])

Host: GitHub
URL: https://github.com/cloudposse/terraform-terraform-label
Owner: cloudposse
License: apache-2.0
Created: 2018-05-09T21:51:57.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2024-10-11T03:09:51.000Z (8 months ago)
Last Synced: 2025-03-28T13:05:30.864Z (about 2 months ago)
Topics: hcl2, label, naming-convention, terraform, terraform-module
Language: HCL
Homepage: https://cloudposse.com/accelerate
Size: 4 MB
Stars: 118
Watchers: 20
Forks: 59
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

# (deprecated) terraform-terraform-label

## Deprecated

This module was an experimental fork and is now obsolete and will not be maintained.
Any projects using `terraform-terraform-label` are encouraged to switch to using
[terraform-null-label](https://github.com/cloudposse/terraform-null-label),
which is actively maintained and used by all current Cloud Posse Terraform modules.

This module was a fork of [terraform-null-label](https://github.com/cloudposse/terraform-null-label), made
at a time when that project was using the Terraform `null` provider (hence the "null" in the name), in order
to remove the `null` provider dependency. This was accomplished by removing outputs that required the `null`
provider.

With the features that became available in Terraform 0.12, the `terraform-null-label` project was able
to retain all of its features and also
[remove the `null` provider](https://github.com/cloudposse/terraform-null-label/commit/d6d24b80d687e76e029f39f444d0163b42c5d5e0),
removing any incentive to further develop `terraform-terraform-label`.

With the key distinguishing feature of `terraform-terraform-label` no longer being a distinguishing feature,
this module was no longer necessary, and all focus returned to maintaining and enhancing `terraform-null-label`,
which now far surpasses this module in functionality.

We literally have *hundreds of other terraform modules* that are Open Source and well-maintained. Check them out!

### Historical Description

Terraform module designed to generate consistent label names and tags for resources. Use `terraform-terraform-label` to implement a strict naming convention.

#### `terraform-terraform-label` is a fork of [terraform-null-label](https://github.com/cloudposse/terraform-null-label) which uses only the core Terraform provider.

A label follows the following convention: `{namespace}-{stage}-{name}-{attributes}`. The delimiter (e.g. `-`) is interchangeable.

It's recommended to use one `terraform-terraform-label` module for every unique resource of a given resource type.
For example, if you have 10 instances, there should be 10 different labels.
However, if you have multiple different kinds of resources (e.g. instances, security groups, file systems, and elastic IPs), then they can all share the same label assuming they are logically related.

All [Cloud Posse modules](https://github.com/cloudposse?utf8=%E2%9C%93&q=terraform-&type=&language=) use
the related [terraform-null-label](https://github.com/cloudposse/terraform-null-label) module to ensure resources can be instantiated multiple times within an account and without conflict.

**NOTE:** The second `terraform` word in `terraform-terraform-label` refers to the primary Terraform provider used in this module.

> [!TIP]
> #### 👽 Use Atmos with Terraform
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform.

> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
>
>
> Watch demo of using Atmos with Terraform
>

> Example of running atmos to manage infrastructure from our Quick Start tutorial.
>

## Usage

### Simple Example

Include this repository as a module in your existing terraform code:

```hcl
module "eg_prod_bastion_label" {
source = "cloudposse/label/terraform"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "prod"
name = "bastion"
attributes = ["public"]
delimiter = "-"

tags = {
"BusinessUnit" = "XYZ",
"Snapshot" = "true"
}
}
```

This will create an `id` with the value of `eg-prod-bastion-public`.

Now reference the label when creating an instance (for example):

```hcl
resource "aws_instance" "eg_prod_bastion_public" {
instance_type = "t1.micro"
tags = module.eg_prod_bastion_label.tags
}
```

Or define a security group:

```hcl
resource "aws_security_group" "eg_prod_bastion_public" {
vpc_id = var.vpc_id
name = module.eg_prod_bastion_label.id
tags = module.eg_prod_bastion_label.tags
egress {
from_port = 0
to_port = 0
protocol = "-1"
cidr_blocks = ["0.0.0.0/0"]
}
}
```

### Advanced Example

Here is a more complex example with two instances using two different labels. Note how efficiently the tags are defined for both the instance and the security group.

```hcl
module "eg_prod_bastion_abc_label" {
source = "cloudposse/label/terraform"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "prod"
name = "bastion"
attributes = ["abc"]
delimiter = "-"

tags = {
"BusinessUnit" = "ABC"
}
}

resource "aws_security_group" "eg_prod_bastion_abc" {
name = module.eg_prod_bastion_abc_label.id
tags = module.eg_prod_bastion_abc_label.tags
ingress {
from_port = 22
to_port = 22
protocol = "tcp"
cidr_blocks = ["0.0.0.0/0"]
}
}

resource "aws_instance" "eg_prod_bastion_abc" {
instance_type = "t1.micro"
tags = module.eg_prod_bastion_abc_label.tags
vpc_security_group_ids = [aws_security_group.eg_prod_bastion_abc.id]
}

module "eg_prod_bastion_xyz_label" {
source = "cloudposse/label/terraform"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "prod"
name = "bastion"
attributes = ["xyz"]
delimiter = "-"

tags = {
"BusinessUnit" = "XYZ"
}
}

resource "aws_security_group" "eg_prod_bastion_xyz" {
name = module.eg_prod_bastion_xyz_label.id
tags = module.eg_prod_bastion_xyz_label.tags
ingress {
from_port = 22
to_port = 22
protocol = "tcp"
cidr_blocks = ["0.0.0.0/0"]
}
}

resource "aws_instance" "eg_prod_bastion_xyz" {
instance_type = "t1.micro"
tags = module.eg_prod_bastion_xyz_label.tags
vpc_security_group_ids = [aws_security_group.eg_prod_bastion_xyz.id]
}
```

> [!IMPORTANT]
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
> approach for updating versions to avoid unexpected changes.

## License

Preamble to the Apache License, Version 2.0

Complete license is available in the [`LICENSE`](LICENSE) file.

```text
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
```

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/cloudposse/terraform-terraform-label

Awesome Lists containing this project

README