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

Примечание

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

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

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

Для использования в playbook, укажите: kubernetes.core.helm_info.

Новое в kubernetes.core 0.11.0

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

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

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

Примечание

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

Требования

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

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

Параметры

Параметр	Комментарии
api_key строка добавлено в kubernetes.core 1.2.0	Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения `K8S_AUTH_API_KEY`.
binary_path путь	Путь к исполняемому файлу helm.
ca_cert псевдонимы: ssl_ca_cert путь добавлено в kubernetes.core 1.2.0	Путь к сертификату CA, используемому для аутентификации с API. Для предотвращения ошибок проверки сертификатов необходимо указать полную цепочку сертификатов. Также может быть указан через переменную окружения `K8S_AUTH_SSL_CA_CERT`.
context псевдонимы: kube_context строка	Параметр Helm для указания контекста kubeconfig, который следует использовать. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `K8S_AUTH_CONTEXT`.
get_all_values логическое добавлено в kubernetes.core 2.4.0	Установите в `True`, если вы хотите получить все (вычисленные) значения релиза. Когда `False` (по умолчанию), возвращаются только значения, предоставленные пользователем. Варианты: `false` ← (по умолчанию) `true`
host строка добавлено в kubernetes.core 1.2.0	Укажите URL для доступа к API. Также может быть указан через переменную окружения `K8S_AUTH_HOST`.
kubeconfig псевдонимы: kubeconfig_path любой	Параметр Helm для указания пути к kubeconfig, который следует использовать. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `K8S_AUTH_KUBECONFIG`. Конфигурацию можно указать в виде словаря. Добавлено в версии 2.4.0.
release_name псевдонимы: name строка / обязательно	Имя релиза для управления.
release_namespace псевдонимы: namespace строка / обязательно	Пространство имен Kubernetes, в котором должен быть установлен график.
release_state список / элементы=строка добавлено в kubernetes.core 2.3.0	Показать релизы в соответствии с их состояниями. Значение по умолчанию — `deployed` и `failed`. Если установлено в `all`, отображаются все релизы без применения какого-либо фильтра. Если установлено в `deployed`, отображаются развернутые релизы. Если установлено в `failed`, отображаются неудачные релизы. Если установлено в `pending`, отображаются ожидающие релизы. Если установлено в `superseded`, отображаются устаревшие релизы. Если установлено в `uninstalled`, отображаются удаленные релизы, если использовался `helm uninstall --keep-history`. Если установлено в `uninstalling`, отображаются релизы, которые в данный момент удаляются. По умолчанию: `[]`
validate_certs псевдонимы: verify_ssl логическое добавлено в 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 сложный	Словарь со статусом вывода Возвращается: только если релиз существует
app_version строка	Версия развернутого приложения Возвращается: всегда
chart строка	Имя и версия шаблона Возвращается: всегда
hooks список / элементы=словарь добавлено в kubernetes.core 2.4.0	Плагины релиза Возвращается: всегда
manifest список / элементы=словарь добавлено в kubernetes.core 2.4.0	Манифест релиза Возвращается: всегда
name строка	Имя релиза Возвращается: всегда
namespace строка	Пространство имен, где развернут релиз Возвращается: всегда
notes строка добавлено в kubernetes.core 2.4.0	Примечания к релизу Возвращается: всегда
revision строка	Количество обновлений релиза Возвращается: всегда
status строка	Статус релиза (может быть DEPLOYED, FAILED, …) Возвращается: всегда
updated строка	Дата последнего обновления Возвращается: всегда
values строка	Словарь значений, использованных для развертывания Возвращается: всегда

Авторы

Lucas Boisserie (@LucasBoisserie)

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

© 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/kubernetes/core/helm_info_module.html