community.docker.docker_login – Log into a Docker registry. — Ansible 2.11

Примечание

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

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

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

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

Описание

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

Требования

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

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)
L(Python-связки для API хранилища учетных данных Docker) >= 0.2.1 (используйте docker-pycreds при использовании Docker SDK для Python < 4.0.0)

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version строка	По умолчанию: "auto"	Версия API Docker, используемого на хосте 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
config_path путь	По умолчанию: "~/.docker/config.json"	Настраиваемый путь к файлу конфигурации Docker CLI. псевдонимы: dockercfg_path
debug логическое	Варианты: нет ← да	Режим отладки
docker_host строка	По умолчанию: "unix://var/run/docker.sock"	URL или путь к сокету Unix, используемый для подключения к API Docker. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если TLS используется для шифрования соединения, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, используется значение переменной среды `DOCKER_HOST`. Если переменная среды не задана, используется значение по умолчанию. псевдонимы: docker_url
email строка		Не выполняет никаких действий, не используйте. Будет удалено в версии community.docker 2.0.0.
password строка		Текстовый пароль для учетной записи реестра. Требуется, когда state равен `present`.
reauthorize логическое	Варианты: нет ← да	Обновить существующую аутентификацию, найденную в файле конфигурации. псевдонимы: reauth
registry_url строка	По умолчанию: "https://index.docker.io/v1/"	URL реестра. псевдонимы: registry, url
ssl_version строка		Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, используется значение переменной среды `DOCKER_SSL_VERSION`.
state строка	Варианты: present ← absent	Управляет текущим состоянием пользователя. `present` выполнит вход в систему пользователя, `absent` выполнит выход из системы. Для выхода достаточно указать сервер реестра, по умолчанию DockerHub. До версии 2.1 можно было ТОЛЬКО войти в систему. Docker не поддерживает «выход» с настраиваемым файлом конфигурации.
timeout целое число	По умолчанию: 60	Максимальное время в секундах ожидания ответа от API. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TIMEOUT`. Если переменная среды не задана, используется значение по умолчанию.
tls логическое	Варианты: нет ← да	Обеспечьте безопасное соединение с API с помощью TLS без проверки подлинности хоста Docker. Обратите внимание, что если validate_certs также установлено в `yes`, оно будет иметь приоритет. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TLS`. Если переменная среды не задана, используется значение по умолчанию.
tls_hostname строка	По умолчанию: "localhost"	При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не задана, используется значение по умолчанию.
username строка		Имя пользователя для учетной записи реестра. Требуется, когда state равен `present`.
validate_certs логическое	Варианты: нет ← да	Обеспечьте безопасное соединение с API с помощью TLS и проверьте подлинность хоста Docker. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не задана, используется значение по умолчанию. псевдонимы: tls_verify

Примечания

Примечание

Подключиться к демону 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 for Python версии 2.4 или более поздней это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
Обратите внимание, что Docker SDK for Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и $DOCKER_CONFIG/config.json в противном случае.
Этот модуль использует Docker SDK for Python для взаимодействия с демоном Docker.

Примеры

- 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: yes

- 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 словарь	при state='present'	Результаты входа. Пример: {'serveraddress': 'localhost:5000', 'username': 'testuser'}

Авторы

Olaf Kilian (@olsaki) <olaf.kilian@symanex.com>
Chris Houseknecht (@chouseknecht)

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