Module 让 Terraform 使用更简单

众所周知，Terraform 是一个开源的自动化的资源编排工具，支持多家云服务提供商。阿里云作为第三大云服务提供商，terraform-alicloud-provider 已经支持了超过 140 个 Resource 和 100 个 Data Source，覆盖30多个服务和产品，吸引了越来越多的开发者加入到阿里云Terraform生态的建设中。

随着 Resource 和 DataSource 的不断增加和完善，业务架构的不断发展，Terraform 模板编写的成本和复杂度也在不断的增加。如何让Terraform 模板更加简单和重用，就是本文所要解决的问题。

本文将通过一个典型的负载均衡架构，向大家介绍如何使用 Module 简化 Terraform 的模板。

如图所示，这个架构中，包含 ECS 实例，SLB 实例，RDS 实例，OSS 等资源和服务，同时所有的 ECS，RDS 和部分 SLB 在一个 VPC 网络环境中。

将所有Resource放在一个模板中进行统一管理

面对这样的一个架构，模板可以有多种写法。通常的写法是将架构中涉及到的所有资源写到一个模板中，并通过参数和关系型 resource 将这些资源关联起来，如下所示：

// Images data source for image_id
data "alicloud_images" "default" {
  ...
}
// Instance_types data source for instance_type
data "alicloud_instance_types" "default" {
  ...
}
// Zones data source for availability_zone
data "alicloud_zones" "default" {
  ...
}
// A new VPC
resource "alicloud_vpc" "vpc" {
    name = "default"
    ...
}
// Two new VSwitches
resource "alicloud_vswitch" "vswitches" {
  count             = 2
  vpc_id            = "${alicloud_vpc.vpc.id}"
  ...
}
// A new Security Group
resource "alicloud_security_group" "default" {
  vpc_id = "alicloud_vpc.vpc.id}"
  ...
}
// Two Web Tier instances
resource "alicloud_instance" "web" {
  count           = 2
  image_id        = "data.alicloud_images.default.images.0.id"
  instance_type   = "data.alicloud_instance_types.default.instance_types.0.id"
  security_groups = ["${ alicloud_security_group.default.id }"]
  vswitch_id = "${element(alicloud_vswitch.vswitches.*.id, count.index)}"
  ...
}
// Two Application Tier instances
resource "alicloud_instance" "app" {
  count           = 2
  image_id        = "${data.alicloud_images.default.images.0.id}"
  instance_type   = "${data.alicloud_instance_types.default.instance_types.0.id}"
  security_groups = ["${alicloud_security_group.default.id}"]
  vswitch_id = "${element(alicloud_vswitch.vswitches.*.id, count.index)}"
  ...
}
// A SLB Instance for intranet
resource "alicloud_slb" "intranet" {
  internet = false
  vswitch_id = "${alicloud_vswitch.vswitches.0.id}"
  ...
}
// Attach Ecs instances
resource "alicloud_slb_attachment" "intranet" {
  load_balancer_id = "${alicloud_slb.intranet.id}"
  instance_ids     = ["${alicloud_instance.web.*.id}", "${alicloud_instance.app.*.id}"]
}
// SLB Instance Resource for internet
resource "alicloud_slb" "internet" {
  internet  = true
  ...
}
// Attach Ecs instances
resource "alicloud_slb_attachment" "internet" {
  load_balancer_id = "${alicloud_slb.internet.id}"
  instance_ids     = ["${alicloud_instance.web.*.id}"]
}
// Two RDS Instance
resource "alicloud_db_instance" "default" {
  count            = 2
  vswitch_id = "${element(alicloud_vswitch.vswitches.*.id, count.index)}"
  ...
}
// Add a account for each RDS instance
resource "alicloud_db_account" "default" {
  count       = 2
  instance_id = "${element(alicloud_db_instance.default.*.id, count.index)}"
  ...
}
// Add a database for each RDS instance
resource "alicloud_db_database" "default" {
  count       = 2
  instance_id = "${element(alicloud_db_instance.default.*.id, count.index)}"
  ...
}
// A OSS Bucket
resource "alicloud_oss_bucket" "default" {
  ...
}

这样写的好处是，所有资源都在一个模板中管理，编写时可以很清楚了解资源之间的引用关系；但是，当资源不断增加时，扩展非常不灵活，资源间关系越复杂，模板越难以维护。

分类管理，目录作为单元化资源

从架构图和上文模板中不难看出，并不是所有的Resource都有直接关联关系，比如VPC只和VSwitch和SecurityGroup有关，与其他资源的创建无直接关联关系。因此，为了使整个架构的逻辑可以更加清楚的展示在模板中，我们可以考虑，对资源进行分类，将每一类资源用一个单独的目录进行管理，最后用一个模板来管理所有的目录，进而完成对所有资源及资源关系的串联，如下所示：

