docker_image_facts – Просмотр образов Docker

Новое в версии 2.1.0.

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

Обзор

Укажите одно или несколько имён образов, и модуль проверит каждый из них, вернув массив результатов проверки.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version -	Значение по умолчанию: "auto"	Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, используется значение по умолчанию. Псевдонимы: docker_api_version
cacert_path -		Использование сертификата CA при проверке сервера путём указания пути к файлу сертификата CA. Если значение не указано в задаче, и установлена переменная окружения `DOCKER_CERT_PATH`, используется файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Псевдонимы: tls_ca_cert
cert_path -		Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче, и установлена переменная окружения `DOCKER_CERT_PATH`, используется файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Псевдонимы: tls_client_cert
debug boolean	Варианты: нет ← да	Режим отладки
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
key_path -		Путь к файлу TLS-ключа клиента. Если значение не указано в задаче, и установлена переменная окружения `DOCKER_CERT_PATH`, используется файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Псевдонимы: tls_client_key
name - / обязательно		Имя образа или список имён образов. Формат имени — name[:tag] или repository/name[:tag], где tag необязательно. Если тэг не указан, используется 'latest'.
ssl_version -		Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_SSL_VERSION`.
timeout -	Значение по умолчанию: 60	Максимальное время в секундах ожидания ответа от API. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, используется значение по умолчанию.
tls boolean	Варианты: нет ← да	Защитите соединение с API с помощью TLS без проверки подлинности хоста Docker. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, используется значение по умолчанию.
tls_hostname -	Значение по умолчанию: "localhost"	При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, используется значение по умолчанию.
tls_verify boolean	Варианты: нет ← да	Защитите соединение с API с помощью TLS и проверьте подлинность хоста Docker. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TLS_VERIFY`. Если переменная окружения не задана, используется значение по умолчанию.

Примечания

Примечание

Подключитесь к демону 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: Inspect a single image
  docker_image_facts:
    name: pacur/centos-7

- name: Inspect multiple images
  docker_image_facts:
    name:
      - pacur/centos-7
      - sinatra

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
images словарь	всегда	Данные для выбранных изображений. Пример: [{'Архитектура': 'amd64', 'Автор': '', 'Комментарий': '', 'Настройка': {'AttachStderr': False, 'AttachStdin': False, 'AttachStdout': False, 'Команда': ['/etc/docker/registry/config.yml'], 'Имя_домена': '', 'Точка_входа': ['/bin/registry'], 'Переменные_окружения': ['PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'], 'Экспонированные_порты': {'5000/tcp': {}}, 'Имя_хоста': 'e5c68db50333', 'Изображение': 'c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799', 'Метки': {}, 'Настройка_при_создании': [], 'Открыть_стандартный_ввод': False, 'Стандартный_ввод_один_раз': False, 'Тty': False, 'Пользователь': '', 'Тома': {'/var/lib/registry': {}}, 'Рабочая_директория': ''}, 'Контейнер': 'e83a452b8fb89d78a25a6739457050131ca5c863629a47639530d9ad2008d610', 'Настройка_контейнера': {'AttachStderr': False, 'AttachStdin': False, 'AttachStdout': False, 'Команда': ['/bin/sh', '-c', '#(nop) CMD ["/etc/docker/registry/config.yml"]'], 'Имя_домена': '', 'Точка_входа': ['/bin/registry'], 'Переменные_окружения': ['PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'], 'Экспонированные_порты': {'5000/tcp': {}}, 'Имя_хоста': 'e5c68db50333', 'Изображение': 'c72dce2618dc8f7b794d2b2c2b1e64e0205ead5befc294f8111da23bd6a2c799', 'Метки': {}, 'Настройка_при_создании': [], 'Открыть_стандартный_ввод': False, 'Стандартный_ввод_один_раз': False, 'Тty': False, 'Пользователь': '', 'Тома': {'/var/lib/registry': {}}, 'Рабочая_директория': ''}, 'Создано': '2016-03-08T21:08:15.399680378Z', 'Версия_Docker': '1.9.1', 'Драйвер_графа': {'Данные': None, 'Название': 'aufs'}, 'Идентификатор': '53773d8552f07b730f3e19979e32499519807d67b344141d965463a950a66e08', 'Имя': 'registry:2', 'Операционная_система': 'linux', 'Родитель': 'f0b1f729f784b755e7bf9c8c2e65d8a0a35a533769c2588f02895f6781ac0805', 'Хэши_репозитория': [], 'Теги_репозитория': ['registry:2'], 'Размер': 0, 'Виртуальный_размер': 165808884}]

Статус

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

Авторы

Chris Houseknecht (@chouseknecht)

Подсказка

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

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