Try SpotterLog into a Docker registry.
| "added in version" 2.0 of ansible.builtin"
Authors: Olaf Kilian <olaf.kilian@symanex.com>, Chris Houseknecht (@chouseknecht)
preview | supported by community
pipInstall with pip install ansible==2.6.0
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.
- 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
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(true) 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:
- 'The email address for the registry account. NOTE: private registries may not require
this, but Docker Hub requires it.'
required: false
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.
version_added: '2.3'
version_added_collection: ansible.builtin
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: true
username:
description:
- The username for the registry account
required: true
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:
- self.config_path
- dockercfg_path
default: ~/.docker/config.json
description:
- Custom path to the Docker CLI configuration file.
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: 'no'
description:
- Refresh exiting 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.
- B(Note:) this option is no longer supported for Docker SDK for Python 7.0.0+. Specifying
it with Docker SDK for Python 7.0.0 or newer will lead to an error.
type: str
registry_url:
aliases:
- registry
- url
default: https://index.docker.io/v1/
description:
- The registry URL.
required: false
tls_hostname:
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.
- The current default value is C(localhost). This default is deprecated and will change
in community.docker 2.0.0 to be a value computed from I(docker_host). Explicitly
specify C(localhost) to make sure this value will still be used, and to disable
the deprecation message which will be shown otherwise.
- B(Note:) this option is no longer supported for Docker SDK for Python 7.0.0+. Specifying
it with Docker SDK for Python 7.0.0 or newer will lead to an error. The value C(localhost)
will explicitly be ignored.
type: str
use_ssh_client:
default: false
description:
- For SSH transports, use the C(ssh) CLI tool instead of paramiko.
- Requires Docker SDK for Python 4.4.0 or newer.
type: bool
version_added: 1.5.0
version_added_collection: community.docker
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
login_results:
description: Results from the login.
returned: when state='present'
sample:
email: testuer@yahoo.com
serveraddress: localhost:5000
username: testuser
type: dict