Модуль kubernetes.core.helm_template — рендеринг шаблонов чарта

Примечание

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

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

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

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

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

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

Рендеринг шаблонов чарта в выходной каталог или в виде текста, состоящего из объединённых yaml-документов.

Требования

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

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

Параметры

Параметр	Комментарии
binary_path path	Путь к используемому исполняемому файлу helm.
chart_ref path / обязательный	Ссылка на чарт с префиксом репозитория, например, `nginx-stable/nginx-ingress`. Путь к упакованному чарту. Путь к распакованному каталогу чарта. Абсолютный URL.
chart_repo_url string	URL репозитория чартов, в котором находится запрошенный чарт.
chart_version string	Используемая версия чарта. Если она не указана, устанавливается последняя версия.
dependency_update псевдонимы: dep_up boolean добавлено в kubernetes.core 2.4.0	Выполнить helm dependency update перед операцией. Для параметра dependency_update необходимо добавить блок `dependencies` в файл `Chart.yaml/requirements.yaml`. Дополнительные сведения см. на странице https://helm.sh/docs/helm/helm_dependency/ Варианты: `false` ← (по умолчанию) `true`
disable_hook boolean добавлено в kubernetes.core 2.4.0	Запретить выполнение хуков во время установки. Варианты: `false` ← (по умолчанию) `true`
include_crds boolean	Включить описания пользовательских ресурсов в отрендеренные шаблоны. Варианты: `false` ← (по умолчанию) `true`
insecure_registry boolean добавлено в kubernetes.core 5.1.0	Пропустить проверку сертификатов TLS при загрузке чарта Варианты: `false` ← (по умолчанию) `true`
output_dir path	Выходной каталог, в который будут записаны шаблоны. Если каталог уже существует, его содержимое будет перезаписано.
plain_http boolean добавлено в kubernetes.core 6.1.0	Использовать HTTP вместо HTTPS при работе с реестрами OCI Требуется Helm >= 3.13.0 Варианты: `false` ← (по умолчанию) `true`
release_name псевдонимы: name string добавлено в kubernetes.core 2.4.0	Имя релиза, используемое в отрендеренных шаблонах.
release_namespace string добавлено в kubernetes.core 2.4.0	Область имён для этого запроса.
release_values псевдонимы: values dictionary	Значения, передаваемые чарту. По умолчанию: `{}`
set_values list / элементы=dictionary добавлено в kubernetes.core 2.4.0	Значения, передаваемые в конфигурацию чарта.
value string / обязательный	Значение, передаваемое в конфигурацию чарта (например, phase=prod).
value_type string	Используйте `raw` для задания отдельного значения. Используйте `string`, чтобы принудительно задать отдельное значение как строку. Используйте `file`, чтобы задать отдельные значения из файла, если само значение слишком длинное для командной строки или генерируется динамически. Используйте `json` для задания значений JSON (скаляров/объектов/массивов). Для этой функции требуется helm>=3.10.0. Варианты: `"raw"` ← (по умолчанию) `"string"` `"json"` `"file"`
show_only list / элементы=string добавлено в kubernetes.core 2.4.0	Показывать только манифесты, отрендеренные из указанных шаблонов. По умолчанию: `[]`
update_repo_cache boolean	Выполнить `helm repo update` перед операцией. Это можно выполнить в рамках создания шаблона или отдельным шагом. Варианты: `false` ← (по умолчанию) `true`
values_files list / элементы=string	Файлы со значениями, передаваемые чарту. Пути будут считываться из файловой системы целевого узла, а не узла, на котором выполняется ansible. Если используются оба параметра, values_files обрабатывается раньше параметра values. Пути обрабатываются в указанном порядке. По умолчанию: `[]`

Примеры

- name: Render templates to specified directory
  kubernetes.core.helm_template:
    chart_ref: stable/prometheus
    output_dir: mycharts

- name: Render templates
  kubernetes.core.helm_template:
    chart_ref: stable/prometheus
  register: result

- name: Write templates to file
  copy:
    dest: myfile.yaml
    content: "{{ result.stdout }}"

- name: Render MutatingWebhooksConfiguration for revision tag "canary", rev "1-13-0"
  kubernetes.core.helm_template:
    chart_ref: istio/istiod
    chart_version: "1.13.0"
    release_namespace: "istio-system"
    show_only:
      - "templates/revision-tags.yaml"
    release_values:
      revision: "1-13-0"
      revisionTags:
        - "canary"
  register: result

- name: Write templates to file
  copy:
    dest: myfile.yaml
    content: "{{ result.stdout }}"

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

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

Ключ	Описание
command string	Полная команда `helm`, выполненная этим модулем. Это может пригодиться, если вы захотите выполнить команду вне модуля или отладить проблему. Возвращается: всегда Пример: `"helm template --output-dir mychart nginx-stable/nginx-ingress"`
stderr string	Полный вывод stderr команды `helm`. Его можно отобразить или изучить в журнале событий. Возвращается: всегда Пример: `""`
stdout string	Полный вывод stdout команды `helm`. Если параметр output_dir не указан, здесь будут содержаться отрендеренные шаблоны в виде объединённых yaml-документов. Возвращается: всегда Пример: `""`

Авторы

Mike Graves (@gravesm)

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

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