community.docker.docker_host_info – Извлекает сведения о хосте Docker и списки объектов служб.
Примечание
Этот плагин входит в коллекцию community.docker (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install community.docker.
Чтобы использовать его в книге задач, укажите: community.docker.docker_host_info.
Обзор
- Извлекает сведения о хосте Docker.
- В сущности возвращает вывод команды
docker system info. - Модуль также позволяет перечислять имена объектов для контейнеров, образов, сетей и томов. Он также позволяет запрашивать информацию об использовании диска.
- Вывод отличается в зависимости от версии API демона Docker.
- Если к демону Docker невозможно подключиться или он не соответствует требованиям к версии API, модуль завершится ошибкой.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- API Docker ≥ 1.21
- Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменен на docker (подробнее см. здесь). Для Python 2.6 необходимо использовать
docker-py. В противном случае рекомендуется установить модуль Pythondocker. Обратите внимание, что оба модуля не должны быть установлены одновременно. Также обратите внимание, что при установке обоих модулей и удалении одного из них другой может перестать работать, и потребуется его повторная установка. - 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, используемый для подключения к API Docker. Для подключения к удаленному хосту предоставьте строку 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. Подробнее см. документацию вашей версии API Docker по адресу 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://docs.docker.com/machine/reference/env/. - При подключении к демону Docker с TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK for Python версии 2.4 или новее это можно сделать, установив
docker[tls]с помощью ansible.builtin.pip. - Обратите внимание, что Docker SDK for Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать
$HOME/.docker/config.jsonесли переменная окруженияDOCKER_CONFIGне указана, и$DOCKER_CONFIG/config.jsonв противном случае. - Этот модуль использует Docker SDK for Python для связи с демоном Docker.
Примеры
- name: Get info on docker host
community.docker.docker_host_info:
register: result
- name: Get info on docker host and list images
community.docker.docker_host_info:
images: yes
register: result
- name: Get info on docker host and list images matching the filter
community.docker.docker_host_info:
images: yes
images_filters:
label: "mylabel"
register: result
- name: Get info on docker host and verbose list images
community.docker.docker_host_info:
images: yes
verbose_output: yes
register: result
- name: Get info on docker host and used disk space
community.docker.docker_host_info:
disk_usage: yes
register: result
- ansible.builtin.debug:
var: result.host_info
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| can_talk_to_docker boolean | при успехе и при ошибке | Будет true если модуль может связаться с демоном docker. |
| containers список / элементы=словарь | Когда containers yes
| Список объектов словаря, содержащих основную информацию о каждом контейнере. Ключи соответствуют выводу 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
| Список объектов словаря, содержащих основную информацию о каждом изображении. Ключи соответствуют выводу docker image ls , если verbose_output=yes. См. описание для verbose_output. |
| networks список / элементы=словарь | Когда networks yes
| Список объектов словаря, содержащих основную информацию о каждой сети. Ключи соответствуют выводу docker network ls , если verbose_output=yes. См. описание для verbose_output. |
| volumes список / элементы=словарь | Когда volumes yes
| Список объектов словаря, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker volume ls , если verbose_output=yes. См. описание для verbose_output. |
Авторы
- 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.10/collections/community/docker/docker_host_info_module.html