containers.podman.podman_logout module – Log out of a container registry using podman

Note

This module is part of the containers.podman collection (version 1.9.3).

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_logout.

Synopsis

  • Log out of a container registry server using the podman logout command by deleting the cached credentials stored in the auth.json file. If the registry is not specified, the first registry under [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. All the cached credentials can be removed by setting the all flag. Warning - podman will use credentials in ${HOME}/.docker/config.json to authenticate in case they are not found in the default authfile. However, the logout command will only removed credentials in the authfile specified.

Requirements

The below requirements are needed on the host that executes this module.

  • Podman installed on host

Parameters

Parameter

Comments

all

boolean

Remove the cached credentials for all registries in the auth file.

Choices:

  • no

  • yes

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

executable

string

Path to podman executable if it is not in the $PATH on the machine running podman

Default: “podman”

ignore_docker_credentials

boolean

Credentials created using other tools such as docker login are not removed unless the corresponding authfile is explicitly specified. Since podman also uses existing credentials in these files by default (for docker e.g. ${HOME}/.docker/config.json), module execution will fail if a docker login exists for the registry specified in any authfile is used by podman. This can be ignored by setting ignore_docker_credentials to yes - the credentials will be kept and changed will be false. This option cannot be used together with all since in this case podman will not check for existing authfiles created by other tools.

Choices:

  • no

  • yes

registry

string

Registry server. If the registry is not specified, the first registry under [registries.search] from registries.conf will be used.

Examples

- name: Log out of default registry
  podman_logout:

- name: Log out of quay.io
  podman_logout:
    registry: quay.io

- name: Log out of all registries in auth file
  podman_logout:
    all: yes

- name: Log out of all registries in specified auth file
  podman_logout:
    authfile: $HOME/.docker/config.json
    all: yes

Authors

  • Clemens Lange (@clelange)