docker_login – Log into a Docker registry.¶

New in version 2.0.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Provides functionality similar to the “docker login” command.
Authenticate with a docker registry and add the credentials to your local Docker config file. Adding the credentials to the config files allows future connections to the registry using tools such as Ansible’s Docker modules, the Docker CLI and docker-py 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.

python >= 2.6
docker-py >= 1.7.0
Please note that the docker-py Python module has been superseded by docker (see here for details). For Python 2.6, docker-py must be used. Otherwise, it is recommended to install the docker Python 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 API >= 1.20
Only to be able to logout (state=absent): the docker command line utility

Parameters ¶

Parameter	Choices/Defaults	Comments
api_version -	Default: "auto"	The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by docker-py. If the value is not specified in the task, the value of environment variable `DOCKER_API_VERSION` will be used instead. If the environment variable is not set, the default value will be used. aliases: docker_api_version
cacert_path -		Use a CA certificate when performing server verification by providing the path to a CA certificate file. If the value is not specified in the task and the environment variable `DOCKER_CERT_PATH` is set, the file `ca.pem` from the directory specified in the environment variable `DOCKER_CERT_PATH` will be used. aliases: tls_ca_cert
cert_path -		Path to the client's TLS certificate file. If the value is not specified in the task and the environment variable `DOCKER_CERT_PATH` is set, the file `cert.pem` from the directory specified in the environment variable `DOCKER_CERT_PATH` will be used. aliases: tls_client_cert
config_path -	Default: "~/.docker/config.json"	Custom path to the Docker CLI configuration file. aliases: self.config_path, dockercfg_path
debug boolean	Choices: no ← yes	Debug mode
docker_host -	Default: "unix://var/run/docker.sock"	The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, 'tcp://192.0.2.23:2376'. If TLS is used to encrypt the connection, the module will automatically replace 'tcp' in the connection URL with 'https'. If the value is not specified in the task, the value of environment variable `DOCKER_HOST` will be used instead. If the environment variable is not set, the default value will be used. aliases: docker_url
email -		The email address for the registry account.
key_path -		Path to the client's TLS key file. If the value is not specified in the task and the environment variable `DOCKER_CERT_PATH` is set, the file `key.pem` from the directory specified in the environment variable `DOCKER_CERT_PATH` will be used. aliases: tls_client_key
password - / required		The plaintext password for the registry account
reauthorize boolean	Choices: no ← yes	Refresh existing authentication found in the configuration file. aliases: reauth
registry_url -	Default: "https://index.docker.io/v1/"	The registry URL. aliases: registry, url
ssl_version -		Provide a valid SSL version number. Default value determined by ssl.py module. If the value is not specified in the task, the value of environment variable `DOCKER_SSL_VERSION` will be used instead.
state - added in 2.3	Choices: present ← absent	This controls the current state of the user. `present` will login in a user, `absent` will log them out. To logout you only need the registry server, which defaults to DockerHub. Before 2.1 you could ONLY log in. docker does not support 'logout' with a custom config file.
timeout -	Default: 60	The maximum amount of time in seconds to wait on a response from the API. If the value is not specified in the task, the value of environment variable `DOCKER_TIMEOUT` will be used instead. If the environment variable is not set, the default value will be used.
tls boolean	Choices: no ← yes	Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. If the value is not specified in the task, the value of environment variable `DOCKER_TLS` will be used instead. If the environment variable is not set, the default value will be used.
tls_hostname -	Default: "localhost"	When verifying the authenticity of the Docker Host server, provide the expected name of the server. If the value is not specified in the task, the value of environment variable `DOCKER_TLS_HOSTNAME` will be used instead. If the environment variable is not set, the default value will be used.
tls_verify boolean	Choices: no ← yes	Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. If the value is not specified in the task, the value of environment variable `DOCKER_TLS_VERIFY` will be used instead. If the environment variable is not set, the default value will be used.
username - / required		The username for the registry account

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_VERIFY and DOCKER_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://docker-py.readthedocs.io/en/stable/machine/ 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 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.json if the DOCKER_CONFIG environment variable is not specified, and use $DOCKER_CONFIG/config.json otherwise.

Examples ¶

- 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

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: {'email': '[email protected]', 'serveraddress': 'localhost:5000', 'username': 'testuser'}

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

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

Hint

If you notice any issues in this documentation you can edit this document to improve it.

docker_login – Log into a Docker registry.¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