terraform-null-label Latest Release

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

A label follows the following convention: {environment}-{name}-{squad}-{attributes}. The delimiter (e.g. -) is configurable.

• squad Check squad list

Other labels are also required:

• bu (As default value we use {picpay})
• costcenter Check costcenter list
• tribe Check tribe list

You can add any aditional tags if you want to

NOTE: Module forked from Cloudposse terraform-null-label The null refers to the primary Terraform provider used in this module.

Releases of this module from 0.12.0 onward support HCL2 and only work with Terraform 0.12 or newer.

---

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

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 to the next module, all the variables default to null or empty collections. The actual default values used when nothing is explicitly set are describe 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. Insted, 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.

Simple Example

module "lab_bastion_infracore_label" {
  source      = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
  environment = "lab"
  name        = "bastion"
  squad       = "infracore"
  bu          = "picpay"
  costcenter  = "1462"
  tribe       = "infracloud"
  terraform   = "true"
  tags = {
    "foo" = "bar"
  }
}

This will create an id with the value of lab-bastion-infracore because when generating id, the default order is environment, name, squad

Now reference the label when creating an instance:

resource "aws_instance" "lab_bastion_infracore" {
  instance_type = "t1.micro"
  tags          = module.lab_bastion_infracore_.tags
}

Or define a security group:

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

Requirements

Name	Version
terraform	>= 0.12.0, < 0.14.0

Providers

No provider.

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional tags for appending to tags_as_list_of_maps. Not added to tags.	map(string)	{}	no
attributes	Additional attributes (e.g. 1)	list(string)	[]	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	object({ enabled = bool namespace = string environment = string stage = string name = string delimiter = string attributes = list(string) tags = map(string) additional_tag_map = map(string) regex_replace_chars = string label_order = list(string) id_length_limit = number })	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "enabled": true, "environment": null, "id_length_limit": null, "label_order": [], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {} }	no
delimiter	Delimiter to be used between namespace, environment, stage, name and attributes. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	Environment, e.g. 'lab', 'dev', 'hom', OR 'prod'	string	null	yes
id_length_limit	Limit id to this many characters. Set to 0 for unlimited length. Set to null for default, which is 0. Does not affect id_full.	number	null	no
label_order	The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present.	list(string)	null	no
name	Solution name, e.g. 'app' or 'jenkins'	string	null	yes
regex_replace_chars	Regex to replace chars with empty string in namespace, environment, stage and name. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
squad	Squad, e.g. 'infracore', 'p2p', 'card', for more check squad list	string	null	yes
bu	bu, e.g. The default value is 'picpay'	string	picpay	no
costcenter	costcenter, A number for the cost center, check cost center list	string	null	yes
tribe	tribe, A tribe name, check tribe name list list	string	null	yes
terraform	to know if the resource was created with terraform	string	true	no
tags	Additional tags (e.g. map('BusinessUnit','XYZ')	map(string)	{}	no

Outputs

Name	Description
additional_tag_map	The merged additional_tag_map
attributes	List of attributes
context	Merged but otherwise unmodified input to this module, to be used as context input to other modules. Note: this version will have null values as defaults, not the values actually used as defaults.
delimiter	Delimiter between namespace, environment, stage, name and attributes
enabled	True if module is enabled, false otherwise
environment	Normalized environment
id	Disambiguated ID restricted to id_length_limit characters in total
id_full	Disambiguated ID not restricted in length
id_length_limit	The id_length_limit actually used to create the ID, with 0 meaning unlimited
label_order	The naming order actually used to create the ID
name	Normalized name
normalized_context	Normalized context of this module
regex_replace_chars	The regex_replace_chars actually used to create the ID
squad	Normalized stage
tags	Normalized Tag map
bu	Normalized bu
costcenter	Normalized costcenter
tribe	Normalized tribe
terraform	Normalized terraform
tags_as_list_of_maps	Additional tags as a list of maps, which can be used in several AWS resources