本页内容

  • 本教程涵盖哪些内容?
  • 前置检查
  • 使用 Terraform Registry 中的模块
  • 探索 Terraform Registry
  • 使用模块启动 EC2 实例
  • 结语…

Terraform Registry 是一个可以查找各类 provider 和模块(可复用的 Terraform 配置)、并将它们与 Terraform 配合使用的地方。其贡献者包括 HashiCorp、第三方供应商以及 Terraform 社区。该 Registry 旨在提供用于处理各种基础设施 API 的插件,提供现成的模块以便快速构建常用的基础设施组件,并展示如何编写高效的 Terraform 代码。

本教程涵盖哪些内容?

在本教程中,我们将了解如何使用 Terraform Registry 中的模块。我们会通过在 AWS 上创建 EC2 实例的示例来进行演示。

前置检查

本教程需要满足以下先决条件:

  • 本地系统需已安装 Terraform。
  • 具备 Terraform 模块的基础知识。
  • 拥有 AWS 账户。

使用 Terraform Registry 中的模块

不同 provider 的模块由 Terraform Registry 维护。可以从 Registry 页面搜索模块。另需注意,进行搜索时,搜索结果中只列出已验证的模块。这些模块由 HashiCorp 检查,以确认其兼容性和稳定性。通过搜索筛选选项也可以列出未验证的模块。

在 Terraform Registry 中发布的模块,可以在典型的 Terraform 代码中使用以下语法来引用:

<NAMESPACE>/<Name of module>/<Name of Provider>

例如,请看下面这个来自 Terraform Registry 的模块用法:

module "vpc" {
  source = "terraform-aws-modules/vpc/aws"
}

上面的示例使用了 Terraform Registry 中面向 AWS 的 VPC 模块。运行 ‘terraform init’ 命令会检索并保存 Terraform 代码所引用的模块。

Terraform Registry 支持同时使用公共模块和私有模块。公共的 Terraform Registry 开放地允许发布和使用 provider 与模块。私有模块则可以通过私有 registry 来发布。

探索 Terraform Registry

模块页面会显示该模块的一些简要信息,例如模块描述、发布日期、源代码 URL、下载统计等。你还可以在这里看到 Readme、Inputs、Outputs、Dependency 和 Resources 等各个选项卡。我们可以参考这些部分来选择要在代码中传入的变量。

这里还有演示模块用法的示例,例如本指南就使用了一个用于创建 EC2 实例的模块。在深入这个示例之前,我们先来看看该模块的源代码。打开源代码链接。在 GitHub 页面上,可以看到该模块的一些文件夹和文件。目前我们只关注三个 Terraform 文件:main.tf、outputs.tf 和 variables.tf。main.tf 文件包含许多描述 EC2 实例的代码行。同样,variables.tf 和 outputs.tf 中也有若干输入值和输出值的声明。

使用模块启动 EC2 实例

现在让我们看看如何使用 Terraform Registry 中的模块。我们将使用 ‘terraform-aws-modules’ 中的一个模块来创建 EC2 实例。

第 1 步。打开 Terraform Registry 网页并搜索用于 EC2 的 aws 模块:

第 2 步。点击如上图所示的 ‘terraform-aws-modules/ec2-instance’ 搜索结果。在本例中,该模块用于启动一个 AWS EC2 实例。

Terraform Registry 模块使用与 EC2 实例创建完整指南

现在,请看下面这个我们在本地系统上为使用该模块而创建的配置文件。在这个文件中,我们通过 ‘source’ 参数引入了上述模块。我们只使用了实际模块中的少数几个声明,如下所述:

$ nano myinstance.tf
provider "aws" {
  region = "us-east-1"
}
module "ec2_instance" {
  source  = "terraform-aws-modules/ec2-instance/aws"
  version = "~> 3.0"
  name = "single-instance"
  ami                    = "ami-0022f774911c1d690"
  instance_type          = "t2.micro"
 availability_zone    ="us-east-1a"
  key_name               = "Your-Key-pair-name"
  monitoring             = true
  vpc_security_group_ids = ["Security-Group-ID"]
 putin_khuylo    = true
  tags = {
    Terraform   = "true"
    Environment = "dev"
  }
}

在这个配置中,有两个参数:source 和 version。

  • source:使用 Terraform 模块时需要使用该参数。在上述 ‘example’ 配置中,Terraform 会在 Terraform Registry 中查找给定的带引号的模块地址。这里也可以使用本地模块、URL 和其他来源。
  • version:这是一个可选参数,但建议在使用 Terraform 模块时加上它。加上后,对于受支持的来源,它会加载指定版本的 Terraform 模块。如果不使用,则会加载最新的可用模块版本。

首先,初始化包含本地文件 ‘myinstance.tf’ 的目录。运行以下命令:

Terraform Registry 模块使用与 EC2 实例创建完整指南

现在运行 ‘terraform plan’,或者使用 ‘terraform apply’ 命令直接应用这些更改:

$ terraform apply

出现提示时输入 ‘yes’。这将开始应用更改的过程。

这一次我们不需要显式创建 variables.tf 或 output.tf 文件,而只需引用我们想要使用的仓库变量。从管理控制台打开 EC2 仪表板,检查实例是否已创建:

Terraform Registry 模块使用与 EC2 实例创建完整指南

结语…

在本指南中,我们了解了如何使用 Terraform Registry 中的模块。你可以用同样的方式,尝试使用 Terraform 模块来配置一个 VPC。