/ home / community / community.general / 1.3.14 / module / docker_login

community.general.docker_login (1.3.14) — module

Log into a Docker registry.

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

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

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

Docker API >= 1.20
Docker SDK for Python: Please note that the L(docker-py,https://pypi.org/project/docker-py/) Python module has been superseded by L(docker,https://pypi.org/project/docker/) (see L(here,https://github.com/docker/docker-py/issues/1310) for details). For Python 2.6, C(docker-py) must be used. Otherwise, it is recommended to install the C(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.
L(Docker SDK for Python,https://docker-py.readthedocs.io/en/stable/) >= 1.8.0 (use L(docker-py,https://pypi.org/project/docker-py/) for Python 2.6)
L(Python bindings for docker credentials store API) >= 0.2.1 (use L(docker-pycreds,https://pypi.org/project/docker-pycreds/) when using Docker SDK for Python < 4.0.0)

Usage examples

Scanned by Steampunk Spotter


- name: Log into DockerHub
  community.general.docker_login:
    username: docker
    password: rekcod

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- name: Log out of DockerHub
  community.general.docker_login:
    state: absent

Inputs

tls:
default: false
description:
- Secure the connection to the API by using TLS without verifying the authenticity
of the Docker host server. Note that if I(validate_certs) is set to C(yes) as well,
it will take precedence.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TLS)
will be used instead. If the environment variable is not set, the default value
will be used.
type: bool

debug:
default: false
description:
- Debug mode
type: bool

email:
description:
- Does nothing, do not use.
- Will be removed in community.general 3.0.0.
type: str

state:
choices:
- present
- absent
default: present
description:
- This controls the current state of the user. C(present) will login in a user, C(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.
type: str

ca_cert:
aliases:
- tls_ca_cert
- cacert_path
description:
- 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 C(DOCKER_CERT_PATH)
is set, the file C(ca.pem) from the directory specified in the environment variable
C(DOCKER_CERT_PATH) will be used.
type: path

timeout:
default: 60
description:
- 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 C(DOCKER_TIMEOUT)
will be used instead. If the environment variable is not set, the default value
will be used.
type: int

password:
description:
- The plaintext password for the registry account.
- Required when I(state) is C(present).
type: str

username:
description:
- The username for the registry account.
- Required when I(state) is C(present).
type: str

client_key:
aliases:
- tls_client_key
- key_path
description:
- Path to the client's TLS key file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH)
is set, the file C(key.pem) from the directory specified in the environment variable
C(DOCKER_CERT_PATH) will be used.
type: path

api_version:
aliases:
- docker_api_version
default: auto
description:
- The version of the Docker API running on the Docker Host.
- Defaults to the latest version of the API supported by Docker SDK for Python and
the docker daemon.
- If the value is not specified in the task, the value of environment variable C(DOCKER_API_VERSION)
will be used instead. If the environment variable is not set, the default value
will be used.
type: str

client_cert:
aliases:
- tls_client_cert
- cert_path
description:
- Path to the client's TLS certificate file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH)
is set, the file C(cert.pem) from the directory specified in the environment variable
C(DOCKER_CERT_PATH) will be used.
type: path

config_path:
aliases:
- dockercfg_path
default: ~/.docker/config.json
description:
- Custom path to the Docker CLI configuration file.
type: path

docker_host:
aliases:
- docker_url
default: unix://var/run/docker.sock
description:
- 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, C(tcp://192.0.2.23:2376).
If TLS is used to encrypt the connection, the module will automatically replace
C(tcp) in the connection URL with C(https).
- If the value is not specified in the task, the value of environment variable C(DOCKER_HOST)
will be used instead. If the environment variable is not set, the default value
will be used.
type: str

reauthorize:
aliases:
- reauth
default: false
description:
- Refresh existing authentication found in the configuration file.
type: bool

ssl_version:
description:
- 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 C(DOCKER_SSL_VERSION)
will be used instead.
type: str

registry_url:
aliases:
- registry
- url
default: https://index.docker.io/v1/
description:
- The registry URL.
type: str

tls_hostname:
default: localhost
description:
- 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 C(DOCKER_TLS_HOSTNAME)
will be used instead. If the environment variable is not set, the default value
will be used.
type: str

validate_certs:
aliases:
- tls_verify
default: false
description:
- 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 C(DOCKER_TLS_VERIFY)
will be used instead. If the environment variable is not set, the default value
will be used.
type: bool

Outputs

login_results:
  description: Results from the login.
  returned: when state='present'
  sample:
    serveraddress: localhost:5000
    username: testuser
  type: dict