Начало работы с Terraform

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробная информация о ресурсах провайдера в документации на сайте Terraform или в зеркале.

Чтобы создать первую инфраструктуру в Yandex Cloud с помощью Terraform:

1. Подготовьте облако к работе.
2. Установите Terraform.
3. Получите данные для аутентификации.
4. Создайте файл конфигурации Terraform.
5. Настройте провайдер.
6. Подготовьте план инфраструктуры.
7. Проверьте и отформатируйте файлы конфигураций.
8. Создайте ресурсы.

Если ресурсы больше вам не нужны, удалите их.

Подготовьте облако к работеПодготовьте облако к работе

Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:

1. Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь.
2. На странице Yandex Cloud Billing убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его и привяжите к нему облако.

Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака.

Подробнее об облаках и каталогах.

Необходимые платные ресурсыНеобходимые платные ресурсы

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

• плата за постоянно запущенные виртуальные машины (тарифы Yandex Compute Cloud);
• плата за использование динамических публичных IP-адресов (тарифы Yandex Virtual Private Cloud).

Установите TerraformУстановите Terraform

Из зеркалаИз зеркала

Вы можете скачать дистрибутив Terraform для вашей платформы из зеркала. После загрузки добавьте путь к папке, в которой находится исполняемый файл, в переменную PATH:

export PATH=$PATH:/path/to/terraform

С сайта HashiCorpС сайта HashiCorp

Получите данные для аутентификацииПолучите данные для аутентификации

Для аутентификации в Yandex Cloud и управления инфраструктурой используйте Terraform от имени сервисного аккаунта или пользователя: аккаунта на Яндексе, федеративного аккаунта или локального пользователя.

provider "yandex" {
  zone             = "<зона_доступности_по_умолчанию>"
  endpoint         = "api.yandexcloud.kz:443"
  storage_endpoint = "https://storage.yandexcloud.kz"
}

provider "yandex" {
  zone             = "<зона_доступности_по_умолчанию>"
  endpoint         = "api.yandexcloud.kz:443"
  storage_endpoint = "https://storage.yandexcloud.kz"
}

Создайте файл конфигурации TerraformСоздайте файл конфигурации Terraform

1. Создайте новую директорию с произвольным названием, например cloud-terraform. В ней будут храниться конфигурационные файлы и сохраненные состояния Terraform и инфраструктуры.

   Важно

   Каждая конфигурация должна находиться в отдельной директории.

2. Создайте в новой директории конфигурационный файл с расширением .tf, например main.tf.

Настройте провайдерНастройте провайдер

1. Если раньше у вас был настроен провайдер из реестра HashiCorp, сохраните его настройки:

   Linux/macOS

   Windows

   mv ~/.terraformrc ~/.terraformrc.old
   

   Move-Item $env:APPDATA\terraform.rc $env:APPDATA\terraform.rc.old
   

2. Укажите источник, из которого будет устанавливаться провайдер.

   Linux/macOS

   Windows

   Откройте файл конфигурации Terraform CLI:

   nano ~/.terraformrc
   

   Примечание

   Файл .terraformrc должен располагаться в корне домашней папки пользователя, например, /home/user/ или /User/user/.

   Откройте файл конфигурации Terraform CLI terraform.rc в папке %APPDATA% вашего пользователя.

   Чтобы узнать абсолютный путь к папке %APPDATA%, выполните команду echo %APPDATA% для cmd или $env:APPDATA для PowerShell.

   Добавьте в него следующий блок:

   provider_installation {
     network_mirror {
       url = "https://terraform-mirror.yandexcloud.net/"
       include = ["registry.terraform.io/*/*"]
     }
     direct {
       exclude = ["registry.terraform.io/*/*"]
     }
   }
   

   Подробнее о настройках зеркал в документации.

