Terraform Example Module 使用教程

Terraform Example Module 使用教程

terraform-example-moduleExample Terraform Module Scaffolding项目地址:https://gitcode.com/gh_mirrors/te/terraform-example-module

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

terraform-example-module/
├── README.md
├── main.tf
├── variables.tf
├── outputs.tf
├── examples/
│   ├── example1/
│   │   ├── main.tf
│   │   ├── variables.tf
│   │   └── outputs.tf
│   └── example2/
│       ├── main.tf
│       ├── variables.tf
│       └── outputs.tf
└── tests/
    └── test_module.tf

目录结构介绍

• README.md: 项目说明文件，包含项目的概述、使用方法和示例。
• main.tf: 主配置文件，定义了模块的主要资源和逻辑。
• variables.tf: 变量定义文件，包含模块的输入变量。
• outputs.tf: 输出定义文件，包含模块的输出变量。
• examples/: 示例目录，包含多个示例配置，展示了如何使用该模块。
  • example1/: 第一个示例，包含一个完整的配置示例。
  • example2/: 第二个示例，包含另一个完整的配置示例。
• tests/: 测试目录，包含模块的测试配置。

2. 项目的启动文件介绍

main.tf

main.tf 是 Terraform 模块的主配置文件，定义了模块的主要资源和逻辑。以下是一个简单的示例：

provider "aws" {
  region = var.region
}

resource "aws_instance" "example" {
  ami           = var.ami
  instance_type = var.instance_type
}

文件介绍

• provider "aws": 定义了 AWS 作为 Terraform 的提供者，并指定了区域。
• resource "aws_instance" "example": 定义了一个 AWS EC2 实例资源，使用了模块的输入变量 ami 和 instance_type。

3. 项目的配置文件介绍

variables.tf

variables.tf 文件定义了模块的输入变量，允许用户在调用模块时传入自定义值。以下是一个简单的示例：

variable "region" {
  description = "The AWS region to deploy the instance"
  type        = string
  default     = "us-west-2"
}

variable "ami" {
  description = "The AMI ID to use for the instance"
  type        = string
  default     = "ami-0c55b159cbfafe1f0"
}

variable "instance_type" {
  description = "The instance type to use for the instance"
  type        = string
  default     = "t2.micro"
}

文件介绍

• variable "region": 定义了一个名为 region 的变量，类型为字符串，默认值为 us-west-2。
• variable "ami": 定义了一个名为 ami 的变量，类型为字符串，默认值为 ami-0c55b159cbfafe1f0。
• variable "instance_type": 定义了一个名为 instance_type 的变量，类型为字符串，默认值为 t2.micro。

outputs.tf

outputs.tf 文件定义了模块的输出变量，允许用户在调用模块后获取特定的输出值。以下是一个简单的示例：

output "instance_id" {
  description = "The ID of the created instance"
  value       = aws_instance.example.id
}

output "public_ip" {
  description = "The public IP address of the created instance"
  value       = aws_instance.example.public_ip
}

文件介绍

• output "instance_id": 定义了一个名为 instance_id 的输出变量，值为创建的实例的 ID。
• output "public_ip": 定义了一个名为 public_ip 的输出变量，值为创建的实例的公网 IP 地址。

通过以上介绍，您可以了解如何使用 terraform-example-module 模块，并根据需要进行配置和扩展。

terraform-example-moduleExample Terraform Module Scaffolding项目地址:https://gitcode.com/gh_mirrors/te/terraform-example-module