Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в состав коллекции community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.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
  • community.general.docker_machine
токен, который гарантирует, что это файл-источник для плагина docker_machine.
running_required
логическое значение
    Варианты:
  • нет
  • да ←
если значение истинно, узлы, которые Docker Machine указывает в состоянии, отличном от running, будут пропущены.
strict
логическое значение
    Варианты:
  • нет ←
  • да
Если yes, то невалидные записи станут фатальной ошибкой, иначе пропустить и продолжить.
Поскольку использование фактов в выражениях возможно, они могут не всегда быть доступны, и мы игнорируем эти ошибки по умолчанию.
verbose_output
логическое значение
    Варианты:
  • нет
  • да ←
если значение истинно, включить все доступные данные узлов (например, Image, Region, Size) как объект JSON с именем docker_machine_node_attributes.

Примеры

# Minimal example
plugin: community.general.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"'

Авторы

  • 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.10/collections/community/general/docker_machine_inventory.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API