hadenlabs / terraform-null-tags

Terraform tags

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Latest Release Lint CI Test pre-commit Conventional Commits KeepAChangelog Terraform Version

terraform-null-tags

terraform tags

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

Usage

How to use this project

  module "main" {
    source = "hadenlabs/terraform-null-tags"
    version = "0.2.0"
    namespace   = "hadenlabs"
    environment = "us-east-1"
    stage       = "develop"
    name        = "jenkins"
  }

Full working examples can be found in examples folder.

Examples

common

  module "main" {
    source = "hadenlabs/terraform-null-tags"
    version = "0.2.0"
    namespace   = "hadenlabs"
    stage       = "develop"
    name        = "jenkins"
  }

Requirements

Name Version
terraform >= 0.13

Providers

No providers.

Modules

No modules.

Resources

No resources.

Inputs

Name Description Type Default Required
attributes Additional attributes (e.g. 1) list(string) [] no
config Single object for setting entire configuration at once.
See description of individual variables for details.
any {} no
name Solution name, e.g. 'app' or 'jenkins' string n/a yes
namespace Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' string n/a yes
stage Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' string n/a yes
tags Additional tags (e.g. map('BusinessUnit','XYZ') map(string) {} no

Outputs

Name Description
attributes List of attributes
delimiter Delimiter between namespace, stage, name and attributes
id_full return id full generated of label order
label_order The naming order actually used to create the ID
name Normalized name
name32 first 32 chars of string name
name6 first 6 chars of string name
namespace Normalized namespace
stage Normalized stage
tags Tags as a map (includes a Name tag)

Help

Got a question?

File a GitHub issue.

Contributing

See Contributing.

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

  1. Use the MAJOR version for incompatible changes.
  2. Use the MINOR version when adding functionality in a backwards compatible manner.
  3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

  • In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
  • In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright

Copyright © 2018-2022 Hadenlabs

Trademarks

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

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like terraform-null-tags

Your feedback is appreciated

About

Terraform tags

License:GNU Lesser General Public License v3.0


Languages

Language:HCL 52.3%Language:Handlebars 14.0%Language:Go 12.6%Language:TypeScript 11.6%Language:JavaScript 9.0%Language:Shell 0.5%