Skip to content

Module for naming harmonization for resources (by Terraformation)

License

Notifications You must be signed in to change notification settings

terraformation/terraform-local-naming

Repository files navigation

terraform-local-naming

Build Status Licence Contributors Last commit Last commit Maintained by Terraformation Terraform Version Chat FOSSA Status

What does this Module ?

This module provides a mechanism to create consistent naming across multiple resources. The origin of the creation of this module is linked to the fact that most of company around the world commonly use standardized naming to describe their it resources.

Behind this standardize naming, their is often a meaning to give some information about of the context of the resource. (Like the zone where is hosted the resource).

How to use this Module ?

module "naming_module" {
  source = "terraformation/naming/local"
  naming_options = {
    suffix = "test"
    prefix = "test2"
  }
}

Inputs

Name Description Type Default Required
naming_options The options to pass to the generator object/any {} no

Outputs

Name Description
rendered The value of the generated name.

What's a Module?

A Module is a canonical, reusable, best-practices definition for how to run a single piece of infrastructure, such as a database or server cluster. Each Module is created using Terraform, and includes automated tests, examples, and documentation. It is maintained both by the open source community and companies that provide commercial support.

Instead of figuring out the details of how to run a piece of infrastructure from scratch, you can reuse existing code that has been proven in production. And instead of maintaining all that infrastructure code yourself, you can leverage the work of the Module community to pick up infrastructure improvements through a version number bump.

Who maintains this Module?

This Module is maintained by Terraformation. If you're looking for help please contact us on the following channels.

Also, you can find the complete list of contributors of this project here.

How do I contribute to this Module?

Contributions are very welcome! Check out the Contribution Guidelines for instructions.

How is this Module versioned?

This Module follows the principles of Semantic Versioning. You can find each new release, along with the changelog, in the Releases Page.

During initial development, the major version will be 0 (e.g., 0.x.y), which indicates the code does not yet have a stable API. Once we hit 1.0.0, we will make every effort to maintain a backwards compatible API and use the MAJOR, MINOR, and PATCH versions on each release to indicate any incompatibilities.

You will find a synthesis of each published version in the changelog file.

License

This code is released under the MIT License. Please see LICENSE and NOTICE for more details.

Copyright (c) 2019 Terraformation

FOSSA Status