Skip to content

Commit

Permalink
Explicitly document targetNamespace behaviour
Browse files Browse the repository at this point in the history
  • Loading branch information
hiddeco committed Sep 30, 2020
1 parent 763329d commit f50dca2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ spec:
metadata:
type: object
spec:
description: HelmReleaseSpec defines the desired state of a Helm Release.
description: HelmReleaseSpec defines the desired state of a Helm release.
properties:
chart:
description: Chart defines the template of the v1alpha1.HelmChart
Expand Down
16 changes: 9 additions & 7 deletions docs/spec/v2alpha1/helmreleases.md
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,10 @@ The namespace/name in which to deploy the Helm release defaults to the namespace
`spec.releaseName`. If `spec.targetNamespace` is set, `spec.releaseName` defaults to
`<spec.targetNamespace>-<metadata.name>`.

> **Note:** that configuring the `spec.targetNamespace` only defines the namespace the release
> is made in, the metadata for the release (also known as the "Helm storage") will always be
> stored in the `metadata.namespace` of the `HelmRelease`.
## Helm chart template

The `spec.chart.spec` values are used by the helm-controller as a template
Expand Down Expand Up @@ -594,13 +598,11 @@ The definition of the listed keys for items in `spec.valuesFrom` is as follows:
transient error will still result in a reconciliation failure. Defaults to `false`
when omitted.

!!! 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).
> **Note:** that 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).

## Reconciliation

Expand Down

0 comments on commit f50dca2

Please sign in to comment.