docker_login — Ansible 2.4

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Описание

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

Требования (к хосту, на котором выполняется модуль)

python >= 2.6
docker-py >= 1.7.0
API Docker >= 1.20
Для возможности выхода (state=absent): утилита командной строки docker

Параметры

параметр	обязательно	значение по умолчанию	возможные значения	примечания
api_version	нет	значение по умолчанию, предоставляемое docker-py		Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py. псевдонимы: docker_api_version
cacert_path	нет			Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. псевдонимы: tls_ca_cert
cert_path	нет			Путь к файлу TLS-сертификата клиента. псевдонимы: tls_client_cert
config_path	нет	~/.docker/config.json		Пользовательский путь к файлу конфигурации Docker CLI. псевдонимы: self.config_path, dockercfg_path
docker_host	нет	unix://var/run/docker.sock		URL или путь к Unix-сокету для подключения к API Docker. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, 'tcp://192.0.2.23:2376'. Если для шифрования подключения используется TLS, модуль автоматически заменит 'tcp' в URL-адресе подключения на 'https'. псевдонимы: docker_url
email	нет	None		Электронный адрес учетной записи реестра. ПРИМЕЧАНИЕ: частные реестры могут этого не требовать, но Docker Hub требует.
key_path	нет			Путь к файлу TLS-ключа клиента. псевдонимы: tls_client_key
password	да			Текстовый пароль учетной записи реестра
reauthorize	нет		да нет	Обновить существующую аутентификацию, найденную в файле конфигурации. псевдонимы: reauth
registry_url	нет	https://index.docker.io/v1/		URL реестра. псевдонимы: registry, url
ssl_version	нет	1.0		Укажите допустимое числовой версии SSL. Значение по умолчанию определяется docker-py, в настоящее время 1.0.
state (добавлено в 2.3)	нет	present	present absent	Управляет текущим состоянием пользователя. `present` войдет в пользователя, `absent` выведет его. Для выхода требуется только сервер реестра, по умолчанию DockerHub. До версии 2.1 вы могли ТОЛЬКО войти. docker не поддерживает «выход» с пользовательским файлом конфигурации.
timeout	нет	60		Максимальное время ожидания ответа от API в секундах.
tls	нет			Защитить подключение к API с помощью TLS без проверки подлинности сервера Docker.
tls_hostname	нет	localhost		При проверке подлинности сервера Docker укажите ожидаемое имя сервера.
tls_verify	нет			Защитить подключение к API с помощью TLS и проверить подлинность сервера Docker.
username	да			Имя пользователя учетной записи реестра

Примеры

- name: Log into DockerHub
  docker_login:
    username: docker
    password: rekcod
    email: docker@docker.io

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

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

- name: Log out of DockerHub
  docker_login:
    state: absent
    email: docker@docker.com

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

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

название	описание	возвращается	тип	пример
login_results	Результаты входа.	при state='present'	dict	{'username': 'testuser', 'password': 'VALUE_SPECIFIED_IN_NO_LOG_PARAMETER', 'email': 'testuer@yahoo.com', 'serveraddress': 'localhost:5000'}

Примечания

Примечание

Подключайтесь к демону 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://docker-py.readthedocs.org/en/stable/machine/.

Статус

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

Для получения помощи в разработке модулей, если вам это интересно, прочитайте Справочную информацию по сообществу и вклад, Тестирование Ansible и Разработка модулей.

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