terraform-yaml-config

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

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

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.

Security & Compliance

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

Benchmark	Description
	Infrastructure Security Compliance
	Center for Internet Security, KUBERNETES Compliance
	Center for Internet Security, AWS Compliance
	Center for Internet Security, AZURE Compliance
	Payment Card Industry Data Security Standards Compliance
	National Institute of Standards and Technology Compliance
	Information Security Management System, ISO/IEC 27001 Compliance
	Service Organization Control 2 Compliance
	Center for Internet Security, GCP Compliance
	Health Insurance Portability and Accountability Compliance

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

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
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

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

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-datadog-monitor - Terraform module to configure and provision Datadog monitors from a YAML configuration, complete with automated tests.
terraform-opsgenie-incident-management - Terraform module to provision Opsgenie resources from YAML configurations using the Opsgenie provider, complete with automated tests.
terraform-aws-components - Catalog of reusable Terraform components and blueprints for provisioning reference architectures.
reference-architectures - Get up and running quickly with one of our reference architecture using our fully automated cold-start process.

References

For additional context, refer to some of these links.

Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration.
Terraform templatefile Function - templatefile reads the file at the given path and renders its content as a template using a supplied set of template variables.
Terraform template_file data source - The template_file data source renders a template from a template string, which is usually loaded from an external file.
Deepmerge - Terraform module to perform a deep map merge of standard Terraform maps and objects.

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

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.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

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!

Copyrights

License

See LICENSE for full details.

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman	Andriy Knysh

freeletics/terraform-yaml-config

terraform-yaml-config

Introduction

Attributions

Security & Compliance

Usage

Examples

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

Example of local maps configurations with `import` and deep merging

Example of remote maps configurations with with `import` and deep merging

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Share the Love

Related Projects

References

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyrights

License

Trademarks

About

Contributors

freeletics/terraform-yaml-config

terraform-yaml-config

Introduction

Attributions

Security & Compliance

Usage

Examples

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

Example of local maps configurations with import and deep merging

Example of remote maps configurations with with import and deep merging

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Share the Love

Related Projects

References

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyrights

License

Trademarks

About

Contributors

Example of local maps configurations with `import` and deep merging

Example of remote maps configurations with with `import` and deep merging