Skip to main content
Version: Next 🚧

Custom values for service Helm charts

Audience​

This documentation is for Epinio operators specifying custom services for users, and users creating instances of those custom services who need to customize them.

It shows operators how to specify user settings based on the form of the field in the values.yaml file of the underlying service Helm chart.

It also shows Epinio users how to set values for the user settings of a service.

General information​

Operators, should see Creating A Custom Service for the general syntax of user settings.

For users, the relevant option is --chart-value (short: -v) of the epinio service create command.

Following is a series of examples showing how you specify forms of Helm chart values in the custom services and then using --chart-value.

Examples​

All the examples have the same structure. The tables show, side by side,

  • how the field looks like in the values.yaml of the underlying service,
  • how you specify the field in the custom service, and
  • how you address it as a user using --chart-value.

Basic map, simple value​

This example assumes that the field value is of a simple type T, that is, string, integer, number, or bool.

values.yamlService specCLI usage
foo:
  bar: value

settings:
  "foo.bar":
    type: "T"

-v "foo.bar=value"

Basic array, simple value​

This example assumes that the field value is of a simple type T, that is, string, integer, number, or bool.

The field name in the service spec doesn't mention that bar is an array. Here, the name foo.bar, in the service spec, describes the path to the field.

values.yamlService specCLI usage
foo:
  bar:
    - value1
    - value2
    - ...

settings:
  "foo.bar":
    type: "T"

-v "foo.bar[0]=value1"
-v "foo.bar[1]=value2"
...

Mixed map and array, simple values​

This example assumes that the value field is a simple type T, that is, string, integer, number, or bool.

Here, foo is the array, having maps as elements, of which the keys name and value are of interest.

The names of the field don't mention that foo is an array, and the paths to fields of interest are used to name them in the CLI settings.

values.yamlService specCLI usage
foo:
  - name: name1
    value: value1
  - name: name2
    value: value2
  - ...

settings:
  "foo.name":
    type: "string"
  "foo.value":
    type: "T"

-v "foo[0].name=name1"
-v "foo[0].value=value1"
-v "foo[1].name=name2"
-v "foo[1].value=value2"
...

Map-valued map​

This example assumes that the field value is a map itself, with arbitrary keys, and values. An example would be the annotation fields provided by Bitnami services enabling the user to set custom annotations on the groups of pods of the service.

values.yamlService specCLI usage
foo:
  bar:
    key1: value1
    key2: value2
    ...

settings:
  "foo.bar":
    type: "map"

-v "foo.bar.key1=value1
-v "foo.bar.key2=value2
...