Spec-Zone.ru › Ansible 2.11

community.docker.docker_host_info – Получает данные о хосте Docker и списки объектов служб.

Примечание

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

Для его установки используйте: 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. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и последующем удалении одного из модулей, другой может перестать функционировать, и потребуется его повторная установка.
  • Docker SDK для Python ≥ 1.10.0 (используйте docker-py для Python 2.6)

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_version
строка
По умолчанию:
"auto"
Версия Docker API, работающего на хосте 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://docs.docker.com/machine/reference/env/.
  • При подключении к демону Docker с TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или новее это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
  • Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае, он будет использовать $HOME/.docker/config.json если переменная окружения DOCKER_CONFIG не указана, и $DOCKER_CONFIG/config.json в противном случае.
  • Этот модуль использует Docker SDK для 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
Список объектов 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.



Авторы

  • Piotr Wojciechowski (@WojciechowskiPiotr)

© 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/community/docker/docker_host_info_module.html

Spec-Zone.ru

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