docker_login - Авторизация в реестре Docker.
Новая версия 2.0.
Обзор
- Предоставляет функциональность, аналогичную команде «docker login».
- Авторизуется в реестре Docker и добавляет учетные данные в локальный файл конфигурации Docker. Добавление учетных данных в файлы конфигурации позволяет в дальнейшем подключаться к реестру с помощью инструментов, таких как модули Docker Ansible, командная строка Docker и 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 | Значение по умолчанию: None | Использование сертификата CA при проверке сервера путем указания пути к файлу сертификата CA. Псевдонимы: tls_ca_cert |
| cert_path | Значение по умолчанию: None | Путь к файлу 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 |
| Значение по умолчанию: None | Адрес электронной почты учетной записи реестра. ПРИМЕЧАНИЕ: частные реестры могут этого не требовать, но Docker Hub требует его. | |
| key_path | Значение по умолчанию: None | Путь к файлу ключа 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 выполнит вход пользователя, absent — выход.Для выхода требуется только сервер реестра, который по умолчанию — DockerHub. До версии 2.1 вы могли ТОЛЬКО войти. docker не поддерживает «выход» с настраиваемым файлом конфигурации. |
| timeout | Значение по умолчанию: 60 | Максимальное время ожидания ответа от API в секундах. |
| tls | Значение по умолчанию: нет | Защитите подключение к API с помощью TLS без проверки подлинности хоста Docker. |
| tls_hostname | Значение по умолчанию: localhost | При проверке подлинности хоста Docker укажите ожидаемое имя сервера. |
| tls_verify | Значение по умолчанию: нет | Защитите подключение к API с помощью TLS и проверьте подлинность хоста Docker. |
| username обязательно | Имя пользователя учетной записи реестра |
Примечания
Примечание
- Подключение к демону 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/.
Примеры
- 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' | Результаты входа. Пример: {'username': 'testuser', 'password': 'УКАЗАННОЕ_В_ПАРАМЕТРЕ_БЕЗ_ЛОГГИНГА_ЗНАЧЕНИЕ', 'email': 'testuer@yahoo.com', 'serveraddress': 'localhost:5000'} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- Olaf Kilian <olaf.kilian@symanex.com>
- Chris Houseknecht (@chouseknecht)
- James Tanner (@jctanner)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/docker_login_module.html
