docker_image_info – Просмотр изображений Docker
Обзор
- Укажите одно или несколько имён изображений, и модуль проверит каждое из них, вернув массив результатов проверки.
- Если изображение отсутствует локально, оно не появится в результатах. Если вы хотите проверить, существует ли изображение локально, вы можете вызвать модуль с именем изображения, а затем проверить, пуст ли список результатов (изображение отсутствует) или содержит один элемент (изображение существует локально).
- Модуль не будет пытаться загрузить изображения из репозиториев. Используйте docker_image с параметром source, установленным на
pull, чтобы убедиться в загрузке изображения.
Псевдонимы: docker_image_facts
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- API Docker >= 1.20
- Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (подробнее см. здесь). Для Python 2.6, необходимо использовать
docker-py. В противном случае рекомендуется установить модуль Pythondocker. Обратите внимание, что оба модуля не должны быть установлены одновременно. Также обратите внимание, что при установке и последующей деинсталляции одного из модулей, другой может перестать работать, и потребуется его повторная установка. - Docker SDK для Python >= 1.8.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 | |
| debug логический тип |
| Режим отладки |
| 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 |
| name список / элементы=строка | Имя образа или список имен образов. Формат имени будет name[:tag] или repository/name[:tag], где tag необязательно. Если тэг не указан, будет использован latest. Вместо имен образов можно использовать и идентификаторы образов.Если имя не указано, будет возвращен список всех образов. | |
| 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 |
Примечания
Примечание
- Этот модуль назывался
docker_image_factsдо Ansible 2.8. Способ использования не изменился. - Подключитесь к демону 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]с помощью pip. - Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать
$HOME/.docker/config.json, если переменная окруженияDOCKER_CONFIGне указана, и$DOCKER_CONFIG/config.jsonв противном случае.
Примеры
- name: Inspect a single image
docker_image_info:
name: pacur/centos-7
- name: Inspect multiple images
docker_image_info:
name:
- pacur/centos-7
- sinatra
register: result
- name: Make sure that both images pacur/centos-7 and sinatra exist locally
assert:
that:
- result.images | length == 2
Значения возврата
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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, 'Терминал': 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, 'Терминал': 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. [community]
Авторы
- 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.9/modules/docker_image_info_module.html
