88# Cloud Posse's standard configuration inputs suitable for passing
99# to Cloud Posse modules.
1010#
11+ # curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf
12+ #
1113# Modules should access the whole context as `module.this.context`
1214# to get the input variables with nulls for defaults,
1315# for example `context = module.this.context`,
2022
2123module "this" {
2224 source = " cloudposse/label/null"
23- version = " 0.24.1 " # requires Terraform >= 0.13.0
25+ version = " 0.25.0 " # requires Terraform >= 0.13.0
2426
2527 enabled = . enabled
2628 namespace = . namespace
29+ tenant = . tenant
2730 environment = . environment
2831 stage = . stage
2932 name = . name
@@ -36,6 +39,8 @@ module "this" {
3639 id_length_limit = . id_length_limit
3740 label_key_case = . label_key_case
3841 label_value_case = . label_value_case
42+ descriptor_formats = . descriptor_formats
43+ labels_as_tags = . labels_as_tags
3944
4045 context = . context
4146}
@@ -47,6 +52,7 @@ variable "context" {
4752 default =
4853 enabled = true
4954 namespace = null
55+ tenant = null
5056 environment = null
5157 stage = null
5258 name = null
@@ -59,6 +65,15 @@ variable "context" {
5965 id_length_limit = null
6066 label_key_case = null
6167 label_value_case = null
68+ descriptor_formats = {}
69+ # Note: we have to use [] instead of null for unset lists due to
70+ # https://github.com/hashicorp/terraform/issues/28137
71+ # which was not fixed until Terraform 1.0.0,
72+ # but we want the default to be all the labels in `label_order`
73+ # and we want users to be able to prevent all tag generation
74+ # by setting `labels_as_tags` to `[]`, so we need
75+ # a different sentinel to indicate "default"
76+ labels_as_tags = [" unset"
6277 }
6378 description = <<- EOT
6479 Single object for setting entire context at once.
@@ -88,69 +103,107 @@ variable "enabled" {
88103variable "namespace" {
89104 type = string
90105 default = null
91- description = " Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'"
106+ description = " ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique"
107+ }
108+
109+ variable "tenant" {
110+ type = string
111+ default = null
112+ description = " ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for"
92113}
93114
94115variable "environment" {
95116 type = string
96117 default = null
97- description = " Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT'"
118+ description = " ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'"
98119}
99120
100121variable "stage" {
101122 type = string
102123 default = null
103- description = " Stage , e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'"
124+ description = " ID element. Usually used to indicate role , e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'"
104125}
105126
106127variable "name" {
107128 type = string
108129 default = null
109- description = " Solution name, e.g. 'app' or 'jenkins'"
130+ description = <<- EOT
131+ ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
132+ This is the only ID element not also included as a `tag`.
133+ The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.
134+ EOT
110135}
111136
112137variable "delimiter" {
113138 type = string
114139 default = null
115140 description = <<- EOT
116- Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` .
141+ Delimiter to be used between ID elements .
117142 Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.
118143 EOT
119144}
120145
121146variable "attributes" {
122147 type = list (string )
123148 default =
124- description = " Additional attributes (e.g. `1`)"
149+ description = <<- EOT
150+ ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,
151+ in the order they appear in the list. New attributes are appended to the
152+ end of the list. The elements of the list are joined by the `delimiter`
153+ and treated as a single ID element.
154+ EOT
155+ }
156+
157+ variable "labels_as_tags" {
158+ type = set (string )
159+ default = " default"
160+ description = <<- EOT
161+ Set of labels (ID elements) to include as tags in the `tags` output.
162+ Default is to include all labels.
163+ Tags with empty values will not be included in the `tags` output.
164+ Set to `[]` to suppress all generated tags.
165+ **Notes:**
166+ The value of the `name` tag, if included, will be the `id`, not the `name`.
167+ Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be
168+ changed in later chained modules. Attempts to change it will be silently ignored.
169+ EOT
125170}
126171
127172variable "tags" {
128173 type = map (string )
129174 default =
130- description = " Additional tags (e.g. `map('BusinessUnit','XYZ')`"
175+ description = <<- EOT
176+ Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
177+ Neither the tag keys nor the tag values will be modified by this module.
178+ EOT
131179}
132180
133181variable "additional_tag_map" {
134182 type = map (string )
135183 default =
136- description = " Additional tags for appending to tags_as_list_of_maps. Not added to `tags`."
184+ description = <<- EOT
185+ Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.
186+ This is for some rare cases where resources want additional configuration of tags
187+ and therefore take a list of maps with tag key, value, and additional configuration.
188+ EOT
137189}
138190
139191variable "label_order" {
140192 type = list (string )
141193 default = null
142194 description = <<- EOT
143- The naming order of the id output and Name tag .
195+ The order in which the labels (ID elements) appear in the `id` .
144196 Defaults to ["namespace", "environment", "stage", "name", "attributes"].
145- You can omit any of the 5 elements , but at least one must be present.
146- EOT
197+ You can omit any of the 6 labels ("tenant" is the 6th) , but at least one must be present.
198+ EOT
147199}
148200
149201variable "regex_replace_chars" {
150202 type = string
151203 default = null
152204 description = <<- EOT
153- Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`.
205+ Terraform regular expression (regex) string.
206+ Characters matching the regex will be removed from the ID elements.
154207 If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.
155208 EOT
156209}
@@ -161,7 +214,7 @@ variable "id_length_limit" {
161214 description = <<- EOT
162215 Limit `id` to this many characters (minimum 6).
163216 Set to `0` for unlimited length.
164- Set to `null` for default , which is `0`.
217+ Set to `null` for keep the existing setting , which defaults to `0`.
165218 Does not affect `id_full`.
166219 EOT
167220 validation {
@@ -174,7 +227,8 @@ variable "label_key_case" {
174227 type = string
175228 default = null
176229 description = <<- EOT
177- The letter case of label keys (`tag` names) (i.e. `name`, `namespace`, `environment`, `stage`, `attributes`) to use in `tags`.
230+ Controls the letter case of the `tags` keys (label names) for tags generated by this module.
231+ Does not affect keys of tags passed in via the `tags` input.
178232 Possible values: `lower`, `title`, `upper`.
179233 Default value: `title`.
180234 EOT
@@ -189,8 +243,11 @@ variable "label_value_case" {
189243 type = string
190244 default = null
191245 description = <<- EOT
192- The letter case of output label values (also used in `tags` and `id`).
246+ Controls the letter case of ID elements (labels) as included in `id`,
247+ set as tag values, and output by this module individually.
248+ Does not affect values of tags passed in via the `tags` input.
193249 Possible values: `lower`, `title`, `upper` and `none` (no transformation).
250+ Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.
194251 Default value: `lower`.
195252 EOT
196253
@@ -199,4 +256,24 @@ variable "label_value_case" {
199256 error_message = " Allowed values: `lower`, `title`, `upper`, `none`."
200257 }
201258}
259+
260+ variable "descriptor_formats" {
261+ type = any
262+ default =
263+ description = <<- EOT
264+ Describe additional descriptors to be output in the `descriptors` output map.
265+ Map of maps. Keys are names of descriptors. Values are maps of the form
266+ `{
267+ format = string
268+ labels = list(string)
269+ }`
270+ (Type is `any` so the map values can later be enhanced to provide additional options.)
271+ `format` is a Terraform format string to be passed to the `format()` function.
272+ `labels` is a list of labels, in order, to pass to `format()` function.
273+ Label values will be normalized before being passed to `format()` so they will be
274+ identical to how they appear in `id`.
275+ Default is `{}` (`descriptors` output will be empty).
276+ EOT
277+ }
278+
202279# ### End of copy of cloudposse/terraform-null-label/variables.tf
0 commit comments