forked from cloudposse/terraform-null-label
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update readme * Fix mnt
- Loading branch information
Showing
4 changed files
with
298 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| ## {{ (datasource "git").name }} [](https://travis-ci.org/cloudposse/terraform-null-label) | ||
| {{ (datasource "section").warning }} | ||
|
|
||
| Terraform module designed to generate consistent label names and tags for resources. Use `terraform-null-label` to implement a strict naming convention. | ||
|
|
||
| A label follows the following convention: `{namespace}-{stage}-{name}-{attributes}`. The delimiter (e.g. `-`) is interchangeable. | ||
|
|
||
| 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. | ||
|
|
||
| All [Cloud Posse modules](https://github.com/cloudposse?utf8=%E2%9C%93&q=tf_&type=&language=) use this module to ensure resources can be instantiated multiple times within an account and without conflict. | ||
|
|
||
| -**NOTE:** The `null` refers to the primary Terraform [provider](https://www.terraform.io/docs/providers/null/index.html) used in this module. | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Simple Example | ||
|
|
||
| Include this repository as a module in your existing terraform code: | ||
|
|
||
| ```hcl | ||
| module "eg_prod_bastion_label" { | ||
| source = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master" | ||
| namespace = "eg" | ||
| stage = "prod" | ||
| name = "bastion" | ||
| attributes = ["public"] | ||
| delimiter = "-" | ||
| tags = "${map("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 = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master" | ||
| namespace = "eg" | ||
| stage = "prod" | ||
| name = "bastion" | ||
| attributes = ["abc"] | ||
| delimiter = "-" | ||
| tags = "${map("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 = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master" | ||
| namespace = "eg" | ||
| stage = "prod" | ||
| name = "bastion" | ||
| attributes = ["xyz"] | ||
| delimiter = "-" | ||
| tags = "${map("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}"] | ||
| } | ||
| ``` | ||
|
|
||
| {{ (datasource "terraform").input }} | ||
|
|
||
| **WARNING** Any tags passed as an input to this module will *override* the tags generated by this module. | ||
|
|
||
| {{ (datasource "terraform").output }} | ||
|
|
||
| {{ (datasource "section").help }} | ||
|
|
||
| {{ (datasource "section").contributing }} | ||
|
|
||
| {{ (datasource "license").apache2 }} | ||
|
|
||
| {{ (datasource "section").about }} | ||
|
|
||
| ### Contributors | ||
|
|
||
| | | ||
| {{- (datasource "contributor").erik }} | | ||
| {{- (datasource "contributor").igor }} | | ||
| {{- (datasource "contributor").konstantin }} | | ||
| {{- (datasource "contributor").andrew }} | | ||
| {{- (datasource "contributor").sergey }} | | ||
| |---|---|---|---|---| | ||
|
|
||
| {{ (datasource "contributor")._links }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,40 @@ | ||
| output "id" { | ||
| value = "${null_resource.default.triggers.id}" | ||
| value = "${null_resource.default.triggers.id}" | ||
| description = "Disambiguated ID" | ||
| } | ||
|
|
||
| output "name" { | ||
| value = "${null_resource.default.triggers.name}" | ||
| value = "${null_resource.default.triggers.name}" | ||
| description = "Normalized name" | ||
| } | ||
|
|
||
| output "namespace" { | ||
| value = "${null_resource.default.triggers.namespace}" | ||
| value = "${null_resource.default.triggers.namespace}" | ||
| description = "Normalized namespace" | ||
| } | ||
|
|
||
| output "stage" { | ||
| value = "${null_resource.default.triggers.stage}" | ||
| value = "${null_resource.default.triggers.stage}" | ||
| description = "Normalized stage" | ||
| } | ||
|
|
||
| output "attributes" { | ||
| value = "${null_resource.default.triggers.attributes}" | ||
| value = "${null_resource.default.triggers.attributes}" | ||
| description = "Normalized attributes" | ||
| } | ||
|
|
||
| # Merge input tags with our tags. | ||
| # Note: `Name` has a special meaning in AWS and we need to disamgiuate it by using the computed `id` | ||
| output "tags" { | ||
| value = "${ | ||
| merge( | ||
| map( | ||
| "Name", "${null_resource.default.triggers.id}", | ||
| "Namespace", "${null_resource.default.triggers.namespace}", | ||
| "Stage", "${null_resource.default.triggers.stage}" | ||
| ), var.tags | ||
| ) | ||
| }" | ||
| merge( | ||
| map( | ||
| "Name", "${null_resource.default.triggers.id}", | ||
| "Namespace", "${null_resource.default.triggers.namespace}", | ||
| "Stage", "${null_resource.default.triggers.stage}" | ||
| ), var.tags | ||
| ) | ||
| }" | ||
|
|
||
| description = "Normalized Tag map" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters