Использование Object Storage для работы с файлами состояния

После создания ресурсов Terraform создает файл с расширением .tfstate, в котором текущее состояние ресурсов описано в формате JSON. Он называется файлом состояния (англ. state file).

Если вы измените описание ресурсов, а затем выполните команду terraform plan, Terraform перечитает этот файл, сравнит желаемое состояние ресурсов с фактическим и выведет список нужных изменений. При выполнении команды terraform apply ресурсы, у которых желаемое состояние отличается от фактического, будут изменены. Ресурсы, которые фактически существуют в проекте, но отсутствуют в описании, будут удалены.

Чтобы организовать совместную работу, избежать конфликтов при изменении ресурсов и обеспечить интеграцию с CI/CD, файлы состояния рекомендуется помещать в удаленные хранилища. Файлы состояния можно получать из удаленного хранилища и выполнять на их основе операции с ресурсами.

Чтобы настроить хранение файлов состояний в Object Storage и выполнять с их помощью операции с ресурсами:

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

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

2. В веб-консоли выберите нужный проект или создайте новый.

3. Создайте бакет для хранения файлов состояния Terraform в сервисе Object Storage.

4. Создайте сервисный аккаунт и назначьте ему роль editor или выше на проект.

5. Создайте директорию для хранения конфигурационных файлов Terraform. Например, terraform-config:

   1
   mkdir terraform-config

1. Создайте авторизованный ключ для сервисного аккаунта.
2. Скачайте и сохраните файл с авторизованным ключом.

1. Создайте файл ~/.terraformrc и укажите в нем параметры для установки провайдера:

   1
   provider_installation {
   2
     network_mirror {
   3
       url = "https://storage.mwsapis.ru/mws-terraform/",
   4
       include = ["registry.terraform.io/mws-cloud/*"]
   5
     }
   6
   
   7
     direct {
   8
       exclude = ["registry.terraform.io/mws-cloud/*"]
   9
     }
   10
   }

2. Создайте файл provider.tf и добавьте в него блок с настройками провайдера:

   1
   terraform {
   2
     required_providers {
   3
       mws = {
   4
         source = "mws-cloud/mws"
   5
       }
   6
     }
   7
     required_version = ">= 1.11"
   8
   }
   9
   
   10
   provider "mws" {
   11
     service_account_authorized_key_path = "<путь к файлу с авторизованным ключом>"
   12
     project = "my-project"     # имя проекта
   13
     zone    = "ru-central1-a"  # зона доступности
   14
   }

1. Создайте HMAC-ключ для сервисного аккаунта, который будет использоваться для работы с Terraform.

2. Создайте файл backend.hcl и добавьте в него обе части HMAC-ключа — Access key и Secret key:

   1
   access_key = "<Access key из HMAC-ключа>"
   2
   secret_key = "<Secret key из HMAC-ключа>"

3. Создайте файл backend.tf и добавьте в него блок с настройками бэкенда:

   1
   terraform {
   2
     backend "s3" {
   3
       bucket = "<имя бакета для хранения файлов состояния>"
   4
       key    = "<имя файла состояния>"
   5
       region = "ru-central1"
   6
   
   7
       endpoints = {
   8
         s3 = "https://storage.mwsapis.ru"
   9
       }
   10
   
   11
       skip_region_validation      = true
   12
       skip_credentials_validation = true
   13
       skip_metadata_api_check     = true
   14
       skip_requesting_account_id  = true
   15
       use_path_style              = true
   16
   
   17
       use_dualstack_endpoint       = false
   18
       use_fips_endpoint            = false
   19
     }
   20
   }

4. Инициализируйте Terraform:

   1
   terraform init -backend-config=backend.hcl

   Эта команда загрузит провайдер и установит соединение с Object Storage, где будут храниться файлы состояния.

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

• сеть с именем example-network;
• подсеть с именем example-subnet и CIDR 192.168.0.0/16;
• виртуальная машина с именем example-vm, с двумя ядрами vCPU, 4ГБ RAM, диском размером в 10 ГБ и ОС Ubuntu 24.04. Она получит внутренний IP-адрес из подсети example-subnet.

Чтобы создать виртуальную машину:

