Spec-Zone.ru › Ansible

community.docker.docker_image_pull модуль — Загрузка изображений Docker из реестров

Примечание

Этот модуль является частью коллекции community.docker (версия 3.13.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.docker. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

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

Добавлена в community.docker 3.6.0

  • Обзор
  • Требования
  • Параметры
  • Атрибуты
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Загружает изображение Docker из реестра.

Требования

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

  • Docker API >= 1.25
  • backports.ssl_match_hostname (при использовании TLS в Python 2)
  • paramiko (при использовании SSH с use_ssh_client=false)
  • pyOpenSSL (при использовании TLS)
  • pywin32 (при использовании именованных каналов на Windows 32)
  • requests

Параметры

Параметр

Комментарии

api_version

псевдонимы: docker_api_version

строка

Версия Docker API, запущенная на Docker хосте.

По умолчанию используется последняя версия API, поддерживаемая этим сборником и демоном docker.

Если значение не указано в задании, будет использовано значение переменной окружения DOCKER_API_VERSION. Если переменная окружения не задана, будет использовано значение по умолчанию.

По умолчанию: "auto"

ca_path

псевдонимы: ca_cert, tls_ca_cert, cacert_path

путь

Используйте сертификат CA для проверки сервера, указав путь к файлу сертификата CA.

Если значение не указано в задании и переменная окружения DOCKER_CERT_PATH задана, будет использован файл ca.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

Этот параметр назывался ca_cert и был переименован в ca_path в community.docker 3.6.0. Старое название добавлено в качестве псевдонима и может по-прежнему использоваться.

client_cert

псевдонимы: tls_client_cert, cert_path

путь

Путь к файлу сертификата TLS клиента.

Если значение не указано в задании и переменная окружения DOCKER_CERT_PATH задана, будет использован файл cert.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

client_key

псевдонимы: tls_client_key, key_path

путь

Путь к файлу ключа TLS клиента.

Если значение не указано в задании и переменная окружения DOCKER_CERT_PATH задана, будет использован файл key.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

debug

логический

Режим отладки

Выбор:

  • false ← (по умолчанию)
  • true

docker_host

псевдонимы: docker_url

строка

URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, tcp://192.0.2.23:2376. Если для шифрования соединения используется TLS, модуль автоматически заменит tcp в URL соединения на https.

Если значение не указано в задании, будет использовано значение переменной окружения DOCKER_HOST. Если переменная окружения не задана, будет использовано значение по умолчанию.

По умолчанию: "unix:///var/run/docker.sock"

name

строка / обязательно

Имя образа. Формат имени должен быть одним из name, repository/name, или registry_server:port/name. - Имя может необязательно включать тег, добавляя :tag_name, или оно может содержать дайджест, добавляя @hash:digest.

platform

строка

Запрос для конкретной платформы при извлечении.

pull

строка

Определяет, когда извлекать образ.

Если always, образ всегда извлекается.

Если not_present, образ извлекается только в том случае, если на текущем Docker демоне отсутствует образ с таким именем, или если platform не совпадает.

Выбор:

  • "always" ← (по умолчанию)
  • "not_present"

ssl_version

строка

Укажите допустимый номер версии SSL. Значение по умолчанию определяется модулем Python SSL.

Если значение не указано в задании, будет использовано значение переменной окружения DOCKER_SSL_VERSION.

tag

строка

Используется для выбора образа при извлечении. По умолчанию latest.

Если формат параметра name равен name:tag или image@hash:digest, то tag будет проигнорировано.

По умолчанию: "latest"

timeout

целое число

Максимальное время ожидания ответа от API в секундах.

Если значение не указано в задании, будет использовано значение переменной окружения DOCKER_TIMEOUT. Если переменная окружения не задана, будет использовано значение по умолчанию.

По умолчанию: 60

tls

boolean

Обеспечьте безопасное соединение с API, используя TLS без проверки подлинности сервера Docker. Обратите внимание, что если validate_certs также установлено в true, оно будет иметь приоритет.

Если значение не указано в задаче, будет использовано значение переменной среды DOCKER_TLS. Если переменная среды не установлена, будет использовано значение по умолчанию.

Варианты:

  • false ← (по умолчанию)
  • true

tls_hostname

string

При проверке подлинности сервера Docker укажите ожидаемое имя сервера.

Если значение не указано в задаче, будет использовано значение переменной среды DOCKER_TLS_HOSTNAME. Если переменная среды не установлена, будет использовано значение по умолчанию.

Обратите внимание, что у этого параметра было значение по умолчанию localhost в более старых версиях. Оно было удалено в community.docker 3.0.0.

use_ssh_client

boolean

добавлен в community.docker 1.5.0

Для SSH-транспортов используйте инструмент командной строки ssh вместо paramiko.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

aliases: tls_verify

boolean

Обеспечьте безопасное соединение с API, используя TLS и проверяя подлинность сервера Docker.

Если значение не указано в задаче, будет использовано значение переменной среды DOCKER_TLS_VERIFY. Если переменная среды не установлена, будет использовано значение по умолчанию.

Варианты:

  • false ← (по умолчанию)
  • true

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группы действий: community.docker.docker, docker

Используйте group/docker или group/community.docker.docker в module_defaults для установки значений по умолчанию для этого модуля.

check_mode

Поддержка: частичная

При попытке скачать изображение с pull=always, модуль предполагает, что это всегда изменяется в режиме проверки.

Когда режим проверки комбинируется с режимом diff, идентификатор скачанного изображения всегда отображается как unknown в diff.

Может работать в check_mode и возвращать прогноз состояния изменений без модификации целевого объекта.

diff_mode

Поддержка: полная

Возвращает детали о том, что изменилось (или, возможно, нужно изменить в check_mode), когда используется режим diff.

Примечания

Примечание

  • Подключитесь к демону 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 SDK для Python для взаимодействия с демоном Docker. Он использует код, полученный из Docker SDK или Python, который включен в эту коллекцию.

См. также

См. также

community.docker.docker_image_pull

Загрузка изображений Docker из реестров.

community.docker.docker_image_remove

Удаление изображений Docker.

community.docker.docker_image_tag

Добавление тегов к изображениям Docker с новыми именами и/или тегами.

Примеры

- name: Pull an image
  community.docker.docker_image_pull:
    name: pacur/centos-7
    # Select platform for pulling. If not specified, will pull whatever docker prefers.
    platform: amd64

Значения возврата

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

Ключ

Описание

image

словарь

Результаты проверки изображения для затронутого изображения.

Возвращено: успех

Пример: {}

Авторы

  • Felix Fontein (@felixfontein)

Ссылки на коллекции

  • Система отслеживания задач
  • Репозиторий (источники)
  • Задать вопрос (Docker)
  • Задать вопрос (Docker Compose)
  • Задать вопрос (Docker Swarm)
  • Отправить отчет об ошибке
  • Запросить новую функцию
  • Общение

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/docker/docker_image_pull_module.html

Spec-Zone.ru

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