Note
This plugin is part of the containers.podman collection (version 1.8.1).
You might already have this collection installed if you are using the ansible
package. 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 containers.podman
.
To use it in a playbook, specify: containers.podman.podman_login
.
[registries.search]
from registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile
flag. The default path used is ${XDG_RUNTIME_DIR}/containers/auth.json
.The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
authfile path | Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path`` | |
certdir path | Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d. | |
executable string | Default: "podman" | Path to podman executable if it is not in the $PATH on the machine running podman
|
password string / required | Password for the registry server. | |
registry string | Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used. | |
tlsverify boolean |
| Require HTTPS and verify certificates when contacting registries. If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. |
username string / required | Username for the registry server. |
- name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json containers.podman.podman_login: username: user password: 'p4ssw0rd' - name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json containers.podman.podman_login: username: user password: 'p4ssw0rd' registry: quay.io
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/containers/podman/podman_login_module.html