1. Добавьте в файл main.tf содержимое из примера ниже.

   Пример конфигурационного файла

   1
   resource "mws_vpc_network" "network" {
   2
     network = "example-network"
   3
     internet_access = true
   4
      mtu             = 1500
   5
   }
   6
   
   7
   resource "mws_vpc_subnet" "subnet" {
   8
     subnet     = "example-subnet"
   9
     network    = mws_vpc_network.network.network
   10
     cidr       = "192.168.0.0/16"
   11
   }
   12
   
   13
   data "mws_compute_image" "image" {
   14
     image   = "mws-ubuntu-2404-lts-v20250529"
   15
     project = "mws-ubuntu"
   16
   }
   17
   
   18
   resource "mws_vpc_address" "vm_primary_network_interface_address" {
   19
     network = mws_vpc_network.network.network
   20
     subnet  = mws_vpc_subnet.subnet.metadata.id
   21
     address = "example-vm-primary-network-interface-address"
   22
   }
   23
   
   24
   resource "mws_vpc_external_address" "vm_external_address" {
   25
     external_address = "example-vm-external-address"
   26
   }
   27
   
   28
   resource "mws_compute_disk" "disk" {
   29
     disk      = "example-disk"
   30
     disk_type = "diskTypes/nbs-pl2"
   31
     iops      = 1000
   32
     size      = "10GB"
   33
     source = {
   34
       image = data.mws_compute_image.image.metadata.id
   35
     }
   36
   }
   37
   
   38
   resource "mws_compute_virtual_machine" "vm" {
   39
     virtual_machine = "example-vm"
   40
     vm_type         = "vmTypes/gen-2-8"
   41
   
   42
     hardware = {
   43
       power                     = "ON"
   44
       graceful_shutdown_timeout = "1m 30s"
   45
     }
   46
   
   47
     os = {
   48
       hostname     = "example"
   49
       local_domain = "vm"
   50
   
   51
       metadata = {
   52
         attributes = {
   53
           user-data = <cкрипт cloud-init>
   54
   
   55
         }
   56
       }
   57
     }
   58
   
   59
     storage = {
   60
       disks = [
   61
         {
   62
           name = "boot"
   63
           boot = true
   64
           disk = {
   65
             ref = mws_compute_disk.disk.metadata.id
   66
           }
   67
         }
   68
       ]
   69
     }
   70
   
   71
     network = {
   72
       network_interfaces = [
   73
         {
   74
           name    = "example-vm-network-interface-primary"
   75
           primary = true
   76
           addresses = [
   77
             {
   78
               address = {
   79
                 ref = mws_vpc_address.vm_primary_network_interface_address.metadata.id
   80
               }
   81
               one_to_one_nat = {
   82
                 external = {
   83
                   address = {
   84
                     ref = mws_vpc_external_address.vm_external_address.metadata.id
   85
                   }
   86
                 }
   87
               }
   88
             }
   89
           ]
   90
         }
   91
       ]
   92
     }
   93
   }
   94
   
   95
   output "network_id" {
   96
     value       = mws_vpc_network.network.network
   97
     description = "Network ID"
   98
   }
   99
   
   100
   output "subnet_id" {
   101
     value       = mws_vpc_subnet.subnet.id
   102
     description = "Subnet ID"
   103
   }
   104
   
   105
   output "internal_ip_id" {
   106
     value       = mws_vpc_address.vm_primary_network_interface_address.id
   107
     description = "Internal IP address ID"
   108
   }
   109
   
   110
   output "external_ip_id" {
   111
     value       = mws_vpc_external_address.vm_external_address.id
   112
     description = "External IP address ID"
   113
   }

2. Проверьте файл main.tf на наличие синтаксических ошибок:

   1
     terraform validate

   Если ошибок нет, вы получите следующее сообщение:

   1
   Success! The configuration is valid.

3. Выполните команду:

   1
   terraform plan

   Terraform проверит конфигурационные файлы, сопоставит описание желаемого состояния облачной инфраструктуры с фактическим и укажет, какие операции с ресурсами будут выполнены.

1. Выполните команду:

   1
   terraform apply

2. Подтвердите выполнение операций: введите слово yes и нажмите Enter.

   Во время создания ресурсов Terraform будет выводить краткие сообщения о выполняемых операциях. Проверить, что ресурсы созданы и настроены корректно, можно в веб-консоли.

1. В веб-консоли в списке сервисов выберите Object Storage.
2. Нажмите на имя бакета, который вы создали ранее для хранения файлов состояния Terraform.
3. Убедитесь, что в бакете появился файл с расширением *.tfstate.

Файлы состояния можно запрашивать из бэкенда и использовать при создании ресурсов. В примере ниже показано, как запросить состояние и создать еще одну виртуальную машину в подсети, созданной на предыдущем шаге.

Чтобы получить состояние и создать еще одну виртуальную машину:

1. Создайте новую директорию для конфигураций и перейдите в нее:

   1
   mkdir remote-state
   2
   cd remote-state

2. Скопируйте в нее файл provider.tf из директории terraform-config, созданной ранее:

   1
   cp ../terraform-config/provider.tf $(pwd)

3. Инициализируйте Terraform:

   1
   terraform init

4. Создайте файл example.tf и добавьте конфигурацию из примера ниже. На базе этой конфигурации Terraform выполнит следующие действия:

   • получит файл состояния из Object Storage;

   • получит из файла состояния информацию о сети и подсети, где нужно создать виртуальную машину;

   • создаст виртуальную машину с именем example-vm2, с двумя ядрами vCPU, 4ГБ RAM, диском размером в 10 ГБ и ОС Ubuntu 24.04. Она получит внутренний IP-адрес из подсети example-subnet.

     Пример конфигурации

     1
     data "terraform_remote_state" "vpc" {
     2
       backend = "s3"
     3
     
     4
       config = {
     5
         bucket                      = "my-terraform-states"
     6
         key                         = "terraform.tfstate"
     7
         region                      = "ru-central1"
     8
     
     9
         endpoints = {
     10
           s3 = "https://storage.mwsapis.ru"
     11
         }
     12
         access_key = "<Access key из HMAC-ключа>"
     13
         secret_key = "<Secret key из HMAC-ключа>"
     14
         skip_region_validation      = true
     15
         skip_credentials_validation = true
     16
         skip_metadata_api_check     = true
     17
         skip_requesting_account_id  = true
     18
     
     19
         use_path_style            = true
     20
       }
     21
     }
     22
     
     23
     data "mws_compute_image" "image" {
     24
       image   = "mws-ubuntu-2204-lts-v20250529"
     25
       project = "mws-ubuntu"
     26
     }
     27
     
     28
     resource "mws_vpc_address" "vm2_primary_network_interface_address" {
     29
       # Получаем значения из remote state
     30
       network = data.terraform_remote_state.vpc.outputs.network_id
     31
       subnet  = data.terraform_remote_state.vpc.outputs.subnet_id
     32
       address = "example-vm2-primary-network-interface-address"
     33
     }
     34
     
     35
     resource "mws_vpc_external_address" "vm2_external_address" {
     36
       external_address = "example-vm2-external-address"
     37
     }
     38
     
     39
     resource "mws_compute_disk" "disk2" {
     40
       disk      = "example-disk2"
     41
       disk_type = "diskTypes/nbs-pl2"
     42
       iops      = 1000
     43
       size      = "10GB"
     44
       source = {
     45
         image = data.mws_compute_image.image.metadata.id
     46
       }
     47
     }
     48
     
     49
     resource "mws_compute_virtual_machine" "vm2" {
     50
       virtual_machine = "example-vm2"
     51
       vm_type         = "vmTypes/gen-2-8"
     52
     
     53
       hardware = {
     54
         power                     = "ON"
     55
         graceful_shutdown_timeout = "1m 30s"
     56
       }
     57
     
     58
       os = {
     59
         hostname     = "example2"
     60
         local_domain = "vm"
     61
     
     62
         metadata = {
     63
           attributes = {
     64
             user-data = "<скрипт cloud-init>"
     65
           }
     66
         }
     67
       }
     68
     
     69
       storage = {
     70
         disks = [
     71
           {
     72
             name = "boot"
     73
             boot = true
     74
             disk = {
     75
               ref = mws_compute_disk.disk2.metadata.id
     76
             }
     77
           }
     78
         ]
     79
       }
     80
     
     81
       network = {
     82
         network_interfaces = [
     83
           {
     84
             name    = "example-vm2-network-interface-primary"
     85
             primary = true
     86
             addresses = [
     87
               {
     88
                 address = {
     89
                   ref = mws_vpc_address.vm2_primary_network_interface_address.metadata.id
     90
                 }
     91
                 one_to_one_nat = {
     92
                   external = {
     93
                     address = {
     94
                       ref = mws_vpc_external_address.vm2_external_address.metadata.id
     95
                     }
     96
                   }
     97
                 }
     98
               }
     99
             ]
     100
           }
     101
         ]
     102
       }
     103
     }

5. Проверьте файл example.tf на наличие синтаксических ошибок:

   1
   terraform validate

   Если ошибок нет, вы получите следующее сообщение:

   1
   Success! The configuration is valid.

6. Выполните команду:

   1
   terraform plan

   Terraform проверит конфигурационные файлы, сопоставит описание желаемого состояния облачной инфраструктуры с фактическим и укажет, какие операции с ресурсами будут выполнены.

7. Создайте вторую виртуальную машину:

   1
   terraform apply

8. Убедитесь, что в созданной ранее подсети появилась виртуальная машина с именем example-vm2.

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

Чтобы удалить ресурсы:

1. Выполните команду:

   1
   terraform destroy

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