Terraform: Основы
2026-02-26 15:07 Diff
https://ru.hexlet.io/courses/terraform-basics/lessons/terraform-modules/theory_unit

При описании инфраструктуры в Terraform для различных проектов можно заметить, что определенные комбинации ресурсов часто повторяются. Например, когда мы создаем кластер баз данных, мы обычно создаем вместе с ним и базу пользователей. А когда мы создаем несколько серверов, мы часто хотим объединить их в одну виртуальную сеть.

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

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

Какую проблему решают модули

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

Так модуль с хорошей документацией экономит время, которое мы тратим на изучение ресурсов и зависимостей конкретного провайдера. Модуль помогает быстрее добиться нужного результата.

Возьмем для примера модуль terraform-yc-postgresql. Он описывает создание в облаке Yandex кластера БД PostgreSQL, а также помещение в него баз данных и пользователей.

Ранее мы описывали кластер, его базу и пользователей с помощью обычных ресурсов. Попробуем сделать то же, но с помощью модуля.

Подключаем в инфраструктуру модуль

Возьмем пример описания модуля для простого single-node кластера, уберем лишние настройки и подправим некоторые поля:

Модуль обозначается ключевым словом module. Далее мы даем модулю имя как обычным ресурсам Terraform. Мы назовем модуль yandex-postgresql. Так будет понятно, что он делает.

В обязательном для модуля поле source мы указали путь к коду модуля на Github с указанием используемой версии в ref. Так можно ссылаться на любые модули, которые хранятся на Github, в том числе на свои.

В network_id и subnet_id мы добавили ссылки на ресурсы сети и подсети, которые создаем в том же проекте. Также добавили в кластер вторую базу hexlet-test, чтобы проверить, как модуль работает с несколькими ресурсами. Еще добавили дополнительного пользователя guest.

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

Мы технически можем добавить еще один модуль yandex-postgresql-2 с тем же source, описать в нем другой набор параметров и создать два полноценных кластера БД со всем содержимым в одном проекте. Так с помощью модулей мы можем управлять инфраструктурой на более высоком уровне абстракции.

Выполним terraform init, чтобы загрузить модуль:

Initializing modules... Initializing the backend... Initializing provider plugins... - Finding yandex-cloud/yandex versions matching ">= 0.89.0"... - Finding hashicorp/local versions matching "> 2.2.0"... - Finding hashicorp/random versions matching "> 3.3.0"... - Installing yandex-cloud/yandex v0.97.0... - Installed yandex-cloud/yandex v0.97.0 (unauthenticated) - Installing hashicorp/local v2.4.0... - Installed hashicorp/local v2.4.0 (unauthenticated) - Installing hashicorp/random v3.5.1... - Installed hashicorp/random v3.5.1 (unauthenticated) ... Terraform has been successfully initialized!

Помимо провайдера yandex-cloud дополнительно установились провайдеры local и random. Это произошло, так как наш модуль terraform-yc-postgresql использует их, чтобы генерировать случайные пароли и сохранять их в файлы.

Если инициация прошла успешно, мы сможем увидеть код используемого модуля в рабочей папке .terraform/modules внутри проекта. Заглянем внутрь и посмотрим, из чего состоит модуль.

Знакомимся со структурой модуля

Модуль по сути является вложенным проектом Terraform, который содержит все стандартные компоненты: источники данных, ресурсы, переменные, outputs. Модуль принимает из проекта значения переменных и использует их, чтобы параметризировать ресурсы.

Главное отличие модуля от проекта — отсутствие блока provider, поскольку модуль не предназначен для самостоятельного использования. При этом в модуле есть раздел required_providers, который определяет, какие версии провайдеров понадобится доустановить при подключении модуля в проект.

Модуль Terraform может храниться в обычном git-репозитории и версионироваться с помощью тегов git либо использовать для хранения специальный инфраструктурный registry, реализация которого есть, к примеру, в Gitlab.

Сейчас внутри модуля нас интересуют outputs. Модуль создаст кластер, базы, пользователей и сгенерит для них пароли. Нам нужно извлечь эти данные, чтобы передать их ресурсу виртуальной машины.

Обращаемся к полям модуля

Заглянем в outputs.tf подключенного модуля:

В cluster_fqdns_list мы сможем прочитать хост, который раньше получали из поля ресурса кластера yandex_mdb_postgresql_cluster.dbcluster.host.0.fqdn. В owners во вложенной структуре хранятся пользователи и пароли БД, в databases — список баз данных.