3. В начале конфигурационного файла .tf добавьте следующие блоки:

   terraform {
     required_providers {
       yandex = {
         source = "yandex-cloud/yandex"
       }
     }
     required_version = ">= 0.13"
   }
   
   provider "yandex" {
     zone             = "<зона_доступности_по_умолчанию>"
     endpoint         = "api.yandexcloud.kz:443"
     storage_endpoint = "https://storage.yandexcloud.kz"
   }
   

   Где:

   • source — глобальный адрес источника провайдера.
   • required_version — минимальная версия Terraform, с которой совместим провайдер.
   • provider — название провайдера.
   • zone — зона доступности, в которой по умолчанию будут создаваться все облачные ресурсы.

4. Выполните команду terraform init в папке с конфигурационным файлом .tf. Эта команда инициализирует провайдеров, указанных в конфигурационных файлах, и позволяет работать с ресурсами и источниками данных провайдера.

Если провайдер не установился, создайте обращение в поддержку с именем и версией провайдера.

Если вы использовали файл .terraform.lock.hcl, перед инициализацией выполните команду terraform providers lock, указав адрес зеркала, откуда будет загружаться провайдер, и платформы, на которых будет использоваться конфигурация:

terraform providers lock -net-mirror=https://terraform-mirror.yandexcloud.net -platform=<название_платформы_1> -platform=<название_платформы_2> yandex-cloud/yandex

Где:

• -net-mirror — адрес зеркала, откуда будет загружаться провайдер.

• -platform — платформы, на которых будет использоваться конфигурация. Возможные значения:

  • windows_amd64 — 64-bit Windows.
  • linux_amd64 — 64-bit Linux.
  • darwin_arm64 — 64-bit macOS.

Если вы использовали модули Terraform, сначала выполните terraform init, затем удалите lock-файл, а затем выполните команду terraform providers lock.

Подробнее о команде terraform providers lock в документации Terraform.

Подготовьте план инфраструктурыПодготовьте план инфраструктуры

С помощью Terraform в Yandex Cloud можно создавать облачные ресурсы разных типов, например ВМ, диски и образы. Полный список ресурсов приведен в документации провайдера.

Для каждого ресурса укажите обязательные и необязательные параметры, которые определяют его свойства. Описания ресурсов составляют план инфраструктуры.

План включает две ВМ (terraform1 и terraform2), облачную сеть network1 и подсеть subnet1.

Имена ресурсов должны соответствовать следующим требованиям:

• длина — от 3 до 63 символов;
• может содержать строчные буквы латинского алфавита, цифры и дефисы;
• первый символ — буква, последний — не дефис.

ВМ будут различаться количеством ядер и объемом памяти: у terraform1 будет два ядра и 2 ГБ оперативной памяти, а у terraform2 — четыре ядра и 4 ГБ оперативной памяти. Обе ВМ автоматически получат публичные и внутренние IP-адреса из диапазона 192.168.10.0/24. Подсеть subnet1 находится в зоне доступности kz1-d и принадлежит сети network1. Для ВМ используйте образ Ubuntu.

В конфигурации ВМ укажите идентификатор образа загрузочного диска. Получите список доступных публичных образов с помощью команды CLI:

yc compute image list --folder-id standard-images

Для доступа к ВМ по SSH сгенерируйте пару SSH-ключей и укажите путь к публичной части ключа в параметре ssh-keys блока metadata.

Ниже приведены фрагменты конфигурации провайдера и одной ВМ для разных регионов. Полные конфигурации ресурсов приведены во вкладках Linux и Windows ниже.

terraform {
  required_providers {
    yandex = {
      source = "yandex-cloud/yandex"
    }
  }
}

provider "yandex" {
  zone             = "<зона_доступности_по_умолчанию>"
  endpoint         = "api.yandexcloud.kz:443"
  storage_endpoint = "https://storage.yandexcloud.kz"
}

resource "yandex_compute_instance" "vm-1" {
  name = "terraform1"
}

Создайте пользователейСоздайте пользователей

#ps1
# ^^^ 'ps1' is only for cloudbase-init, some sort of sha-bang in linux

