From 4707a3075e0fa51c1f8af98b1c9a8c68261de45a Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 20 Aug 2020 15:00:54 +0200 Subject: [PATCH] Document targetPath in Helm Releases guide --- docs/guides/helmreleases.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/docs/guides/helmreleases.md b/docs/guides/helmreleases.md index 4da9d556..fef81944 100644 --- a/docs/guides/helmreleases.md +++ b/docs/guides/helmreleases.md @@ -87,7 +87,7 @@ artifact of the referenced `HelmRepository`, fetch the chart, and make it available as a `HelmChart` artifact to be used by the helm-controller. -!!! Note +!!! hint "Advanced configuration" The `HelmRelease` offers an extensive set of configurable flags for finer grain control over how Helm actions are performed. See the [`HelmRelease` CRD docs](../components/helm/helmreleases.md) @@ -106,9 +106,11 @@ spec: valuesFrom: - kind: ConfigMap name: prod-env-values + valuesKey: values-prod.yaml - kind: Secret - name: prod-secret-values - valuesKey: secret.yaml + name: prod-tls-values + valuesKey: crt + targetPath: tls.crt ``` The definition of the listed keys is as follows: @@ -116,8 +118,20 @@ The definition of the listed keys is as follows: - `kind`: Kind of the values referent (`ConfigMap` or `Secret`). - `name`: Name of the values referent, in the same namespace as the `HelmRelease`. -- `valuesKey` _(Optional)_: The key in the referent the values can be - found at. Defaults to `values.yaml` when ommitted. +- `valuesKey` _(Optional)_: The data key where the values.yaml or a + specific value can be found. Defaults to `values.yaml` when omitted. +- `targetPath` _(Optional)_: The YAML dot notation path at which the + value should be merged. When set, the `valuesKey` is expected to be + a single flat value. Defaults to `None` when omitted, which results + in the values getting merged at the root. + +!!! hint "Note" + The `targetPath` supports the same formatting as you would supply + as an argument to the `helm` binary using `--set [path]=[value]`. + In addition to this, the referred value can contain the same + value formats (e.g. `{a,b,c}` for a list). + You can read more about the available formats and limitations in + the [Helm documentation](https://helm.sh/docs/intro/using_helm/#the-format-and-limitations-of---set). ## Configure notifications