docker_login – Вход в реестр Docker
Новая версия с 2.0.
Описание
- Предоставляет функциональность, аналогичную команде «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. В противном случае рекомендуется установить модуль Pythondocker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке обоих модулей и удалении одного из них, другой может перестать работать, и потребуется его повторная установка. - Docker SDK для Python >= 1.8.0 (используйте docker-py для Python 2.6)
- Только для выхода из системы, то есть для state =
absent: утилита командной строкиdocker
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 строка | Адрес электронной почты для учетной записи реестра. | |
| password строка / обязательно | Текстовый пароль для учетной записи реестра | |
| reauthorize булево |
| Обновить существующую аутентификацию, найденную в файле конфигурации. псевдонимы: reauth |
| registry_url строка | По умолчанию: "https://index.docker.io/v1/" | URL реестра. псевдонимы: registry, url |
| ssl_version строка | Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, будет использовано значение переменной окружения DOCKER_SSL_VERSION. | |
| state строка добавлено в 2.3 |
| Это управляет текущим состоянием пользователя. 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 строка / обязательно | Имя пользователя для учетной записи реестра | |
| 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://docker-py.readthedocs.io/en/stable/machine/. - При подключении к демону Docker с TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или новее это можно сделать, установив
docker[tls]с помощью pip. - Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В целом, он будет использовать
$HOME/.docker/config.jsonесли переменная окруженияDOCKER_CONFIGне указана, и использовать$DOCKER_CONFIG/config.jsonв противном случае.
Примеры
- name: Log into DockerHub
docker_login:
username: docker
password: rekcod
- 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
config_path: /tmp/.mydockercfg
- name: Log out of DockerHub
docker_login:
state: absent
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| login_results словарь | при state='present' | Результаты входа. Пример: {'email': 'testuer@yahoo.com', 'serveraddress': 'localhost:5000', 'username': 'testuser'} |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Olaf Kilian (@olsaki) <olaf.kilian@symanex.com>
- Chris Houseknecht (@chouseknecht)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/docker_login_module.html
