kubernetes.core.helm_template модуль — Рендеринг шаблонов диаграммы

Примечание

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

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

Для установки используйте: ansible-galaxy collection install kubernetes.core.

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

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

Рендеринг шаблонов диаграммы в каталог вывода или в виде текста объединённых YAML-документов.

Параметры

Параметр	Комментарии
binary_path путь	Путь к бинарному файлу helm.
chart_ref путь / обязательно	Ссылка на шаблон с префиксом репозитория, например, `nginx-stable/nginx-ingress`. Путь к упакованному шаблону. Путь к распакованной директории шаблона. Абсолютный URL.
chart_repo_url строка	URL репозитория шаблонов, где находится запрашиваемый шаблон.
chart_version строка	Версия шаблона. Если не указано, устанавливается последняя версия.
dependency_update алиасы: dep_up логическое добавлен в 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 логическое добавлен в kubernetes.core 2.4.0	Запретить выполнение хуков во время установки. Варианты: `false` ← (по умолчанию) `true`
include_crds логическое	Включать описания пользовательских ресурсов в сгенерированные шаблоны. Варианты: `false` ← (по умолчанию) `true`
output_dir путь	Директория вывода, куда будут записаны шаблоны. Если директория уже существует, она будет перезаписана.
release_name алиасы: name строка добавлен в kubernetes.core 2.4.0	Имя релиза, используемое в сгенерированных шаблонах.
release_namespace строка добавлен в kubernetes.core 2.4.0	Пространство имён для данного запроса.
release_values алиасы: values словарь	Значения, передаваемые шаблону. По умолчанию: `{}`
set_values список / элементы=словарь добавлен в kubernetes.core 2.4.0	Значения для конфигурации шаблона.
value строка / обязательно	Значение для конфигурации шаблона (например, phase=prod).
value_type строка	Используйте `raw` для установки отдельных значений. Используйте `string` для принудительного преобразования значения в строку. Используйте `file` для установки отдельных значений из файла, когда значение слишком длинное для командной строки или динамически генерируется. Используйте `json` для установки значений JSON (скаляры/объекты/массивы). Эта функция требует helm>=3.10.0. Варианты: `"raw"` ← (по умолчанию) `"string"` `"json"` `"file"`
show_only список / элементы=строка добавлен в kubernetes.core 2.4.0	Отобразить только сгенерированные манифесты из указанных шаблонов. По умолчанию: `[]`
update_repo_cache логическое	Выполнить `helm repo update` перед операцией. Может выполняться как часть генерации шаблонов, так и как отдельный шаг. Варианты: `false` ← (по умолчанию) `true`
values_files список / элементы=строка	Файлы значений для передачи шаблону. Пути будут читаться из файловой системы целевого хоста, а не хоста, на котором запускается 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 строка	Полная `helm` команда, запущенная данным модулем, в случае, если вы хотите перезапустить её вне модуля или отладить проблему. Возвращается: всегда Пример: `"helm template --output-dir mychart nginx-stable/nginx-ingress"`
stderr строка	Полная `helm` ошибка команды, в случае, если вы хотите её отобразить или проверить журнал событий. Возвращается: всегда Пример: `""`
stdout строка	Полный `helm` вывод команды. Если не указан параметр output_dir, он будет содержать отрендеренные шаблоны как конкатенированные документы YAML. Возвращается: всегда Пример: `""`

Авторы

Mike Graves (@gravesm)

Ссылки на сборку

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