К полям модулей можно обращаться так же, как к полям ресурсов. Outputs являются полями самого модуля, поэтому мы в общем виде можем получить их значения, если пропишем module.<modulename>.<outputname>.

Пропишем в ресурсе виртуальной машины значения, которые возвращает модуль:

Поскольку outputs в этом модуле представляют собой списки, в ресурсе vm мы обращаемся к отдельным элементам списка, чтобы извлечь строковые значения:

  • Берем module.yandex-postgresql.cluster_fqdns_list[0].0, чтобы извлечь строку с хостом кластера
  • Берем module.yandex-postgresql.databases[0], чтобы извлечь имя первой базы данных, созданной в модуле — это будет hexlet
  • Берем module.yandex-postgresql.owners_data[0].user и module.yandex-postgresql.owners_data[0].password, чтобы получить у первого и единственного owner-пользователя имя и пароль для подключения к БД

Также установим зависимость, чтобы виртуальная машина не создавалась до тех пор, пока модуль не развернет кластер БД:

На этом наша инфраструктура готова к запуску.

Запускаем инфраструктуру

Попробуем запустить terraform apply и посмотрим, как Terraform обработает запрос на создание инфраструктуры с подключенным модулем:

# module.yandex-postgresql.random_password.password["guest"] will be created + resource "random_password" "password" { ... } # module.yandex-postgresql.random_password.password["me"] will be created + resource "random_password" "password" { ... } # module.yandex-postgresql.yandex_mdb_postgresql_cluster.this will be created + resource "yandex_mdb_postgresql_cluster" "this" { ... }

На этапе подтверждения видим, что Terraform трансформирует параметры, переданные модулю в отдельные ресурсы, и присваивает им имена вида module.yandex-postgresql.*. Когда мы изменяем параметры, передаваемые модулю, мы будем изменять ресурсы, которые стоят за ним.

Применим изменения и понаблюдаем, как создается инфраструктура:

module.yandex-postgresql.random_password.password["guest"]: Creating... module.yandex-postgresql.random_password.password["me"]: Creating... module.yandex-postgresql.random_password.password["me"]: Creation complete after 0s [id=none] module.yandex-postgresql.random_password.password["guest"]: Creation complete after 0s [id=none] yandex_vpc_network.net: Creating... yandex_vpc_network.net: Creation complete after 0s [id=enpn9tfh3hd8s8hara9m] yandex_vpc_subnet.subnet: Creating... yandex_vpc_subnet.subnet: Creation complete after 1s [id=e9bk60o99g5i2r01ia47] module.yandex-postgresql.yandex_mdb_postgresql_cluster.this: Creating... module.yandex-postgresql.yandex_mdb_postgresql_cluster.this: Still creating... [10s elapsed] ... module.yandex-postgresql.yandex_mdb_postgresql_cluster.this: Creation complete after 6m3s [id=c9q7s2022m4rife6o7bt] module.yandex-postgresql.yandex_mdb_postgresql_user.owner["me"]: Creation complete after 37s [id=c9q7s2022m4rife6o7bt:me] module.yandex-postgresql.yandex_mdb_postgresql_database.database["hexlet"]: Creating... module.yandex-postgresql.yandex_mdb_postgresql_database.database["hexlet-test"]: Creating... module.yandex-postgresql.yandex_mdb_postgresql_database.database["hexlet-test"]: Creation complete after 40s [id=c9q7s2022m4rife6o7bt:hexlet-test] module.yandex-postgresql.yandex_mdb_postgresql_database.database["hexlet"]: Creation complete after 1m16s [id=c9q7s2022m4rife6o7bt:hexlet] module.yandex-postgresql.yandex_mdb_postgresql_user.user["guest"]: Creating... module.yandex-postgresql.yandex_mdb_postgresql_user.user["guest"]: Creation complete after 54s [id=c9q7s2022m4rife6o7bt:guest] yandex_compute_instance.vm: Creating... yandex_compute_instance.vm: Provisioning with 'remote-exec'... yandex_compute_instance.vm (remote-exec): (output suppressed due to sensitive value in config) yandex_compute_instance.vm: Creation complete after 1m27s [id=fhm60f9q8b2ach07atnm]

При использовании логики модуля Terraform сгенерировал случайные пароли для пользователей с помощью провайдера random, создал кластер PostgreSQL, добавил в него базы и пользователей. Лог работы провижнера, создающего контейнер с приложением, оказался скрыт, так как в нем применялись сенситивные переменные.

Выводы

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

Модули упрощают описание сложных инфраструктурных решений и позволяют переиспользовать инфраструктурный код в разных проектах.