community.general.terraform – Управляет развертыванием Terraform (и планами)
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.terraform.
Обзор
- Обеспечивает поддержку развертывания ресурсов с помощью Terraform и извлечения информации о ресурсах обратно в Ansible.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- terraform
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| backend_config словарь | Группа пар ключ-значение для предоставления на стадии инициализации параметру -backend-config. | |
| backend_config_files список / элементы=путь добавлен в 0.2.0 community.general | Путь к файлу конфигурации для предоставления на стадии инициализации параметру -backend-config. Может принимать список путей к нескольким файлам конфигурации. | |
| binary_path путь | Путь к бинарному файлу terraform, относительно 'service_path', если не указан абсолютный путь. | |
| force_init булево |
| Для предотвращения дублирования инфраструктуры, если файл состояния не найден, это принудительно выполнит `terraform init`. Как правило, этот параметр следует выключать, если вы не намерены развертывать совершенно новую инфраструктуру Terraform. |
| init_reconfigure булево добавлен в 1.3.0 community.general |
| Принудительно переконфигурирует бэкенд во время инициализации. |
| lock булево |
| Включает блокировку файла состояния, если используется служба, поддерживающая блокировки (например, S3+DynamoDB) для хранения файла состояния. |
| lock_timeout целое число | Время удержания блокировки на файле состояния, если используется служба, поддерживающая блокировки (например, S3+DynamoDB). | |
| plan_file путь | Путь к существующему файлу плана Terraform для применения. Если не указан, Ansible создаст новый план TF и выполнит его. Обратите внимание, что этот параметр обязателен, если у 'state' значение 'planned'. | |
| project_path путь / обязательно | Путь к корневому каталогу Terraform с файлами vars.tf/main.tf и т.д. для использования. | |
| purge_workspace булево |
| Действует только со state = absent Если true, рабочее пространство будет удалено после действия "terraform destroy". Рабочее пространство 'default' не будет удалено. |
| state строка |
| Целевое состояние данного этапа/проекта |
| state_file путь | Путь к существующему файлу состояния Terraform для использования при построении плана. Если не указан, используется по умолчанию `terraform.tfstate`. Этот параметр игнорируется, когда указан план. | |
| targets список / элементы=строка | Список конкретных ресурсов, на которые необходимо нацелиться в этом плане/приложении. Выбранные здесь ресурсы также автоматически включат все зависимости. | |
| variables словарь | Группа пар ключ-значение для переопределения переменных шаблонов или переменных в файлах переменных. | |
| variables_files список / элементы=путь | Путь к файлу переменных для Terraform, чтобы заполнить TF-конфигурации. Может принимать список путей к нескольким файлам переменных. До версии Ansible 2.9 этот параметр был доступен как variables_file. псевдонимы: variables_file | |
| workspace строка | По умолчанию: "default" | Рабочее пространство terraform для работы. |
Примечания
Примечание
- Чтобы просто выполнить
terraform plan, используйте режим проверки.
Примеры
- name: Basic deploy of a service
community.general.terraform:
project_path: '{{ project_dir }}'
state: present
- name: Define the backend configuration at init
community.general.terraform:
project_path: 'project/'
state: "{{ state }}"
force_init: true
backend_config:
region: "eu-west-1"
bucket: "some-bucket"
key: "random.tfstate"
- name: Define the backend configuration with one or more files at init
community.general.terraform:
project_path: 'project/'
state: "{{ state }}"
force_init: true
backend_config_files:
- /path/to/backend_config_file_1
- /path/to/backend_config_file_2
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| command строка | всегда | Полная команда `terraform`, сгенерированная этим модулем, в случае необходимости повторного выполнения команды вне модуля или для отладки проблемы. Пример: terraform apply ... | |
| outputs сложный | при успехе | Словарь всех выходных данных TF по их заданному имени. Используйте `.outputs.MyOutputName.value` для доступа к значению. Пример: {"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"} | |
| sensitive булево | всегда | Указано ли Terraform, что это значение является конфиденциальным. | |
| type строка | всегда | Тип значения (строка, целое число и т.д.) | |
| value строка | всегда | Значение выходных данных, интерполированных Terraform. | |
| stdout строка | всегда | Полный вывод команды `terraform`, в случае необходимости отображения или проверки журнала событий. | |
Авторы
- Ryan Scott Brown (@ryansb)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/terraform_module.html