# logging
Start-Transcript -Path "$ENV:SystemDrive\provision.txt" -IncludeInvocationHeader -Force
"Bootstrap script started" | Write-Host

# inserting value's from terraform
$MyUserName = "${ user_name }"
$MyPlainTextPassword = "${ user_pass }"
if (-not [string]::IsNullOrEmpty($MyUserName) -and -not [string]::IsNullOrEmpty($MyPlainTextPassword)) {
    "Create user" | Write-Host
    $MyPassword = $MyPlainTextPassword | ConvertTo-SecureString -AsPlainText -Force
    $MyUser = New-LocalUser -Name $MyUserName -Password $MyPassword -PasswordNeverExpires -AccountNeverExpires
    $MyUser | Add-LocalGroupMember -Group 'Administrators'
    $MyUser | Add-LocalGroupMember -Group 'Remote Management Users'
}

# inserting value's from terraform
$MyAdministratorPlainTextPassword = "${ admin_pass }"
if (-not [string]::IsNullOrEmpty($MyAdministratorPlainTextPassword)) {
    "Set local administrator password" | Write-Host
    $MyAdministratorPassword = $MyAdministratorPlainTextPassword | ConvertTo-SecureString -AsPlainText -Force
    # S-1-5-21domain-500 is a well-known SID for Administrator
    # https://docs.microsoft.com/en-us/troubleshoot/windows-server/identity/security-identifiers-in-windows
    $MyAdministrator = Get-LocalUser | Where-Object -Property "SID" -like "S-1-5-21-*-500"
    $MyAdministrator | Set-LocalUser -Password $MyAdministratorPassword
}

"Bootstrap script ended" | Write-Host

Проверьте и отформатируйте файлы конфигурацийПроверьте и отформатируйте файлы конфигураций

1. Проверьте конфигурацию командой:

   terraform validate
   

   Если конфигурация является допустимой, появится сообщение:

   Success! The configuration is valid.
   

2. Отформатируйте файлы конфигураций в текущем каталоге и подкаталогах:

   terraform fmt
   

   Команда выводит список отформатированных файлов, например:

   main.tf
   

Создайте ресурсыСоздайте ресурсы

1. После проверки конфигурации выполните команду:

   terraform plan
   

   Терминал выведет список ресурсов и их параметров. На этом этапе ресурсы не создаются. Если конфигурация содержит ошибки, Terraform укажет на них.

   Внимание

   Все созданные с помощью Terraform ресурсы тарифицируются. Внимательно проверьте план.

2. Чтобы создать ресурсы, выполните команду:

   terraform apply
   

3. Подтвердите создание ресурсов: введите в терминал слово yes и нажмите Enter.

   Terraform создаст ресурсы и выведет в терминале IP-адреса созданных виртуальных машин. Проверьте наличие ресурсов и их настройки в консоли управления.

Удалите созданные ресурсыУдалите созданные ресурсы

Чтобы удалить ресурсы, созданные с помощью Terraform:

1. Удалите из конфигурации блоки resource и module, относящиеся к этой инфраструктуре, а также источники данных и выходные значения output, которые на них ссылаются. Сохраните блоки terraform и provider.

2. Проверьте план удаления:

   terraform plan
   

   Внимание

   Terraform удалит ресурсы, для которых вы убрали описания из конфигурации: кластеры, сети, подсети, виртуальные машины и другие ресурсы.

   Проверьте список ресурсов, которые Terraform собирается удалить.

3. Примените изменения:

   terraform apply
   

4. Подтвердите удаление: введите yes и нажмите Enter.

Проверить удаление ресурсов можно в консоли управления.

Полезные ссылкиПолезные ссылки

• Загрузка состояний Terraform в Object Storage.
• Блокировка состояний Terraform с помощью Managed Service for YDB.
• Использование модулей Yandex Cloud в Terraform.
• Источники данных Terraform.
• IaC: Terraform — обучающий курс по управлению инфраструктурой в облаке с помощью Terraform.