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,
which is actively maintained and used by all current Cloud Posse Terraform modules.
This module was a fork of 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,
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!
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 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 use the related 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.
This project was part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
| Benchmark | Description |
|---|---|
|
This project is no longer being maintained |
| Infrastructure Security Compliance | |
| Center for Internet Security, KUBERNETES Compliance | |
| Center for Internet Security, AWS Compliance | |
| Center for Internet Security, AZURE Compliance | |
| Payment Card Industry Data Security Standards Compliance | |
| National Institute of Standards and Technology Compliance | |
| Information Security Management System, ISO/IEC 27001 Compliance | |
| Service Organization Control 2 Compliance | |
| Center for Internet Security, GCP Compliance | |
| Health Insurance Portability and Accountability Compliance |
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
Include this repository as a module in your existing terraform code:
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):
resource "aws_instance" "eg_prod_bastion_public" {
instance_type = "t1.micro"
tags = module.eg_prod_bastion_label.tags
}Or define a security group:
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"]
}
}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.
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]
}Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Copyright © 2017-2021 Cloud Posse, LLC
See LICENSE for full details.
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
 Sarkis Varozian |
 Andriy Knysh |
 Jamie Nelson |
|---|