arillso.container.docker_login role – Manage Docker registry login using Ansible

Note

This role is part of the arillso.container collection (version 0.0.7).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install arillso.container.

To use it in a playbook, specify: arillso.container.docker_login.

Entry point main – Manage Docker registry login using Ansible

Synopsis

  • This spec outlines parameters for managing Docker registry logins with Ansible.

  • It includes options for Docker API version, server verification certificates, and Docker host connection settings, along with login credentials.

Parameters

Parameter

Comments

docker_login_api_version

string

Docker API version to use, set to ‘auto’ for automatic version selection.

Default: "auto"

docker_login_ca_cert

string

Path to the CA certificate for server verification.

Default: "{{ omit }}"

docker_login_client_cert

string

Path to the client’s TLS certificate for Docker daemon communication.

Default: "{{ omit }}"

docker_login_client_key

string

Path to the client’s TLS key for Docker daemon communication.

Default: "{{ omit }}"

docker_login_config_path

string

Custom path to the Docker CLI configuration file.

Default: "~/.docker/config.json"

docker_login_debug

boolean

Enable or disable debug mode.

Choices:

  • false ← (default)

  • true

docker_login_docker_host

string

Docker host URL or Unix socket path for API connection.

Default: "unix://var/run/docker.sock"

docker_login_password

string

The plaintext password for the registry account.

Default: ""

docker_login_reauthorize

boolean

Refresh existing authentication in the configuration file.

Choices:

  • false ← (default)

  • true

docker_login_registry_url

string

The registry URL.

Default: "https://index.docker.io/v1/"

docker_login_ssl_version

string

Specify a valid SSL version number for secure communication.

Default: "{{ omit }}"

docker_login_state

string

Controls the current state of the user. ‘present’ to login, ‘absent’ to log out.

Default: "present"

docker_login_timeout

integer

Maximum time in seconds to wait for a response from the API.

Default: 60

docker_login_tls

boolean

Secures connection to the API using TLS without verifying Docker host server.

Choices:

  • false ← (default)

  • true

docker_login_tls_hostname

string

Expected name of the Docker Host server for authenticity verification.

Default: "{{ omit }}"

docker_login_use_ssh_client

boolean

Use the SSH CLI tool instead of paramiko for SSH transports. Currently ignored.

Choices:

  • false ← (default)

  • true

docker_login_username

string

Username for the registry account.

Default: ""

docker_login_validate_certs

boolean

Secures the connection to the API by using TLS and verifying the Docker host server authenticity.

Choices:

  • false ← (default)

  • true