Spec-Zone.ru › Ansible 2.8

docker_host_info – Извлекает сведения о хосте Docker и списки объектов сервисов

Новая версия 2.8.

  • Синопсис
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Синопсис

  • Извлекает сведения о хосте Docker.
  • В сущности возвращает вывод docker system info.
  • Модуль также позволяет перечислить имена объектов для контейнеров, образов, сетей и томов. Он также позволяет запросить информацию об использовании диска.
  • Вывод отличается в зависимости от версии API демона Docker.
  • Если к демону Docker невозможно подключиться или он не соответствует требованиям версии API, модуль завершится ошибкой.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

  • Docker API >= 1.21
  • Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (см. здесь для получения подробностей). Для Python 2.6 необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что если оба модуля установлены и один из них удалён, другой может перестать работать, и потребуется его повторная установка.
  • Docker SDK для Python >= 1.10.0 (используйте docker-py для Python 2.6)

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_version
строка
По умолчанию:
"auto"
Версия API Docker, работающая на Docker хосте.
По умолчанию устанавливается последняя версия API, поддерживаемая Docker SDK для Python и демоном docker.
Если значение не указано в задаче, используется значение переменной среды DOCKER_API_VERSION. Если переменная среды не задана, используется значение по умолчанию.

псевдонимы: docker_api_version
ca_cert
путь
Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA.
Если значение не указано в задаче, а переменная среды DOCKER_CERT_PATH задана, используется файл ca.pem из директории, указанной в переменной среды DOCKER_CERT_PATH.

псевдонимы: tls_ca_cert, cacert_path
client_cert
путь
Путь к файлу TLS-сертификата клиента.
Если значение не указано в задаче, а переменная среды DOCKER_CERT_PATH задана, используется файл cert.pem из директории, указанной в переменной среды DOCKER_CERT_PATH.

псевдонимы: tls_client_cert, cert_path
client_key
путь
Путь к файлу TLS-ключа клиента.
Если значение не указано в задаче, а переменная среды DOCKER_CERT_PATH задана, используется файл key.pem из директории, указанной в переменной среды DOCKER_CERT_PATH.

псевдонимы: tls_client_key, key_path
containers
булево
    Варианты:
  • нет ←
  • да
Выводить список контейнеров?
containers_filters
словарь
Словарь значений фильтров для выбора контейнеров для вывода.
Например, until: 24h.
См. документацию Docker для получения дополнительной информации о возможных фильтрах.
debug
булево
    Варианты:
  • нет ←
  • да
Режим отладки
disk_usage
булево
    Варианты:
  • нет ←
  • да
Сводная информация об используемом диске всеми слоями Docker.
Вывод — это сумма значений изображений, томов, контейнеров и кэша сборки.
docker_host
строка
По умолчанию:
"unix://var/run/docker.sock"
URL или путь к сокету Unix, используемый для подключения к Docker API. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, tcp://192.0.2.23:2376. Если для шифрования соединения используется TLS, модуль автоматически заменит tcp в URL-адресе подключения на https.
Если значение не указано в задаче, используется значение переменной среды DOCKER_HOST. Если переменная среды не задана, используется значение по умолчанию.

псевдонимы: docker_url
images
булево
    Варианты:
  • нет ←
  • да
Выводить список образов?
images_filters
словарь
Словарь значений фильтров для выбора образов для вывода.
Например, dangling: true.
См. документацию Docker для получения дополнительной информации о возможных фильтрах.
networks
булево
    Варианты:
  • нет ←
  • да
Выводить список сетей?
networks_filters
словарь
Словарь значений фильтров для выбора сетей для вывода.
См. документацию Docker для получения дополнительной информации о возможных фильтрах.
ssl_version
строка
Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py.
Если значение не указано в задаче, используется значение переменной среды DOCKER_SSL_VERSION.
timeout
целое число
По умолчанию:
60
Максимальное время в секундах ожидания ответа от API.
Если значение не указано в задаче, используется значение переменной среды DOCKER_TIMEOUT. Если переменная среды не задана, используется значение по умолчанию.
tls
булево
    Варианты:
  • нет ←
  • да
