Модуль kubernetes.core.helm_registry_auth — модуль аутентификации в реестре Helm

Примечание

Этот модуль входит в коллекцию kubernetes.core (версия 6.4.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: kubernetes.core.helm_registry_auth.

Добавлено в kubernetes.core 5.1.0

Краткое описание
Требования
Параметры
Примеры
Возвращаемые значения

Краткое описание

Модуль аутентификации в реестре Helm позволяет выполнить вход в helm registry login и выход из helm registry logout реестра Helm.

Требования

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

helm (https://github.com/helm/helm/releases) >= 3.8.0

Параметры

Параметр	Комментарии
binary_path путь	Путь к используемому исполняемому файлу helm.
ca_file путь	Путь к файлу SSL-сертификата CA для проверки сертификата сервера реестра.
cert_file путь	Путь к файлу SSL-сертификата клиента для идентификации клиента реестра с помощью этого файла сертификата.
host псевдонимы: registry_url строка / обязательный	Укажите URL для доступа к реестру.
insecure логический	Разрешить подключения к сайтам SSL без сертификатов. Варианты: `false` ← (по умолчанию) `true`
key_file путь	Путь к файлу SSL-ключа клиента для идентификации клиента реестра с помощью этого файла ключа.
password псевдонимы: repo_password строка	Пароль для доступа к реестру.
plain_http логический добавлено в kubernetes.core 6.4.0	Использовать небезопасные HTTP-подключения для `helm registry login`. Требуется Helm >= 3.18.0 Варианты: `false` ← (по умолчанию) `true`
state строка	Требуемое состояние реестра. Если задано значение `present`, модуль попытается войти на удалённый сервер реестра, используя URL, указанный в `host`. Если задано значение `absent`, модуль попытается выйти с удалённого сервера реестра, используя URL, указанный в `host`. Поскольку helm >= 3.18.0 сообщает об успешном выходе из системы, даже если пользователь не вошёл в неё, этот модуль сообщит об изменении независимо от текущего состояния. Варианты: `"present"` ← (по умолчанию) `"absent"`
username псевдонимы: repo_username строка	Имя пользователя для доступа к реестру.

Примеры

- name: Login to remote registry
  kubernetes.core.helm_registry_auth:
    username: admin
    password: "sample_password"
    host: localhost:5000

- name: Logout from remote registry
  kubernetes.core.helm_registry_auth:
    state: absent
    host: localhost:5000

Возвращаемые значения

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

Ключ	Описание
command строка	Полная выполненная команда `helm` Возвращается: всегда Пример: `"/usr/local/bin/helm registry login oci-registry.domain.example --username=admin --password-stdin --insecure"`
failed логический	Указывает, завершилась ли ошибкой команда `helm` Возвращается: всегда Пример: `false`
stderr строка	Полный вывод stderr команды `helm` на случай, если вы захотите отобразить его или изучить журнал событий. Обратите внимание, что исполняемый файл helm может выводить сообщения в stderr даже при успешном выполнении команды. Возвращается: всегда Пример: `"Login Succeeded\\n"`
stderr_lines список / элементы=строка	Полный вывод stderr команды `helm` на случай, если вы захотите отобразить его или изучить журнал событий. Возвращается: всегда
stdout строка	Полный вывод stdout команды `helm` на случай, если вы захотите отобразить его или изучить журнал событий. Возвращается: всегда
stout_lines список / элементы=строка	Полный вывод stdout команды `helm` на случай, если вы захотите отобразить его или изучить журнал событий. Возвращается: всегда

Авторы

Yuriy Novostavskiy (@yurnov)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/kubernetes/core/helm_registry_auth_module.html