kubernetes.core.helm_template_module.rst

kubernetes.core.helm_template

Render chart templates

• Synopsis
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Render chart templates to an output directory or as text of concatenated yaml documents.

Parameters

Parameter		Choices/Defaults	Comments
binary_path path			The path of a helm binary to use.
chart_ref path / required			Chart reference with repo prefix, for example, nginx-stable/nginx-ingress. Path to a packaged chart. Path to an unpacked chart directory. Absolute URL.
chart_repo_url string			Chart repository URL where the requested chart is located.
chart_version string			Chart version to use. If this is not specified, the latest version is installed.
dependency_update boolean added in 2.4.0		Choices: no ← yes	Run helm dependency update before the operation. The dependency_update option require the add of dependencies block in Chart.yaml/requirements.yaml file. For more information please visit https://helm.sh/docs/helm/helm_dependency/ aliases: dep_up
disable_hook boolean added in 2.4.0		Choices: no ← yes	Prevent hooks from running during install.
include_crds boolean		Choices: no ← yes	Include custom resource descriptions in rendered templates.
output_dir path			Output directory where templates will be written. If the directory already exists, it will be overwritten.
release_name string added in 2.4.0			Release name to use in rendered templates. aliases: name
release_namespace string added in 2.4.0			namespace scope for this request.
release_values dictionary		Default: {}	Values to pass to chart. aliases: values
set_values list / elements=dictionary added in 2.4.0			Values to pass to chart configuration.
	value string / required		Value to pass to chart configuration (e.g phase=prod).
	value_type -	Choices: raw ← string json file	Use raw set individual value. Use string to force a string for an individual value. Use file to set individual values from a file when the value itself is too long for the command line or is dynamically generated. Use json to set json values (scalars/objects/arrays). This feature requires helm>=3.10.0.
show_only list / elements=string added in 2.4.0		Default: []	Only show manifests rendered from the given templates.
update_repo_cache boolean		Choices: no ← yes	Run helm repo update before the operation. Can be run as part of the template generation or as a separate step.
values_files list / elements=string		Default: []	Value files to pass to chart. Paths will be read from the target host's filesystem, not the host running ansible. values_files option is evaluated before values option if both are used. Paths are evaluated in the order the paths are specified.

Examples

- 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 }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
command string	always	Full helm command run by this module, in case you want to re-run the command outside the module or debug a problem. Sample: helm template --output-dir mychart nginx-stable/nginx-ingress
stderr string	always	Full helm command stderr, in case you want to display it or examine the event log.
stdout string	always	Full helm command stdout. If no output_dir has been provided this will contain the rendered templates as concatenated yaml documents.

Status

Authors

• Mike Graves (@gravesm)