docs: clarify ownership metadata wording in install and upgrade help

The refusal condition referred to 'these annotations', but Helm tracks ownership with both the app.kubernetes.io/managed-by label and the meta.helm.sh release-name/release-namespace annotations. checkOwnership also errors when that metadata points to a different release or namespace, not only when it is absent. Reword both help texts to say 'this metadata' and to cover the mismatched release or namespace case.

Signed-off-by: Arnav Nagzirkar <113314200+arnavnagzirkar@users.noreply.github.com>
pull/32199/head
Arnav Nagzirkar 3 months ago
parent 4036737849
commit ceb6bfd516

@ -138,9 +138,10 @@ resource it creates:
- Annotation: meta.helm.sh/release-namespace=<release-namespace> - Annotation: meta.helm.sh/release-namespace=<release-namespace>
These are used to track ownership. If a resource already exists in the cluster These are used to track ownership. If a resource already exists in the cluster
without these annotations, Helm will refuse to install and return an error. To without this metadata, or with metadata pointing to a different release or
adopt pre-existing resources into the release, use '--take-ownership'. Helm will namespace, Helm will refuse to install and return an error. To adopt such
then add the ownership metadata and manage those resources going forward. pre-existing resources into the release, use '--take-ownership'. Helm will then
add the ownership metadata and manage those resources going forward.
` `
func newInstallCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { func newInstallCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {

@ -89,10 +89,10 @@ Helm tracks ownership of Kubernetes resources using the following metadata:
- Annotation: meta.helm.sh/release-name=<release-name> - Annotation: meta.helm.sh/release-name=<release-name>
- Annotation: meta.helm.sh/release-namespace=<release-namespace> - Annotation: meta.helm.sh/release-namespace=<release-namespace>
During an upgrade, if a resource exists in the cluster without these annotations During an upgrade, if a resource exists in the cluster without this metadata
(or with annotations pointing to a different release), Helm will return an error. (or with metadata pointing to a different release or namespace), Helm will
To take ownership of such resources and have Helm manage them going forward, use return an error. To take ownership of such resources and have Helm manage them
'--take-ownership'. going forward, use '--take-ownership'.
` `
func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command { func newUpgradeCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {

Loading…
Cancel
Save