Spec-Zone.ru › Ansible 2.10

community.general.docker_image_info – Просмотр изображений Docker

Примечание

Этот плагин является частью коллекции community.general (версия 1.3.2).

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

Для использования в книге задач укажите: community.general.docker_image_info.

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

Обзор

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

Требования

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

  • API Docker >= 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 в противном случае.

Примеры

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

- name: Inspect multiple images
  community.general.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/general/docker_image_info_module.html

Spec-Zone.ru

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