├── main.tf
├── variables.tf
├── outputs.tf
├── modules/
│   ├── vpc/
│   │   ├── variables.tf
│   │   ├── main.tf
│   │   ├── outputs.tf
│   ├── slb/
│   │   ├── variables.tf
│   │   ├── main.tf
│   │   ├── outputs.tf
│   ├── ecs/
│   ├── rds/
│   ├── oss/

将该架构中的资源分为网络（VPC），负载均衡（SLB），计算（ECS），数据库（RDS）和存储（OSS）这几类，然后将上文模板中的资源分别在对应的目录中予以实现。

接下来，用统一的模版main.tf将这些目录关联起来，如下所示：

// VPC module
module "vpc" {
  source = "./modules/vpc"
  name = "new-netwtok"
  ...
}
// Web Tier module
module "web" {
  source = "./modules/ecs"
  instance_count = 2
  vswitch_ids = "${module.vpc.this_vswitch_ids}"
  ...
}
// Web App module
module "app" {
  source = "./modules/ecs"
  instance_count = 2
  vswitch_ids = "${module.vpc.this_vswitch_ids}"
  ...
}
// SLB module(intranet)
module "slb" {
  source = "./modules/slb"
  name = "slb-internal"
  vswitch_id = "${module.vpc.this_vswitch_ids.0.id}"
  instances = "${concat(module.web.instance_ids, module.app.instance_ids,)}"
  ...
}
// SLB module(internet)
module "slb" {
  source = "./modules/slb"
  name = "slb-external"
  internet = true
  instances = "${module.web.instance_ids}"
  ...
}
// RDS module
module "oss" {
  source = "./modules/rds"
  name = "new-rds"
  ...
}
// OSS module
module "oss" {
  source = "./modules/oss"
  name = "new-bucket"
  ...
}

可以看出，main.tf中资源的结构更加清楚，更加接近于架构图。

同时，大家已经注意到了，main.tf引入了一个 module，通过module将资源目录串联起来。

什么是Module

Module 是 Terraform 为了管理单元化资源而设计的，是子节点，子资源，子架构模板的整合和抽象。正如本文架构中提到的，在实际复杂的技术架构中，涉及到的资源多种多样，资源与资源之间的关系错综复杂，资源模版的编写，扩展，维护等多个问题的成本都会不断增加。将多种可以复用的资源定义为一个module，通过对 module 的管理简化模板的架构，降低模板管理的复杂度，这就是module的作用。

除此之外，对开发者和用户而言，只需关心 module 的 input 参数即可，无需关心module中资源的定义，参数，语法等细节问题，抽出更多的时间和精力投入到架构设计和资源关系整合上。

开源Module，使其更完善，更分享，更便捷

上文中，虽然已经实现了module，但是这个module只能在自己本地机器上实现，无法实现与他人的实时分享，无法实现团队内部的及时共享。

Terraform 提供了 Module 的注册地址，将自己的module上传到Github，并注册为一个Terraform Module后，即可将远端的Module应用到我们自己的模板中。

利用开源 module，我们可对上文中的模板进行完善：

// VPC module
module "vpc" {
  source = "alibaba/vpc/alicloud"
  ...
}
// Web Tier module
module "web" {
  source = "alibaba/ecs-instance/alicloud"
  ...
}
// Web App module
module "app" {
  source = "alibaba/ecs-instance/alicloud"
  ...
}
// SLB module(intranet)
module "slb-intranet" {
  source = "alibaba/slb/alicloud"
  ...
}
// SLB module(internet)
module "slb-internet" {
  source = "alibaba/slb/alicloud"
  ...
}
// OSS module
module "rds" {
  source = "terraform-alicloud-modules/rds/alicloud"
  ...
}
// OSS module
module "oss" {
  source = "terraform-alicloud-modules/oss/alicloud"
  ...
}

Module 让资源模板架构更清楚，模板管理更简单；开源 Module 让资源模板更便捷，更分享。除此之外，开源 Module 可实现对模板的版本控制，基于不同的版本，实现不同架构不断升级的控制和完善。

欢迎加入 Terraform AliCloud Modules

目前我们已经在在 Terraform Module 上发布了一些常用的 Module，但这些 Module 远远无法满足大家多种多样的技术架构和复杂的应用场景，非常欢迎大家可以将自己的模板Module注册到官方 Module 上，借助社区的力量，不断完善自己模板，丰富我们的社区。