fluxcd
/
helm-controller
mirror of https://github.com/fluxcd/helm-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/spec/v2beta2: add uninstall warnings 

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
This commit is contained in:
Hidde Beydals 2023-12-06 19:06:17 +01:00
parent d741525b2f
commit aeef72abbf
No known key found for this signature in database
GPG Key ID: 979F380FC2341744
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/spec/v2beta2/helmreleases.md
View File

@ -162,6 +162,10 @@ The HelmChart is created in the same namespace as the `.sourceRef`, with a name
matching the HelmRelease's `<.metadata.namespace>-<.metadata.name>`, and will matching the HelmRelease's `<.metadata.namespace>-<.metadata.name>`, and will
be reported in `.status.helmChart`. be reported in `.status.helmChart`.
**Warning:** Changing the `.spec.chart` to a Helm chart with a different name
(as specified in the chart's `Chart.yaml`) will cause the controller to
uninstall any previous release before installing the new one.
**Note:** On multi-tenant clusters, platform admins can disable cross-namespace **Note:** On multi-tenant clusters, platform admins can disable cross-namespace
references with the `--no-cross-namespace-refs=true` flag. When this flag is references with the `--no-cross-namespace-refs=true` flag. When this flag is
set, the HelmRelease can only refer to Sources in the same namespace as the set, the HelmRelease can only refer to Sources in the same namespace as the
@ -172,6 +176,10 @@ HelmRelease object.
`.spec.releaseName` is an optional field used to specify the name of the Helm `.spec.releaseName` is an optional field used to specify the name of the Helm
release. It defaults to a composition of `[<target namespace>-]<name>`. release. It defaults to a composition of `[<target namespace>-]<name>`.
**Warning:** Changing the release name of a HelmRelease which has already been
installed will not rename the release. Instead, the existing release will be
uninstalled before installing a new release with the new name.
**Note:** When the composition exceeds the maximum length of 53 characters, the **Note:** When the composition exceeds the maximum length of 53 characters, the
name is shortened by hashing the release name with SHA-256. The resulting name name is shortened by hashing the release name with SHA-256. The resulting name
is then composed of the first 40 characters of the release name, followed by a is then composed of the first 40 characters of the release name, followed by a
@ -185,12 +193,22 @@ dash (`-`), followed by the 12 characters of the hash. For example,
which the Helm release is made. It defaults to the namespace of the which the Helm release is made. It defaults to the namespace of the
HelmRelease. HelmRelease.
**Warning:** Changing the target namespace of a HelmRelease which has already
been installed will not move the release to the new namespace. Instead, the
existing release will be uninstalled before installing a new release in the new
target namespace.
### Storage namespace ### Storage namespace
`.spec.storageNamespace` is an optional field used to specify the namespace `.spec.storageNamespace` is an optional field used to specify the namespace
in which Helm stores release information. It defaults to the namespace of the in which Helm stores release information. It defaults to the namespace of the
HelmRelease. HelmRelease.
**Warning:** Changing the storage namespace of a HelmRelease which has already
been installed will not move the release to the new namespace. Instead, the
existing release will be uninstalled before installing a new release in the new
storage namespace.
**Note:** When making use of the Helm CLI and attempting to make use of **Note:** When making use of the Helm CLI and attempting to make use of
`helm get` commands to inspect a release, the `-n` flag should target the `helm get` commands to inspect a release, the `-n` flag should target the
storage namespace of the HelmRelease. storage namespace of the HelmRelease.
@ -737,8 +755,6 @@ resume.
## Working with HelmReleases ## Working with HelmReleases
### The reconciliation model
### Configuring failure handling ### Configuring failure handling
From time to time, a Helm installation, upgrade, or accompanying [Helm test](#test-configuration) From time to time, a Helm installation, upgrade, or accompanying [Helm test](#test-configuration)