Config

The following general configuration options are available in the helmize.yaml

conditions

Required

Type slice

dropins

Required

Type slice

inventory_directory

Optional

Type string

Define a directory where the entire structure for helmize is located below. This path will be appended for all the condition’s paths.

templates_directory

Optional

Type string

Define a directory where all templates for the dropins templates are located below. This path will be appended for all the templates in all dropins

force

Optional

Type string Default false

If any file contains an error the template will fail. With force the template won’t fail even if there are errors. Files with errors will be skipped.

file_extensions

Optional

Type string/slice Default [ "yaml", "yml", "tpl" ]

Define which file extensions should be considered while looking through the directories. Just declare the extension without wildcard, this configuration does not accept regex pattern.

file_excludes

Optional

Type string/slice

Define which file names should be considered while looking through the directories. You can use regex patterns.

merge_strategy

Optional

Type string/slice Default path Valid Options file, path

Define how files are merged together.

Explanation ...

file

Merge file content based on file name. If you have multiple files with the exact same name in one condition folder or over multiple folders, they are considered to be one final file and merged together.

Let’s assume you have the following folder structure:

structure
|
+---stage/
|   +---dev/
|          release.yaml
|          subdir/release.yaml
|   ...
|
+---location/
|   +---east/
|          release.yaml
|          subdir/release.yaml
|   ...
+

All the files named release.yaml will be merged together and as output you will get a single release.yaml file.

path

Merge file content based on file subpath. If you have multiple files with teh exact same name but different subpaths they will not be merged together.

Let’s assume you have the following folder structure:

structure
|
+---stage/
|   +---dev/
|          release.yaml
|          subdir/release.yaml
|   ...
|
+---location/
|   +---east/
|          release.yaml
|          subdir/release.yaml
|   ...
+

The release.yaml files are merged together and the subdir/release.yaml are merged together.

identifier_template

Optional

Type string Default "inventory.render.templates.identifier"

Define a custom identifier template

render_template

Optional

Type string Default "inventory.entrypoint.templates.render"

Define a custom render template