Защитить подключение к API с помощью TLS без проверки подлинности Docker хост-сервера. Обратите внимание, что если validate_certs также установлено в значение yes, оно будет иметь приоритет.
Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS. Если переменная среды не задана, используется значение по умолчанию.
tls_hostname
строка
По умолчанию:
"localhost"
При проверке подлинности Docker хост-сервера укажите ожидаемое имя сервера.
Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS_HOSTNAME. Если переменная среды не задана, используется значение по умолчанию.
validate_certs
булево
    Варианты:
  • нет ←
  • да
Защитить подключение к API с помощью TLS и проверить подлинность Docker хост-сервера.
Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS_VERIFY. Если переменная среды не задана, используется значение по умолчанию.

псевдонимы: tls_verify
verbose_output
булево
    Варианты:
  • нет ←
  • да
Если установлено в yes, а networks, volumes, images, containers или disk_usage установлено в yes, вывод будет содержать подробную информацию об объектах, соответствующих полному выводу метода API. Подробнее см. документацию вашей версии Docker API по адресу L(https://docs.docker.com/engine/api/).
Подробный вывод в этом модуле содержит только подмножество информации, возвращаемой модулем _info для каждого типа объектов.
volumes
булево
    Варианты:
  • нет ←
  • да
Выводить список томов?
volumes_filters
словарь
Словарь значений фильтров для выбора томов для вывода.
См. документацию Docker для получения дополнительной информации о возможных фильтрах.

Примечания

Примечание

  • Подключитесь к демону Docker, предоставив параметры с каждой задачей или определив переменные среды. Вы можете определить DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите скрипт, поставляемый с продуктом, который настраивает среду. Он установит эти переменные за вас. Подробнее см. https://docker-py.readthedocs.io/en/stable/machine/.
  • При подключении к демону Docker с TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или новее это можно сделать, установив docker[tls] с помощью pip.
  • Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и $DOCKER_CONFIG/config.json в противном случае.

Примеры

- name: Get info on docker host
  docker_host_info:
  register: result

- name: Get info on docker host and list images
  docker_host_info:
    images: yes
  register: result

- name: Get info on docker host and list images matching the filter
  docker_host_info:
    images: yes
    images_filters:
      label: "mylabel"
  register: result

- name: Get info on docker host and verbose list images
  docker_host_info:
    images: yes
    verbose_output: yes
  register: result

- name: Get info on docker host and used disk space
  docker_host_info:
    disk_usage: yes
  register: result

- debug:
    var: result.host_info

Значения возврата

Общие значения возврата описаны здесь, а следующие — поля, уникальные для этого модуля:

Ключ Возвращаемое значение Описание
can_talk_to_docker
boolean
при успехе и при ошибке
Будет true если модуль может взаимодействовать с демоном docker.

containers
список
Когда containers yes
Список объектов dict, содержащих основную информацию о каждом контейнере. Ключи соответствуют выводу docker container ls за исключением случая, когда verbose_output=yes. См. описание для verbose_output.

disk_usage
словарь
Когда disk_usage yes
Информация о суммарном использовании дискового пространства изображениями, контейнерами и томами на хосте docker, за исключением случая, когда verbose_output=yes. См. описание для verbose_output.

host_info
словарь
всегда
Данные, представляющие базовое состояние хоста docker. Соответствует выводу docker system info.

images
список
Когда images yes
Список объектов dict, содержащих основную информацию о каждом изображении. Ключи соответствуют выводу docker image ls за исключением случая, когда verbose_output=yes. См. описание для verbose_output.

networks
список
Когда networks yes
Список объектов dict, содержащих основную информацию о каждой сети. Ключи соответствуют выводу docker network ls за исключением случая, когда verbose_output=yes. См. описание для verbose_output.

volumes
список
Когда volumes yes
Список объектов dict, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker volume ls за исключением случая, когда verbose_output=yes. См. описание для verbose_output.



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Piotr Wojciechowski (@WojciechowskiPiotr)

Подсказка

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

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

Spec-Zone.ru

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