Spec-Zone.ru › Ansible

community.docker.docker_login модуль – Авторизация в реестре Docker.

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: community.docker.docker_login.

  • Обзор
  • Требования
  • Параметры
  • Атрибуты
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Обеспечивает функциональность, аналогичную команде docker login.
  • Авторизует пользователя в реестре Docker и добавляет учетные данные в локальный файл конфигурации Docker или в хранилище учетных данных, связанное с реестром. Добавление учетных данных в файлы конфигурации или хранилище учетных данных позволяет в дальнейшем подключаться к реестру с помощью таких инструментов, как модули Docker Ansible, Docker CLI и Docker SDK для Python без необходимости ввода учетных данных.
  • При выполнении в режиме проверки (check mode) авторизация будет выполнена без обновления файла конфигурации.

Требования

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

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

Параметры

Параметр

Комментарии

api_version

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

строка

Версия API Docker, работающая на хосте 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.

config_path

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

путь

Пользовательский путь к конфигурационному файлу Docker CLI.

По умолчанию: "~/.docker/config.json"

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"

password

строка

Текстовый пароль для учётной записи реестра.

Требуется при state=present.

reauthorize

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

булево

Обновить существующую аутентификацию, найденную в конфигурационном файле.

Варианты:

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

registry_url

псевдонимы: registry, url

строка

URL реестра.

По умолчанию: "https://index.docker.io/v1/"

ssl_version

строка

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

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

state

строка

Управляет текущим состоянием пользователя. present выполнит вход пользователя, absent — выход.

Для выхода требуется только сервер реестра, по умолчанию DockerHub.

До версии 2.1 был только вход.

Docker не поддерживает «выход» с пользовательским конфигурационным файлом.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

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

username

string

Имя пользователя для учетной записи реестра.

Требуется, когда state=present.

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

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

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

diff_mode

Поддержка: нет

В режиме сравнения вернет подробности о том, что изменилось (или, возможно, должно измениться в check_mode)

Примечания

Примечание

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

Примеры

- name: Log into DockerHub
  community.docker.docker_login:
    username: docker
    password: rekcod

- name: Log into private registry and force re-authorization
  community.docker.docker_login:
    registry_url: your.private.registry.io
    username: yourself
    password: secrets3
    reauthorize: true

- name: Log into DockerHub using a custom config file
  community.docker.docker_login:
    username: docker
    password: rekcod
    config_path: /tmp/.mydockercfg

- name: Log out of DockerHub
  community.docker.docker_login:
    state: absent

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

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

Ключ

Описание

login_results

dictionary

Результаты входа в систему.

Возвращается: при state=present

Пример: {"serveraddress": "localhost:5000", "username": "testuser"}

Авторы

  • Olaf Kilian (@olsaki)
  • Chris Houseknecht (@chouseknecht)

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

  • Отслеживание проблем
  • Репозиторий (источники)
  • Задайте вопрос (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_login_module.html

Spec-Zone.ru

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