Модуль kubernetes.core.helm_info — получение информации о пакете Helm, развернутом в кластере

Примечание

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

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

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

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

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

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

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

Получение информации (значений, состояний и т. д.) о пакете Helm, развернутом в кластере.

Примечание

Этому модулю соответствует плагин действий.

Требования

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

helm >= 3.0.0 (https://github.com/helm/helm/releases)
yaml (https://pypi.org/project/PyYAML/)

Параметры

Параметр	Комментарии
api_key string добавлено в kubernetes.core 1.2.0	Токен для аутентификации в API. Также можно задать с помощью переменной окружения `K8S_AUTH_API_KEY`.
binary_path path	Путь к используемому исполняемому файлу helm.
ca_cert псевдонимы: ssl_ca_cert path добавлено в kubernetes.core 1.2.0	Путь к сертификату CA, используемому для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо предоставить полную цепочку сертификатов. Также можно задать с помощью переменной окружения `K8S_AUTH_SSL_CA_CERT`.
context псевдонимы: kube_context string	Параметр Helm, указывающий, какой контекст kubeconfig использовать. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `K8S_AUTH_CONTEXT`.
get_all_values boolean добавлено в kubernetes.core 2.4.0	Установите значение `True`, если требуется получить все вычисленные значения релиза. Если указано `False` (по умолчанию), возвращаются только значения, заданные пользователем. Варианты: `false` ← (по умолчанию) `true`
host string добавлено в kubernetes.core 1.2.0	URL для доступа к API. Также можно задать с помощью переменной окружения `K8S_AUTH_HOST`.
kubeconfig псевдонимы: kubeconfig_path any	Параметр Helm, указывающий путь к используемому файлу kubeconfig. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `K8S_AUTH_KUBECONFIG`. Конфигурацию можно передать в виде словаря. Добавлено в версии 2.4.0.
release_name псевдонимы: name string / обязательный	Имя управляемого релиза.
release_namespace псевдонимы: namespace string / обязательный	Пространство имен Kubernetes, в которое следует установить чарт.
release_state list / элементы=string добавлено в kubernetes.core 2.3.0	Показывать релизы в соответствии с их состоянием. Значение по умолчанию — `deployed` и `failed`. Если задано значение `all`, показываются все релизы без применения фильтров. Если задано значение `deployed`, показываются развернутые релизы. Если задано значение `failed`, показываются релизы с ошибками. Если задано значение `pending`, показываются ожидающие релизы. Если задано значение `superseded`, показываются замененные релизы. Если задано значение `uninstalled`, показываются удаленные релизы, если использовалось `helm uninstall --keep-history`. Если задано значение `uninstalling`, показываются релизы, которые в данный момент удаляются. По умолчанию: `[]`
validate_certs псевдонимы: verify_ssl boolean добавлено в kubernetes.core 1.2.0	Проверять ли SSL-сертификаты сервера API. Также можно задать с помощью переменной окружения `K8S_AUTH_VERIFY_SSL`. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Gather information of Grafana chart inside monitoring namespace
  kubernetes.core.helm_info:
    name: test
    release_namespace: monitoring

- name: Gather information about test-chart with pending state
  kubernetes.core.helm_info:
    name: test-chart
    release_namespace: testenv
    release_state:
    - pending

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

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

Ключ	Описание
status complex	Словарь с данными о состоянии Возвращается: только если релиз существует
app_version string	Версия развернутого приложения Возвращается: всегда
chart string	Имя чарта и его версия Возвращается: всегда
hooks list / элементы=dictionary добавлено в kubernetes.core 2.4.0	Хуки релиза Возвращается: всегда
manifest list / элементы=dictionary добавлено в kubernetes.core 2.4.0	Манифест релиза Возвращается: всегда
name string	Имя релиза Возвращается: всегда
namespace string	Пространство имен, в котором развернут релиз Возвращается: всегда
notes string добавлено в kubernetes.core 2.4.0	Примечания к релизу Возвращается: всегда
release_values dictionary добавлено в kubernetes.core 6.3.0	Словарь значений, использованных для развертывания. Возвращается: всегда
revision string	Количество обновлений релиза Возвращается: всегда
status string	Состояние релиза (может быть DEPLOYED, FAILED и т. д.) Возвращается: всегда
updated string	Дата последнего обновления Возвращается: всегда
values dictionary	Словарь значений, использованных для развертывания Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2027-01-08. Вместо него используйте `status.release_values`. Возвращается: всегда

Авторы

Lucas Boisserie (@LucasBoisserie)

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

© 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_info_module.html