Module: config

Terraform module to convert local and remote YAML configuration templates into Terraform lists and maps.

Introduction

The module accepts paths to local and remote YAML configuration template files and converts the templates into Terraform lists and maps for consumption in other Terraform modules.

The module can accept a map of parameters for interpolation within the YAML config templates.

The module also supports a top-level import attribute in map configuration templates, which will include the file and perform a deep merge. Up to 10 levels of imports hierarchy are supported, and all imported maps are deep merged into a final configuration map.

For example, if you have a config file like this (e.g. myconfig.yaml):

  import:
    - file1
    - file2

Then, this module will deep merge file1.yaml and file2.yaml into myconfig.yaml.

Note: Do not include the extensions (e.g. .yaml) in the imports.

Attributions

Big thanks to Imperative Systems Inc. for the excellent deepmerge Terraform module to perform a deep map merge of standard Terraform maps and objects.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on Datadog), see test.

For an example of using local config maps with import and deep merging into a final configuration map, see examples/imports-local.

For an example of using remote config maps with import and deep merging into a final configuration map, see examples/imports-remote.

Examples

Example of local and remote maps and lists configurations with interpolation parameters

module "yaml_config" {
  source = "cloudposse/config/yaml"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  map_config_local_base_path = "./config"

  map_config_paths = [
    "map-configs/*.yaml",
    "https://raw.githubusercontent.com/cloudposse/terraform-opsgenie-incident-management/master/examples/config/resources/services.yaml",
    "https://raw.githubusercontent.com/cloudposse/terraform-opsgenie-incident-management/master/examples/config/resources/team_routing_rules.yaml"
  ]

  list_config_local_base_path = "./config"

  list_config_paths = [
    "list-configs/*.yaml",
    "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/master/examples/complete/policies/organization-policies.yaml"
  ]

  parameters = {
    param1 = "1"
    param2 = "2"
  }

  context = module.this.context
}

Example of local maps configurations with import and deep merging

In the example, we use two levels of imports, and the module deep merges the local config files imports-level-3.yaml, imports-level-2.yaml, and imports-level-1.yaml into a final config map.

See examples/imports-local for more details.

module "yaml_config" {
  source = "cloudposse/config/yaml"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  map_config_local_base_path = "./config"

  map_config_paths = [
    "imports-level-1.yaml"
  ]

  context = module.this.context
}

Example of remote maps configurations with with import and deep merging

In the example, we use two levels of imports, and the module deep merges the remote config files globals.yaml, ue2-globals.yaml, and ue2-prod.yaml into a final config map.

See examples/imports-remote for more details.

module "yaml_config" {
  source = "cloudposse/config/yaml"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  map_config_remote_base_path = "https://raw.githubusercontent.com/cloudposse/atmos/master/example/stacks"

  map_config_paths = [
    "https://raw.githubusercontent.com/cloudposse/atmos/master/example/stacks/ue2-prod.yaml"
  ]

  context = module.this.context
}

Requirements

Name	Version
terraform	>= 0.13.0
http	>= 2.0
local	>= 1.3
template	>= 2.2

Providers

No providers.

Modules

Name	Source	Version
maps_deepmerge	./modules/deepmerge	n/a
this	cloudposse/label/null	0.25.0
yaml_config_1	./modules/yaml-config	n/a
yaml_config_10	./modules/yaml-config	n/a
yaml_config_2	./modules/yaml-config	n/a
yaml_config_3	./modules/yaml-config	n/a
yaml_config_4	./modules/yaml-config	n/a
yaml_config_5	./modules/yaml-config	n/a
yaml_config_6	./modules/yaml-config	n/a
yaml_config_7	./modules/yaml-config	n/a
yaml_config_8	./modules/yaml-config	n/a
yaml_config_9	./modules/yaml-config	n/a

Resources

No resources.

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
append_list_enabled	A boolean flag to enable/disable appending lists instead of overwriting them.	bool	false	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	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.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
deep_copy_list_enabled	A boolean flag to enable/disable merging of list elements one by one.	bool	false	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
list_config_local_base_path	Base path to local YAML configuration files of list type	string	""	no
list_config_paths	Paths to YAML configuration files of list type	list(string)	[]	no
list_config_remote_base_path	Base path to remote YAML configuration files of list type	string	""	no
map_config_local_base_path	Base path to local YAML configuration files of map type	string	""	no
map_config_paths	Paths to YAML configuration files of map type	list(string)	[]	no
map_config_remote_base_path	Base path to remote YAML configuration files of map type	string	""	no
map_configs	List of existing configurations of map type. Deep-merging of the existing map configs takes precedence over the map configs loaded from YAML files	any	[]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
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
parameters	Map of parameters for interpolation within the YAML config templates	map(string)	{}	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
remote_config_selector	String to detect local vs. remote config paths	string	"://"	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
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
all_imports_list	List of all imported YAML configurations
all_imports_map	Map of all imported YAML configurations
list_configs	Terraform lists from YAML configurations
map_configs	Terraform maps from YAML configurations