《Terraform 101 从入门到实践》这本小册在南瓜慢说官方网站和GitHub两个地方同步更新,书中的示例代码也是放在GitHub上,方便大家参考查看。
介绍了Terraform一些比较基础的概念后,我们可以先了解一下Terraform的语法,也就是HCL的语法。
变量Variables
变量是实现代码复用的一种方式,同样的代码不同的变量往往会有不同的效果。而在Terraform里,有一个概念非常重要,就是变量都是从属于模块的。变量无法跨模块引用。即在模块A定义的变量X,无法在模块B中直接引用。但父模块的变量,可以作为子模块的入参;而子模块的输出变量可以被父模块获取。
变量类型
从语言角度
跟任何编程语言一样,变量都是有类型的,Terraform的变量类型从语言的角度可分为两大类:基本类型和组合类型,具体如下:
基本类型:
- 字符串string,如
"pkslow.com"
- 数字number,如
319
或5.11
- 布尔值bool,如
true
组合类型:
- 列表list(
),如 ["dev", "uat", "prod"]
- 集合set(
),如 set(...)
- 映射map(
),如 {name="Larry", age="18"}
- 对象object({name1=T1, name2=T2})
- 元组tuple([T1,T2,T3...])
如果不想指定某个类型,可以用any
来表示任意类型;或者不指定,默认为任意类型。
从功能角度
从功能角度来看,变量可以分为输入变量、输出变量和本地变量。
输入变量是模块接收外部变量的方式,它定义在variable
块中,如下:
variable "image_id" {
type = string
}
variable "availability_zone_names" {
type = list(string)
default = ["us-west-1a"]
}
variable "docker_ports" {
type = list(object({
internal = number
external = number
protocol = string
}))
default = [
{
internal = 8300
external = 8300
protocol = "tcp"
}
]
}
输出变量定义了一个模块对外返回的变量,通过output
块来定义,如下:
output "instance_ip_addr" {
value = aws_instance.server.private_ip
}
本地变量是模块内定义且可引用的临时变量,在locals
块中定义,如下:
locals {
service_name = "forum"
owner = "Community Team"
}
输入变量Input Variable
输入变量是定义在variable
块中的,它就像是函数的入参。
定义输入变量
定义variable
有很多可选属性:
- 类型type:指定变量是什么类型;如果没有指定,则可以是任意类型;
- 默认值default:变量的默认值,定义后可以不用提供变量的值,注意它的值的类型要与type对应上;
- 说明description:说明这个变量的作用和用途;
- 校验validation:提供校验逻辑来判断输入的变量是否合法;
- 敏感性sensitive:定义变量是否敏感,如果是则不会显示;默认为
false
; - 可空nullable:如果为true则可以为空,否则不能。默认为
true
。
所有属性都显性指定如下面例子所示:
variable "env" {
type = string
default = "dev"
description = "environment name"
sensitive = false
nullable = false
validation {
condition = contains(["dev", "uat", "prod"], var.env)
error_message = "The env must be one of dev/uat/prod."
}
}
这个变量名为env
,表示环境名,默认值为dev
,这个值必须为dev
、uat
和prod
中的其中一个。如果输出一个非法的值,会报错:
$ terraform plan -var="env=sit"
?
│ Error: Invalid value for variable
│
│ on input.tf line 1:
│ 1: variable "env" {
│
│ The env must be one of dev/uat/prod.
使用输入变量
只有定义了变量才可以使用,使用的方式是var.name
。比如这里定义了两个变量env
和random_string_length
:
variable "env" {
type = string
default = "dev"
}
variable "random_string_length" {
type = number
default = 10
}
则使用如下:
resource "random_string" "random" {
length = var.random_string_length
lower = true
special = false
}
locals {
instance_name = "${var.env}-${random_string.random.result}"
}
output "instance_name" {
value = local.instance_name
}
传入变量到根模块
要从外部传入变量到根模块,有多种方式,常见的有以下几种,按优先级从低到高:
-
环境变量
export TF_VAR_image_id=ami-abc123
-
terraform.tfvars
文件; -
terraform.tfvars.json
文件; -
*.auto.tfvars
或*.auto.tfvars.json
文件; -
命令行参数
-var
传入一个变量;命令行参数-var-file
传入一个变量的集合文件;
在实践中,最常用的还是通过命令行来传入参数,因为一般需要指定不同环境的特定变量,所以会把变量放到文件中,然后通过命令行指定特定环境的主文件:
$ terraform apply -var="env=uat"
$ terraform apply -var-file="prod.tfvars"
而prod.tfvars
的内容如下:
env = "prod"