label

appzen-oss/label/local

Terraform Module HCL LOCAL

Terraform module to create consistent naming

Install
module "label" {
source = "appzen-oss/label/local"
version = "0.3.1"
}
plain text: /constructs/tfmod-appzen-oss-label-local/install.txt
⭐ Source on GitHub 📦 Registry page
README

terraform-local-label ![CircleCI](https://circleci.com/gh/appzen-oss/terraform-local-label) ![Github release](https://github.com/appzen-oss/terraform-local-label/releases) ![HitCount](http://hits.dwyl.io/appzen-oss/terraform-local-label) Terraform module to provide consistent label names and tags for resources. A single name format will not solve every use case, so multiple variants are returned and there is a few options to affect how they get build. The general name convention is {organization}-{environment}-{name}-{attributes}. Name is required, the other 3 can be turned on/off individually. The delimiter (-) can be changed All devops-workflow modules will eventually use this or labels. NOTE: local refers to this using locals and does not create any resources. It just builds new variabl

Inputs (14)
NameTypeDescriptionDefault
environmentanyEnvironment (ex: `dev`, `qa`, `stage`, `prod`). (Second or top level namespace. required
nameanyBase name for resource required
teamanyTAG: Department/team of people responsible for service"UNDEF"
monitoranyTAG: Should resource be monitored"UNDEF"
productanyTAG: Company/business product"UNDEF"
organizationanyOrganization name (Top level namespace)""
owneranyTAG: Owner of the service"UNDEF"
delimiteranyDelimiter to be used between `name`, `namespaces`, `attributes`, etc."-"
namespace-envanyPrefix name with the environment. If true, format is: `{env}-{name}`true
attributesanySuffix name with additional attributes (policy, role, etc.)[]
namespace-organyPrefix name with the organization. If true, format is: `{org}-{env namespaced nafalse
componentanyTAG: Underlying, dedicated piece of service (Cache, DB, ...)"UNDEF"
serviceanyTAG: Application (microservice) name"UNDEF"
tagsanyA map of additional tags{}
Outputs (14)
id_attr_32 — ID max size 32 characters by truncating `id_org` then appending `attributes`
id_env — If env namespace enabled `{env}-{name}` else `{name}`
id_32 — ID truncated to 32 characters
id — Fully formatted name ID
tags — Tags map merged with standard tags
org_attr_20 — Internal debugging. DO NOT USE
org_attr_32 — Internal debugging. DO NOT USE
attributes — Attribute string lowercase
organization — Organization name lowercase
id_20 — ID truncated to 20 characters
id_attr_20 — ID max size 20 characters by truncating `id_org` then appending `attributes`
id_org — If org namespace enabled `{org}-{id_env}` else `{id_env}`
name — Name lowercase
environment — Environment name lowercase
Details
FrameworkTerraform Module
LanguageHCL
Version0.3.1
Cloud LOCAL
★ Stars0
Forks0
Total downloads8.1k
Inputs14
Outputs14
Examples9
Namespaceappzen-oss
Updated