community.docker.docker_image_info – Проверка изображений docker

Примечание

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

Для его установки используйте: ansible-galaxy collection install community.docker

Чтобы использовать его в книге задач, укажите: community.docker.docker_image_info

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

Описание

Укажите одно или несколько имён изображений, и модуль проверит каждое, возвращая массив результатов проверки.
Если изображение отсутствует локально, оно не отобразится в результатах. Если нужно проверить наличие изображения локально, вы можете вызвать модуль с именем изображения, а затем проверить, пуст ли список результатов (изображения нет) или содержит один элемент (изображение существует локально).
Модуль не будет пытаться загружать изображения из реестров. Используйте community.docker.docker_image с параметром source, установленным в pull, чтобы убедиться, что изображение загружено.

Требования

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

Docker API >= 1.20
Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (см. здесь для подробностей). Для Python 2.6, необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и удалении одного из модулей другой может перестать работать, и требуется его повторная установка.
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] с помощью ansible.builtin.pip.
Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В целом, он будет использовать $HOME/.docker/config.json если переменная окружения DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.
Этот модуль использует Docker SDK для Python для взаимодействия с демоном Docker.

Примеры

- name: Inspect a single image
  community.docker.docker_image_info:
    name: pacur/centos-7

- name: Inspect multiple images
  community.docker.docker_image_info:
    name:
      - pacur/centos-7
      - sinatra
  register: result

- name: Make sure that both images pacur/centos-7 and sinatra exist locally
  ansible.builtin.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}]

Авторы

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.10/collections/community/docker/docker_image_info_module.html