Terraform Null Label 项目教程

Terraform Null Label 项目教程

terraform-null-labelTerraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])项目地址:https://gitcode.com/gh_mirrors/te/terraform-null-label

1. 项目目录结构及介绍

terraform-null-label/
├── examples/
│   ├── advanced/
│   ├── complete/
│   ├── simple/
│   └── README.md
├── main.tf
├── outputs.tf
├── README.md
├── variables.tf
└── versions.tf

目录结构介绍

• examples/: 包含多个示例目录，展示了如何在不同场景下使用 terraform-null-label 模块。

  • advanced/: 高级用法的示例。
  • complete/: 完整用法的示例。
  • simple/: 简单用法的示例。
  • README.md: 示例目录的说明文档。

• main.tf: 项目的主配置文件，定义了模块的主要逻辑。

• outputs.tf: 定义了模块的输出变量。

• README.md: 项目的说明文档，包含项目的介绍、使用方法和示例。

• variables.tf: 定义了模块的输入变量。

• versions.tf: 定义了 Terraform 和所需提供者的版本要求。

2. 项目的启动文件介绍

main.tf

main.tf 是项目的主配置文件，定义了模块的主要逻辑。它通常包含以下内容：

module "label" {
  source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  attributes = var.attributes
  delimiter  = var.delimiter
  tags       = var.tags
}

文件介绍

• module "label": 定义了一个名为 label 的模块，使用了 terraform-null-label 模块。
• source: 指定了模块的源地址。
• namespace, stage, name, attributes, delimiter, tags: 这些是模块的输入变量，用于生成一致的命名约定。

3. 项目的配置文件介绍

variables.tf

variables.tf 文件定义了模块的输入变量，用户可以通过这些变量来配置模块的行为。

variable "namespace" {
  description = "Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'"
  type        = string
}

variable "stage" {
  description = "Stage, e.g. 'prod', 'staging', 'dev', or 'test'"
  type        = string
}

variable "name" {
  description = "Solution name, e.g. 'app' or 'jenkins'"
  type        = string
}

variable "attributes" {
  description = "Additional attributes (e.g. `1`)"
  type        = list(string)
  default     = []
}

variable "delimiter" {
  description = "Delimiter to be used between `namespace`, `stage`, `name` and `attributes`"
  type        = string
  default     = "-"
}

variable "tags" {
  description = "Additional tags (e.g. `map('BusinessUnit','XYZ')`)"
  type        = map(string)
  default     = {}
}

文件介绍

• namespace: 命名空间，通常是组织的名称或缩写。
• stage: 环境阶段，如 prod, staging, dev, 或 test。
• name: 解决方案名称，如 app 或 jenkins。
• attributes: 额外的属性，通常是一个字符串列表。
• delimiter: 分隔符，用于分隔 namespace, stage, name 和 attributes。
• tags: 额外的标签，用于资源标记。

通过这些配置文件，用户可以灵活地配置 terraform-null-label 模块，生成一致的命名约定。

terraform-null-labelTerraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])项目地址:https://gitcode.com/gh_mirrors/te/terraform-null-label