docker_machine – Источник инвентаризации Docker Machine

Обзор
Требования
Параметры
Примеры
Статус

Обзор

Получение хостов инвентаризации из Docker Machine.
Использует файл конфигурации YAML, заканчивающийся на docker_machine.(yml|yaml).
Плагин устанавливает стандартные переменные хоста ansible_host, ansible_port, ansible_user и ansible_ssh_private_key.
Плагин сохраняет переменные вывода Docker Machine ‘env’ в переменных хостов с префиксом dm_.

Требования

Ниже перечислены требования к локальному мастер-узлу, на котором выполняется эта инвентаризация.

Docker Machine

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
compose словарь	По умолчанию: {}	Создать переменные из выражений jinja2.
daemon_env строка	Варианты: require ← require-silently optional optional-silently skip	Необходимо ли извлекать переменные среды подключения к демону docker, и как вести себя, если их невозможно извлечь. При значениях `require` и `require-silently`, извлечь их и пропустить любой хост, для которого их невозможно извлечь. Предупреждение будет выведено для любого пропущенного хоста, если выбран вариант `require`. При значениях `optional` и `optional-silently`, извлечь их и не пропустить хосты, для которых их невозможно извлечь. Предупреждение будет выведено для хостов, где их невозможно извлечь, если выбран вариант `optional`. При значении `skip`, не пытаться извлечь переменные среды подключения к демону docker. Если извлечение успешно, переменные будут иметь префикс dm_ и сохранены как переменные хоста.
groups словарь	По умолчанию: {}	Добавить хосты в группу на основе условных выражений Jinja2.
keyed_groups список	По умолчанию: []	Добавить хосты в группу на основе значений переменной.
plugin - / обязательно	Варианты: docker_machine	токен, гарантирующий, что это файл источника для плагина `docker_machine`.
running_required логическое	Варианты: нет да ←	при значении true, хосты, которые Docker Machine указывает как находящиеся в состоянии, отличном от `running`, будут пропущены.
strict логическое	Варианты: нет ← да	Если `yes`, то невалидные записи являются фатальной ошибкой, иначе пропускаются и обработка продолжается. Поскольку возможно использовать факты в выражениях, они могут быть недоступны, поэтому такие ошибки по умолчанию игнорируются.
verbose_output логическое	Варианты: нет да ←	при значении true, включает все доступные метаданные узлов (например, Image, Region, Size) в виде JSON-объекта с именем `docker_machine_node_attributes`.

Примеры

# Minimal example
plugin: docker_machine

# Example using constructed features to create a group per Docker Machine driver
# (https://docs.docker.com/machine/drivers/), e.g.:
#   $ docker-machine create --driver digitalocean ... mymachine
#   $ ansible-inventory -i ./path/to/docker-machine.yml --host=mymachine
#   {
#     ...
#     "digitalocean": {
#       "hosts": [
#           "mymachine"
#       ]
#     ...
#   }
strict: no
keyed_groups:
  - separator: ''
    key: docker_machine_node_attributes.DriverName

# Example grouping hosts by Digital Machine tag
strict: no
keyed_groups:
  - prefix: tag
    key: 'dm_tags'

# Example using compose to override the default SSH behaviour of asking the user to accept the remote host key
compose:
  ansible_ssh_common_args: '"-o StrictHostKeyChecking=accept-new"'

Статус

Эта инвентаризация не гарантирует обратную совместимость. [превью]
Эта инвентаризация поддерживается сообществом Ansible. [сообщество]

Авторы

Ximon Eighteen (@ximon18)

Подсказка

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

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/plugins/inventory/docker_machine.html