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 API version to use, set to ‘auto’ for automatic version selection. Default: |
|
Path to the CA certificate for server verification. Default: |
|
Path to the client’s TLS certificate for Docker daemon communication. Default: |
|
Path to the client’s TLS key for Docker daemon communication. Default: |
|
Custom path to the Docker CLI configuration file. Default: |
|
Enable or disable debug mode. Choices:
|
|
Docker host URL or Unix socket path for API connection. Default: |
|
The plaintext password for the registry account. Default: |
|
Refresh existing authentication in the configuration file. Choices:
|
|
The registry URL. Default: |
|
Specify a valid SSL version number for secure communication. Default: |
|
Controls the current state of the user. ‘present’ to login, ‘absent’ to log out. Default: |
|
Maximum time in seconds to wait for a response from the API. Default: |
|
Secures connection to the API using TLS without verifying Docker host server. Choices:
|
|
Expected name of the Docker Host server for authenticity verification. Default: |
|
Use the SSH CLI tool instead of paramiko for SSH transports. Currently ignored. Choices:
|
|
Username for the registry account. Default: |
|
Secures the connection to the API by using TLS and verifying the Docker host server authenticity. Choices:
|