From ba35b0046182dea0094db715cbab64785bb9bf82 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Wed, 16 Feb 2022 12:14:01 +0100 Subject: [PATCH] docs/spec: document Helm uninstall wait behavior Signed-off-by: Hidde Beydals --- docs/spec/v2beta1/helmreleases.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/spec/v2beta1/helmreleases.md b/docs/spec/v2beta1/helmreleases.md index 41438db..027499e 100644 --- a/docs/spec/v2beta1/helmreleases.md +++ b/docs/spec/v2beta1/helmreleases.md @@ -433,6 +433,11 @@ type Uninstall struct { // release as deleted, but retain the release history. // +optional KeepHistory bool `json:"keepHistory,omitempty"` + + // DisableWait disables waiting for all the resources to be deleted after + // a Helm uninstall is performed. + // +optional + DisableWait bool `json:"disableWait,omitempty"` } // Kustomize Helm PostRenderer specification. @@ -786,8 +791,8 @@ kubectl get all --all-namespaces \ ### Disabling resource waiting -For install, upgrade, and rollback actions resource waiting is enabled by default, -but can be disabled by setting `spec..disableWait`. +For install, upgrade, rollback, and uninstall actions resource waiting is +enabled by default, but can be disabled by setting `spec..disableWait`. Waiting for jobs to complete is enabled by default, but can be disabled by setting `spec..disableWaitForJobs`.