Terraform-Terraform-Label 项目使用教程

Terraform-Terraform-Label 项目使用教程

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

1. 项目的目录结构及介绍

terraform-terraform-label/
├── examples/
│   └── complete/
├── test/
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── README.yaml
├── main.tf
├── outputs.tf
├── variables.tf
├── versions.tf

目录结构说明

• examples/: 包含项目的完整示例，展示了如何使用该模块。
• test/: 包含项目的测试文件，用于验证模块的功能。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件，本项目使用 Apache-2.0 许可证。
• Makefile: 包含项目的构建和测试命令。
• README.md: 项目的说明文档，包含项目的介绍、使用方法等。
• README.yaml: 项目的 YAML 格式说明文档。
• main.tf: 项目的主配置文件，定义了模块的主要逻辑。
• outputs.tf: 定义了模块的输出变量。
• variables.tf: 定义了模块的输入变量。
• versions.tf: 定义了项目所需的 Terraform 版本。

2. 项目的启动文件介绍

main.tf

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

• 资源定义: 定义了 Terraform 需要管理的资源。
• 模块调用: 调用其他 Terraform 模块来实现更复杂的功能。
• 数据源: 从外部获取数据以供模块使用。

示例代码：

module "label" {
  source     = "git::https://github.com/cloudposse/terraform-terraform-label.git"
  namespace  = "example"
  stage      = "dev"
  name       = "app"
  attributes = ["public"]
  delimiter  = "-"
}

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 'source', 'build', 'test', 'deploy', 'release'"
  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     = "-"
}

outputs.tf

outputs.tf 文件定义了模块的输出变量，这些变量可以在其他 Terraform 配置中使用。

示例代码：

output "id" {
  description = "Disambiguated ID"
  value       = module.label.id
}

output "name" {
  description = "Normalized name"
  value       = module.label.name
}

output "namespace" {
  description = "Normalized namespace"
  value       = module.label.namespace
}

versions.tf

versions.tf 文件定义了项目所需的 Terraform 版本。

示例代码：

terraform {
  required_version = ">= 0.12"
}

通过以上介绍，您可以更好地理解和使用 terraform-terraform-label 项目。

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