Awesome
<!-- markdownlint-disable --><a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-null-label/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/terraform-null-label/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-null-label.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-null-label/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-null-label.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label
to implement a strict naming convention.
There are 6 inputs considered "labels" or "ID elements" (because the labels are used to construct the ID):
- namespace
- tenant
- environment
- stage
- name
- attributes
This module generates IDs using the following convention by default: {namespace}-{environment}-{stage}-{name}-{attributes}
.
However, it is highly configurable. The delimiter (e.g. -
) is configurable. Each label item is optional (although you must provide at least one).
So if you prefer the term stage
to environment
and do not need tenant
, you can exclude them
and the label id
will look like {namespace}-{stage}-{name}-{attributes}
.
- The
tenant
label was introduced in v0.25.0. To preserve backward compatibility, it is not included by default. - The
attributes
input is actually a list of strings and{attributes}
expands to the list elements joined by the delimiter. - If
attributes
is excluded butnamespace
,stage
, andenvironment
are included,id
will look like{namespace}-{environment}-{stage}-{name}
. Excludingattributes
is discouraged, though, because attributes are the main way modules modify the ID to ensure uniqueness when provisioning the same resource types. - If you want the label items in a different order, you can specify that, too, with the
label_order
list. - You can set a maximum length for the
id
, and the module will create a (probably) unique name that fits within that length. (The module uses a portion of the MD5 hash of the fullid
to represent the missing part, so there remains a slight chance of name collision.) - You can control the letter case of the generated labels which make up the
id
usingvar.label_value_case
. - By default, all of the non-empty labels are also exported as tags, whether they appear in the
id
or not. You can control which labels are exported as tags by settinglabels_as_tags
to the list of labels you want exported, or the empty list[]
if you want no labels exported as tags at all. Tags passed in via thetags
variable are always exported, and regardless of settings, empty labels are never exported as tags. You can control the case of the tag names (keys) for the labels usingvar.label_key_case
. Unlike the tags generated from the label inputs, tags passed in via thetags
input are not modified.
There is an unfortunate collision over the use of the key name
. Cloud Posse uses name
in this module
to represent the component, such as eks
or rds
. AWS uses a tag with the key Name
to store the full human-friendly
identifier of the thing tagged, which this module outputs as id
, not name
. So when converting input labels
to tags, the value of the Name
key is set to the module id
output, and there is no tag corresponding to the
module name
output. An empty name
label will not prevent the Name
tag from being exported.
It's recommended to use one terraform-null-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.
For most purposes, the id
output is sufficient to create an ID or label for a resource, and if you want a different
ID or a different format, you would instantiate another instance of null-label
and configure it accordingly. However,
to accomodate situations where you want all the same inputs to generate multiple descriptors, this module provides
the descriptors
output, which is a map of strings generated according to the format specified by the
descriptor_formats
input. This feature is intentionally simple and minimally configurable and will not be
enhanced to add more features that are already in null-label
. See examples/complete/descriptors.tf for examples.
All Cloud Posse Terraform modules use this module to ensure resources can be instantiated multiple times within an account and without conflict.
The Cloud Posse convention is to use labels as follows:
namespace
: A short (3-4 letters) abbreviation of the company name, to ensure globally unique IDs for things like S3 bucketstenant
: (Rarely needed) When a company creates a dedicated resource per customer,tenant
can be used to identify the customer the resource is dedicated toenvironment
: A short abbreviation for the AWS region hosting the resource, orgbl
for resources like IAM roles that have no regionstage
: The name or role of the account the resource is for, such asprod
ordev
name
: The name of the component that owns the resources, such aseks
orrds
NOTE: The null
originally referred to the primary Terraform provider used in this module.
With Terraform 0.12, this module no longer needs any provider, but the name was kept for continuity.
- Releases of this module from
0.23.0
onward only work with Terraform 0.13 or newer. - Releases of this module from
0.12.0
through0.22.1
supportHCL2
and are compatible with Terraform 0.12 or newer. - Releases of this module prior to
0.12.0
are compatible with earlier versions of terraform like Terraform 0.11.
[!TIP]
π½ Use Atmos with Terraform
Cloud Posse uses
<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>atmos
to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.
Usage
Defaults
Cloud Posse Terraform modules share a common context
object that is meant to be passed from module to module.
The context object is a single object that contains all the input values for terraform-null-label
.
However, each input value can also be specified individually by name as a standard Terraform variable,
and the value of those variables, when set to something other than null
, will override the value
in the context object. In order to allow chaining of these objects, where the context object input to one
module is transformed and passed on to the next module, all the variables default to null
or empty collections.
The actual default values used when nothing is explicitly set are described in the documentation below.
For example, the default value of delimiter
is shown as null
, but if you leave it set to null
,
terraform-null-label
will actually use the default delimiter -
(hyphen).
A non-obvious but intentional consequence of this design is that once a module sets a non-default value, future modules in the chain cannot reset the value back to the original default. Instead, the new setting becomes the new default for downstream modules. Also, collections are not overwritten, they are merged, so once a tag is added, it will remain in the tag set and cannot be removed, although its value can be overwritten.
Because the purpose of labels_as_tags
is primarily to prevent tags from being generated
that would conflict with the AWS provider's default_tags
, it is an exception to the
rule that variables override the setting in the context object. The value in the context
object cannot be changed, so that later modules cannot re-enable a problematic tag.
Simple Example
module "eg_prod_bastion_label" {
source = "cloudposse/label/null"
# 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
because when generating id
, the default order is namespace
, environment
, stage
, name
, attributes
(you can override it by using the label_order
variable, see Advanced Example 3).
Now reference the label when creating an instance:
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"]
}
}
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.
<details><summary>Click to show</summary>module "eg_prod_bastion_label" {
source = "cloudposse/label/null"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "prod"
name = "bastion"
delimiter = "-"
tags = {
"BusinessUnit" = "XYZ",
"Snapshot" = "true"
}
}
module "eg_prod_bastion_abc_label" {
source = "cloudposse/label/null"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
attributes = ["abc"]
tags = {
"BusinessUnit" = "ABC" # Override the Business Unit tag set in the base label
}
# Copy all other fields from the base label
context = module.eg_prod_bastion_label.context
}
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/null"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
attributes = ["xyz"]
context = module.eg_prod_bastion_label.context
}
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]
}
</details>
Advanced Example 2
Here is a more complex example with an autoscaling group that has a different tagging schema than other resources and
requires its tags to be in this format, which this module can generate via additional_tag_map
and tags_as_list_of_maps
:
tags = [
{
key = "Name",
propagate_at_launch = true,
value = "namespace-stage-name"
},
{
key = "Namespace",
propagate_at_launch = true,
value = "namespace"
},
{
key = "Stage",
propagate_at_launch = true,
value = "stage"
}
]
Autoscaling group using propagating tagging below (full example: autoscalinggroup)
################################
# terraform-null-label example #
################################
module "label" {
source = "../../"
namespace = "cp"
stage = "prod"
name = "app"
tags = {
BusinessUnit = "Finance"
ManagedBy = "Terraform"
}
additional_tag_map = {
propagate_at_launch = true
}
}
#######################
# Launch template #
#######################
resource "aws_launch_template" "default" {
# terraform-null-label example used here: Set template name prefix
name_prefix = "${module.label.id}-"
image_id = data.aws_ami.amazon_linux.id
instance_type = "t2.micro"
instance_initiated_shutdown_behavior = "terminate"
vpc_security_group_ids = [data.aws_security_group.default.id]
monitoring {
enabled = false
}
# terraform-null-label example used here: Set tags on volumes
tag_specifications {
resource_type = "volume"
tags = module.label.tags
}
}
######################
# Autoscaling group #
######################
resource "aws_autoscaling_group" "default" {
# terraform-null-label example used here: Set ASG name prefix
name_prefix = "${module.label.id}-"
vpc_zone_identifier = data.aws_subnet_ids.all.ids
max_size = 1
min_size = 1
desired_capacity = 1
launch_template = {
id = aws_launch_template.default.id
version = "$$Latest"
}
# terraform-null-label example used here: Set tags on ASG and EC2 Servers
tags = module.label.tags_as_list_of_maps
}
</details>
Advanced Example 3
See complete example for even more examples.
This example shows how you can pass the context
output of one label module to the next label_module,
allowing you to create one label that has the base set of values, and then creating every extra label
as a derivative of that.
module "label1" {
source = "cloudposse/label/null"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "CloudPosse"
tenant = "H.R.H"
environment = "UAT"
stage = "build"
name = "Winston Churchroom"
attributes = ["fire", "water", "earth", "air"]
label_order = ["name", "tenant", "environment", "stage", "attributes"]
tags = {
"City" = "Dublin"
"Environment" = "Private"
}
}
module "label2" {
source = "cloudposse/label/null"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
name = "Charlie"
tenant = "" # setting to `null` would have no effect
stage = "test"
delimiter = "+"
regex_replace_chars = "/[^a-zA-Z0-9-+]/"
additional_tag_map = {
propagate_at_launch = true
additional_tag = "yes"
}
tags = {
"City" = "London"
"Environment" = "Public"
}
context = module.label1.context
}
module "label3" {
source = "cloudposse/label/null"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
name = "Starfish"
stage = "release"
delimiter = "."
regex_replace_chars = "/[^-a-zA-Z0-9.]/"
tags = {
"Eat" = "Carrot"
"Animal" = "Rabbit"
}
context = module.label1.context
}
This creates label outputs like this:
label1 = {
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = "-"
"id" = "winstonchurchroom-hrh-uat-build-fire-water-earth-air"
"name" = "winstonchurchroom"
"namespace" = "cloudposse"
"stage" = "build"
"tenant" = "hrh"
}
label1_context = {
"additional_tag_map" = {}
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = tostring(null)
"enabled" = true
"environment" = "UAT"
"id_length_limit" = tonumber(null)
"label_key_case" = tostring(null)
"label_order" = tolist([
"name",
"tenant",
"environment",
"stage",
"attributes",
])
"label_value_case" = tostring(null)
"name" = "Winston Churchroom"
"namespace" = "CloudPosse"
"regex_replace_chars" = tostring(null)
"stage" = "build"
"tags" = {
"City" = "Dublin"
"Environment" = "Private"
}
"tenant" = "H.R.H"
}
label1_normalized_context = {
"additional_tag_map" = {}
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = "-"
"enabled" = true
"environment" = "uat"
"id_length_limit" = 0
"label_key_case" = "title"
"label_order" = tolist([
"name",
"tenant",
"environment",
"stage",
"attributes",
])
"label_value_case" = "lower"
"name" = "winstonchurchroom"
"namespace" = "cloudposse"
"regex_replace_chars" = "/[^-a-zA-Z0-9]/"
"stage" = "build"
"tags" = {
"Attributes" = "fire-water-earth-air"
"City" = "Dublin"
"Environment" = "Private"
"Name" = "winstonchurchroom-hrh-uat-build-fire-water-earth-air"
"Namespace" = "cloudposse"
"Stage" = "build"
"Tenant" = "hrh"
}
"tenant" = "hrh"
}
label1_tags = tomap({
"Attributes" = "fire-water-earth-air"
"City" = "Dublin"
"Environment" = "Private"
"Name" = "winstonchurchroom-hrh-uat-build-fire-water-earth-air"
"Namespace" = "cloudposse"
"Stage" = "build"
"Tenant" = "hrh"
})
label2 = {
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = "+"
"id" = "charlie+uat+test+fire+water+earth+air"
"name" = "charlie"
"namespace" = "cloudposse"
"stage" = "test"
"tenant" = ""
}
label2_context = {
"additional_tag_map" = {
"additional_tag" = "yes"
"propagate_at_launch" = "true"
}
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = "+"
"enabled" = true
"environment" = "UAT"
"id_length_limit" = tonumber(null)
"label_key_case" = tostring(null)
"label_order" = tolist([
"name",
"tenant",
"environment",
"stage",
"attributes",
])
"label_value_case" = tostring(null)
"name" = "Charlie"
"namespace" = "CloudPosse"
"regex_replace_chars" = "/[^a-zA-Z0-9-+]/"
"stage" = "test"
"tags" = {
"City" = "London"
"Environment" = "Public"
}
"tenant" = ""
}
label2_tags = tomap({
"Attributes" = "fire+water+earth+air"
"City" = "London"
"Environment" = "Public"
"Name" = "charlie+uat+test+fire+water+earth+air"
"Namespace" = "cloudposse"
"Stage" = "test"
})
label2_tags_as_list_of_maps = [
{
"additional_tag" = "yes"
"key" = "Attributes"
"propagate_at_launch" = "true"
"value" = "fire+water+earth+air"
},
{
"additional_tag" = "yes"
"key" = "City"
"propagate_at_launch" = "true"
"value" = "London"
},
{
"additional_tag" = "yes"
"key" = "Environment"
"propagate_at_launch" = "true"
"value" = "Public"
},
{
"additional_tag" = "yes"
"key" = "Name"
"propagate_at_launch" = "true"
"value" = "charlie+uat+test+fire+water+earth+air"
},
{
"additional_tag" = "yes"
"key" = "Namespace"
"propagate_at_launch" = "true"
"value" = "cloudposse"
},
{
"additional_tag" = "yes"
"key" = "Stage"
"propagate_at_launch" = "true"
"value" = "test"
},
]
label3 = {
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = "."
"id" = "starfish.h.r.h.uat.release.fire.water.earth.air"
"name" = "starfish"
"namespace" = "cloudposse"
"stage" = "release"
"tenant" = "h.r.h"
}
label3_context = {
"additional_tag_map" = {}
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = "."
"enabled" = true
"environment" = "UAT"
"id_length_limit" = tonumber(null)
"label_key_case" = tostring(null)
"label_order" = tolist([
"name",
"tenant",
"environment",
"stage",
"attributes",
])
"label_value_case" = tostring(null)
"name" = "Starfish"
"namespace" = "CloudPosse"
"regex_replace_chars" = "/[^-a-zA-Z0-9.]/"
"stage" = "release"
"tags" = {
"Animal" = "Rabbit"
"City" = "Dublin"
"Eat" = "Carrot"
"Environment" = "Private"
}
"tenant" = "H.R.H"
}
label3_normalized_context = {
"additional_tag_map" = {}
"attributes" = tolist([
"fire",
"water",
"earth",
"air",
])
"delimiter" = "."
"enabled" = true
"environment" = "uat"
"id_length_limit" = 0
"label_key_case" = "title"
"label_order" = tolist([
"name",
"tenant",
"environment",
"stage",
"attributes",
])
"label_value_case" = "lower"
"name" = "starfish"
"namespace" = "cloudposse"
"regex_replace_chars" = "/[^-a-zA-Z0-9.]/"
"stage" = "release"
"tags" = {
"Animal" = "Rabbit"
"Attributes" = "fire.water.earth.air"
"City" = "Dublin"
"Eat" = "Carrot"
"Environment" = "Private"
"Name" = "starfish.h.r.h.uat.release.fire.water.earth.air"
"Namespace" = "cloudposse"
"Stage" = "release"
"Tenant" = "h.r.h"
}
"tenant" = "h.r.h"
}
label3_tags = tomap({
"Animal" = "Rabbit"
"Attributes" = "fire.water.earth.air"
"City" = "Dublin"
"Eat" = "Carrot"
"Environment" = "Private"
"Name" = "starfish.h.r.h.uat.release.fire.water.earth.air"
"Namespace" = "cloudposse"
"Stage" = "release"
"Tenant" = "h.r.h"
})
</details>
<!-- markdownlint-disable -->[!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.
Makefile Targets
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
<!-- markdownlint-restore -->
<!-- markdownlint-disable -->
Requirements
Name | Version |
---|---|
<a name="requirement_terraform"></a> terraform | >= 0.13.0 |
Providers
No providers.
Modules
No modules.
Resources
No resources.
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
<a name="input_additional_tag_map"></a> additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
<a name="input_attributes"></a> attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter <br/>and treated as a single ID element. | list(string) | [] | no |
<a name="input_context"></a> context | Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged. | any | <pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre> | no |
<a name="input_delimiter"></a> delimiter | Delimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
<a name="input_descriptor_formats"></a> descriptor_formats | Describe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>} <br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id .<br/>Default is {} (descriptors output will be empty). | any | {} | no |
<a name="input_enabled"></a> enabled | Set to false to prevent the module from creating any resources | bool | null | no |
<a name="input_environment"></a> environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
<a name="input_id_length_limit"></a> id_length_limit | Limit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0 .<br/>Does not affect id_full . | number | null | no |
<a name="input_label_key_case"></a> label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower , title , upper .<br/>Default value: title . | string | null | no |
<a name="input_label_order"></a> label_order | The order in which the labels (ID elements) appear in the id .<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
<a name="input_label_value_case"></a> label_value_case | Controls the letter case of ID elements (labels) as included in id ,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower , title , upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower . | string | null | no |
<a name="input_labels_as_tags"></a> labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id , not the name .<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored. | set(string) | <pre>[<br/> "default"<br/>]</pre> | no |
<a name="input_name"></a> name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag .<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
<a name="input_namespace"></a> namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
<a name="input_regex_replace_chars"></a> regex_replace_chars | Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
<a name="input_stage"></a> stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
<a name="input_tags"></a> tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).<br/>Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
<a name="input_tenant"></a> tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
Outputs
Name | Description |
---|---|
<a name="output_additional_tag_map"></a> additional_tag_map | The merged additional_tag_map |
<a name="output_attributes"></a> attributes | List of attributes |
<a name="output_context"></a> context | Merged but otherwise unmodified input to this module, to be used as context input to other modules.<br/>Note: this version will have null values as defaults, not the values actually used as defaults. |
<a name="output_delimiter"></a> delimiter | Delimiter between namespace , tenant , environment , stage , name and attributes |
<a name="output_descriptors"></a> descriptors | Map of descriptors as configured by descriptor_formats |
<a name="output_enabled"></a> enabled | True if module is enabled, false otherwise |
<a name="output_environment"></a> environment | Normalized environment |
<a name="output_id"></a> id | Disambiguated ID string restricted to id_length_limit characters in total |
<a name="output_id_full"></a> id_full | ID string not restricted in length |
<a name="output_id_length_limit"></a> id_length_limit | The id_length_limit actually used to create the ID, with 0 meaning unlimited |
<a name="output_label_order"></a> label_order | The naming order actually used to create the ID |
<a name="output_name"></a> name | Normalized name |
<a name="output_namespace"></a> namespace | Normalized namespace |
<a name="output_normalized_context"></a> normalized_context | Normalized context of this module |
<a name="output_regex_replace_chars"></a> regex_replace_chars | The regex_replace_chars actually used to create the ID |
<a name="output_stage"></a> stage | Normalized stage |
<a name="output_tags"></a> tags | Normalized Tag map |
<a name="output_tags_as_list_of_maps"></a> tags_as_list_of_maps | This is a list with one map for each tag . Each map contains the tag key ,<br/>value , and contents of var.additional_tag_map . Used in the rare cases<br/>where resources need additional configuration information for each tag. |
<a name="output_tenant"></a> tenant | Normalized tenant |
[!TIP]
Use Terraform Reference Architectures for AWS
Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
β We build it together with your team.<br/> β Your team owns everything.<br/> β 100% Open Source and backed by fanatical support.<br/>
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-label&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>π <strong>Learn More</strong></summary> <br/>Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.
Your team can operate like a pro today.
Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
Day-0: Your Foundation for Success
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
- Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
- Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
- GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-label&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
Day-2: Your Operational Mastery
- Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
- Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
- Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
- Code Reviews. Enhance your teamβs code quality with our expert feedback, fostering continuous improvement and collaboration.
- Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
- Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
- Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-label&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>
β¨ Contributing
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
<a href="https://github.com/cloudposse/terraform-null-label/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse/terraform-null-label&max=24" /> </a>For π bug reports & feature requests, please use the issue tracker.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
π Slack Community
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.
π° Newsletter
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β and usually a 5-minute read.
π Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-label&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you canβt find anywhere else. It's FREE for everyone!
License
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>Complete license is available in the LICENSE
file.
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.
</details>
Trademarks
All other trademarks referenced herein are the property of their respective owners.
Copyright Β© 2017-2024 Cloud Posse, LLC
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-label&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-null-label?pixel&cs=github&cm=readme&an=terraform-null-label"/>