community.docker.docker_login – Log into a Docker registry.¶
Note
This plugin is part of the community.docker collection (version 1.2.2).
To install it use: ansible-galaxy collection install community.docker.
To use it in a playbook, specify: community.docker.docker_login.
Synopsis¶
Provides functionality similar to the “docker login” command.
Authenticate with a docker registry and add the credentials to your local Docker config file respectively the credentials store associated to the registry. Adding the credentials to the config files resp. the credential store allows future connections to the registry using tools such as Ansible’s Docker modules, the Docker CLI and Docker SDK for Python without needing to provide credentials.
Running in check mode will perform the authentication without updating the config file.
Requirements¶
The below requirements are needed on the host that executes this module.
Docker API >= 1.20
Docker SDK for Python: Please note that the docker-py Python module has been superseded by docker (see here for details). For Python 2.6,
docker-pymust be used. Otherwise, it is recommended to install thedockerPython module. Note that both modules should not be installed at the same time. Also note that when both modules are installed and one of them is uninstalled, the other might no longer function and a reinstall of it is required.Docker SDK for Python >= 1.8.0 (use docker-py for Python 2.6)
L(Python bindings for docker credentials store API) >= 0.2.1 (use docker-pycreds when using Docker SDK for Python < 4.0.0)
Parameters¶
Notes¶
Note
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
DOCKER_HOST,DOCKER_TLS_HOSTNAME,DOCKER_API_VERSION,DOCKER_CERT_PATH,DOCKER_SSL_VERSION,DOCKER_TLS,DOCKER_TLS_VERIFYandDOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing
docker[tls]with ansible.builtin.pip.Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions. In general, it will use
$HOME/.docker/config.jsonif theDOCKER_CONFIGenvironment variable is not specified, and use$DOCKER_CONFIG/config.jsonotherwise.This module uses the Docker SDK for Python to communicate with the Docker daemon.
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
login_results
dictionary
|
when state='present' |
Results from the login.
Sample:
{'serveraddress': 'localhost:5000', 'username': 'testuser'}
|
Authors¶
Olaf Kilian (@olsaki) <olaf.kilian@symanex.com>
Chris Houseknecht (@chouseknecht)