Skip to content

📄 Templating

Helmwave uses Go templates for templating.

Helmwave supports all built-in functions / sprig / gomplate / custom.

Sprig

If you've ever written helm charts, then you're already familiar with it.

http://masterminds.github.io/sprig/

Gomplate

Since v0.14.0. Helmwave works with Gomplate.

How to enable gomplate for v0.14.0 and later

helmwave.yml

template:
  gomplate:
    enabled: true

see example

Issues

  • https://github.com/helmwave/helmwave/issues/159
  • https://github.com/helmwave/helmwave/issues/103

Custom

  • toYaml marshals a map into a string
  • fromYaml reads a golang string and generates a map
  • readFile get file as string
  • hasKey get true if field is exists
  • get (Sprig's original get is available as sprigGet)
  • setValueAtPath PATH NEW_VALUE traverses a golang map, replaces the value at the PATH with NEW_VALUE
  • requiredEnv The requiredEnv function allows you to declare a particular environment variable as required for template rendering. If the environment variable is unset or empty, the template rendering will fail with an error message.
Back to top