Модуль containers.podman.podman_logout – Выход из реестра контейнеров с помощью podman

Примечание

Этот модуль входит в коллекцию containers.podman (версия 1.16.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install containers.podman. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: containers.podman.podman_logout.

Описание
Требования
Параметры
Примеры

Описание

Выход из сервера реестра контейнеров с помощью команды podman logout, удаляя кэшированные учетные данные, хранящиеся в файле `auth.json`. Если реестр не указан, будет использован первый реестр из раздела `[registries.search]` файла `registries.conf`. Пользователь может переопределить путь к файлу аутентификации, установив флаг `authfile`. По умолчанию используется путь `${XDG_RUNTIME_DIR}/containers/auth.json`. Все кэшированные учетные данные можно удалить, установив флаг `all`. Предупреждение - podman будет использовать учетные данные из `${HOME}/.docker/config.json` для аутентификации, если они не найдены в файле `authfile`. Однако команда logout удалит только учетные данные из указанного `authfile`.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

Установлен Podman на хосте

Параметры

Параметр	Комментарии
all boolean	Удалить кэшированные учетные данные для всех реестров в файле аутентификации. Варианты: `false` `true`
authfile path	Путь к файлу аутентификации. По умолчанию: ``${XDG_RUNTIME_DIR}/containers/auth.json`` Также можно переопределить путь к файлу аутентификации, установив переменную среды ``REGISTRY_AUTH_FILE``. ``export REGISTRY_AUTH_FILE=path``
executable string	Путь к исполняемому файлу `podman` , если он не находится в `$PATH` на машине, на которой выполняется `podman` По умолчанию: `"podman"`
ignore_docker_credentials boolean	Учетные данные, созданные с помощью других инструментов, таких как `docker login`, не удаляются, если соответствующий файл `authfile` не указан явно. Поскольку podman по умолчанию также использует существующие учетные данные в этих файлах (например, для docker `${HOME}/.docker/config.json`), выполнение модуля завершится неудачей, если для реестра, указанного в любом файле `authfile`, который используется podman, существует docker login. Это можно игнорировать, установив `ignore_docker_credentials` в `true` - учетные данные будут сохранены, а `changed` будет false. Этот параметр нельзя использовать вместе с `all`, так как в этом случае podman не будет проверять существующие `authfile`, созданные другими инструментами. Варианты: `false` `true`
registry string	Сервер реестра. Если реестр не указан, будет использован первый реестр из раздела `[registries.search]` файла `registries.conf`.

Примеры

- 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: true

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

Авторы

Clemens Lange (@clelange)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/containers/podman/podman_logout_module.html