docker_login - Log into a Docker registry.¶

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 (on host that executes module)¶

• python >= 2.6
• docker-py >= 1.7.0
• Docker API >= 1.20
• Only to be able to logout (state=absent): the docker command line utility

Options¶

Examples¶

- 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

Return Values¶

Common return values are documented here Return Values, the following are the fields unique to this module:

Notes¶