Использование переменных

В Terraform вы можете хранить информацию, необходимую для создания инфраструктуры, в переменных. Значения переменных можно указывать в отдельных файлах и затем ссылаться на эти файлы в описаниях ресурсов.

Благодаря переменным вы можете:

настраивать ресурсы без изменения кода;
настраивать разные окружения с индивидуальными параметрами (например, одни параметры для тестовой среды, другие — для продуктивной);
безопасно хранить секреты.

Объявление переменных

Переменные в Terraform можно объявлять:

в файле main.tf в блоке variables (см. пример для быстрого старта) — такой способ подходит для небольших тестовых проектов;
в отдельном файле с переменными — предпочтительный способ для крупных проектов.

При объявлении переменной указываются:

имя;
тип;
краткое описание;

(опционально) значение по умолчанию.

1
variable "vm_name" {
2
  type        = string
3
  description = "Virtual machine name"
4
}
5

6
variable "network_name" {
7
  type        = string
8
  description = "Network name"
9
}
10

11
variable "subnet_name" {
12
  type        = string
13
  description = "Subnet name"
14
}
15

16
variable "allowed_ports" {
17
  type        = list(number)
18
  description = "List of allowed ports"
19
  default     = [80, 443, 22]
20
}

Присвоение значений переменным

Через файлы
Через переменные окружения
Через командную строку

Вы можете указать значения переменных в файлах с расширением .tfvars, например:

1
vm_name      = "my-vm"
2
network_name = "my-network"
3
subnet_name  = "my-subnet"
4
disk_name    = "my-disk"

Вы можете хранить разные наборы переменных в разных файлах: например, test.tf — для тестового окружения, а prod.tf — для продуктивного.

Значения переменных, сохраненные в файле с именем terraform.tfvars, при выполнении команд Terraform подгружаются автоматически. Любые другие файлы нужно указывать в командах явно, например:

1
terraform apply -var-file="prod.tfvars"

В файлах с переменными можно хранить секреты: пароли, ключи доступа, токены и т.п. Это помогает:

ограничить доступ к секретам и избежать компрометации;
менять секреты без изменения кода.

В описаниях соответствующих переменных используйте параметр sensitive = true, например:

1
variable "db_password" {
2
  type      = string
3
  sensitive = true
4
}

Благодаря этому значение переменных с секретами не будет отображаться в логах и выводах команд.

Вы можете указать значения переменных перед запуском Terraform в переменных окружения c именем вида TF_VAR_<имя переменной>, например:

1
export TF_VAR_vm_name="my-vm"
2
terraform plan

Этот способ хорошо подходит для передачи секретов: они хранятся только в памяти текущей сессии и не могут попасть в систему контроля версий.

Вы можете указать значения переменных непосредственно в команде Terraform c помощью опции -var, например:

1
terraform plan -var="vm_name=my-vm," -var="vm_count=2"

Этот способ имеет наивысший приоритет: если у вас значения переменных хранятся в отдельном файле, Terraform будет использовать не их, а значения, переданные в опции -var. Поэтому он подходит только для тестирования или отладки.

Синтаксис при обращении к переменным

В описании ресурсов для обращения к переменным используйте синтаксис var.<имя переменной>, например:

1
resource "mws_vpc_network" "network" {
2
  network = var.network_name
3
}
4

5
resource "mws_vpc_subnet" "subnet" {
6
  subnet  = var.subnet_name
7
  network = mws_vpc_network.network.network
8
  cidr    = "192.168.0.0/16"
9
}
10

11
resource "mws_vpc_address" "vm_primary_network_interface_address" {
12
  network = mws_vpc_network.network.network
13
  subnet  = mws_vpc_subnet.subnet.metadata.id
14
  address = "${var.vm_name}-primary-network-interface-address"
15
}