hetzner.hcloud.hcloud – Ansible dynamic inventory plugin for the Hetzner Cloud.
Примечание
Этот плагин входит в состав коллекции hetzner.hcloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install hetzner.hcloud.
Для использования в playbook, укажите: hetzner.hcloud.hcloud.
Обзор
- Считывает инвентаризацию из API Hetzner Cloud.
- Использует конфигурационный файл YAML, который заканчивается на hcloud.(yml|yaml).
Требования
Ниже перечислены требования к локальному контрольному узлу, на котором выполняется этот инвентаризационный модуль.
- python >= 2.7
- hcloud-python >= 1.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| compose словарь | По умолчанию: {} | Создает переменные из выражений jinja2. | |
| connect_with строка |
| Подключение к серверу с использованием значения из этого поля. | |
| groups словарь | По умолчанию: {} | Добавляет хосты в группу на основе условных выражений Jinja2. | |
| images список / элементы=строка | По умолчанию: [] | Заполняет инвентаризацию экземплярами с указанным именем образа, доступно только для системных образов. | |
| keyed_groups список / элементы=строка | По умолчанию: [] | Добавляет хосты в группу на основе значений переменной. | |
| label_selector строка | По умолчанию: "" | Заполняет инвентаризацию экземплярами с этим меткой. | |
| leading_separator логическое значение добавлено в версии 2.11 ansible.builtin |
| Используется в сочетании с keyed_groups. По умолчанию, имя ключевой группы, у которой нет префикса или разделителя, начинается с символа подчёркивания. Это связано с тем, что префикс по умолчанию — "" , а разделитель по умолчанию — "_". Установите это значение в False, чтобы опустить ведущий символ подчёркивания (или другой разделитель), если префикс не указан. Если имя группы получено из отображения, разделитель всё ещё используется для конкатенации элементов. Для того, чтобы вообще не использовать разделитель в имени группы, установите разделитель для ключевой группы на пустую строку. | |
| locations список / элементы=строка | По умолчанию: [] | Заполняет инвентаризацию экземплярами в этом местоположении. | |
| network строка | По умолчанию: "" | Заполняет инвентаризацию экземплярами, присоединёнными к сети с этим именем или ID. | |
| plugin строка / обязательно |
| помечает этот экземпляр как плагин "hcloud" | |
| strict логическое значение |
| Если yes сделать некорректные записи ошибкой, иначе пропустить и продолжить.Поскольку можно использовать факты в выражениях, они могут не всегда быть доступны, поэтому такие ошибки игнорируются по умолчанию. | |
| token строка | Токен API Hetzner Cloud. | ||
| token_env строка | По умолчанию: "HCLOUD_TOKEN" | Переменная окружения для загрузки токена API Hetzner Cloud. | |
| types список / элементы=строка | По умолчанию: [] | Заполняет инвентаризацию экземплярами с этим типом. | |
| use_extra_vars логическое значение добавлено в версии 2.11 of ansible.builtin |
| записи ini: [inventory_plugins] env:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Объединить дополнительные переменные в доступные переменные для композиции (самый высокий приоритет). |
Примеры
# Minimal example. `HCLOUD_TOKEN` is exposed in environment.
plugin: hcloud
# Example with locations, types, groups and token
plugin: hcloud
token: foobar
locations:
- nbg1
types:
- cx11
# Group by a location with prefix e.g. "hcloud_location_nbg1"
# and image_os_flavor without prefix and separator e.g. "ubuntu"
# and status with prefix e.g. "server_status_running"
plugin: hcloud
keyed_groups:
- key: location
prefix: hcloud_location
- key: image_os_flavor
separator: ""
- key: status
prefix: server_status
Авторы
- Lukas Kaemmerling (@lkaemmerling)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/hetzner/hcloud/hcloud_inventory.html
