standard

highgarden-io/standard/labels

Terraform Module HCL LABELS

Terraform Module to generate consistent names, ids, and labels/tags according to Highgarden.io standard labeling scheme.

Install
module "standard" {
source = "highgarden-io/standard/labels"
version = "1.1.0"
}
plain text: /constructs/tfmod-highgarden-io-standard-labels/install.txt
⭐ Source on GitHub 📦 Registry page
README

terraform-labels-generator Terraform module designed to generate consistent names and tags for resources. Use terraform-labels-generator to implement a strict naming convention. ![Generate terraform docs](https://github.com/highgarden-io/terraform-labels-standard/actions/workflows/documentation.yaml) ![Lint](https://github.com/highgarden-io/terraform-labels-standard/actions/workflows/lint.yaml) Requirements | Name | Version | |------|---------| | terraform | >= 0.13.0 | Providers No providers. Modules No modules. Resources No resources. Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | component | Sub-component of the resources, used to generate resource ID. (optional) | string | "" | no | | id\_label\_enabled | Extra Label with

Inputs (14)
NameTypeDescriptionDefault
regionstringRegion of the resources, used to generate resource ID. required
stagestringStage of the resources, such as dev, test, prod, etc. required
namestringName of the resources, used to generate resource ID. required
managed_by_refstringReference of the location of the component that manages the resources. (Repo / T required
layerstringInfrastructure layer of the resources, used to generate resource ID. required
org_tldstringOrganization TLD used to generate standard labels keys."io"
namespacestringNamespace of generate resources, used to group resources of a team/sub-organizat"main"
org_shortstringShort Organization Name used for naming resources."h8n"
id_label_keynamestringExtra Label with the ID Value (e.g 'Name' for AWS)"Name"
zonestringZone of the resources if applicable. (optional)""
managed_bystringName of the component that manages the resources. ( default to 'Terraform', poss"terraform"
orgstringThe Organization Name"highgarden"
componentstringSub-component of the resources, used to generate resource ID. (optional)""
id_label_enabledboolExtra Label with the ID Value (e.g 'Name' for AWS)true
Outputs (17)
labels_topology — A Map of all 'Topology' Labels Generated by the Module.
org_short — Short Organization Name used for naming resources.
org_tld — Organization TLD used to generate standard labels keys.
name — Name of the resources, used to generate resource ID.
component — Sub-component of the resources, used to generate resource ID.
zone — Zone of the resources if applicable.
id — The ID of the resource
labels_managed_by — A Map of all 'Managed By' Labels Generated by the Module.
namespace — Namespace of generate resources, used to group resources of a team/sub-organization.
org — The Organization Name
stage — Stage of the resources, such as dev, test, prod, etc.
labels — A Map of all Labels Generated by the Module
labels_id — A Map of all 'Identity' Labels Generated by the Module.
layer — Infrastructure layer of the resources, used to generate resource ID.
region — Region of the resources, used to generate resource ID.
managed_by — Name of the component that manages the resources. ( default to 'Terraform', possible values can be o
managed_by_ref — Reference of the location of the component that manages the resources. (Repo / Terraform State Path)
Details
FrameworkTerraform Module
LanguageHCL
Version1.1.0
Cloud LABELS
★ Stars0
Forks0
Total downloads550
Inputs14
Outputs17
LicenseMIT
Namespacehighgarden-io
Updated