From 0c90fa4a754eac646a2e14995f5ee4885662b30a Mon Sep 17 00:00:00 2001 From: Alex Kreidler Date: Thu, 27 Jun 2019 09:21:50 -0400 Subject: [PATCH] Add docs Signed-off-by: Alex Kreidler --- cmd/helm/prune.go | 6 +++++ docs/helm/helm.md | 3 ++- docs/helm/helm_prune.md | 51 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 docs/helm/helm_prune.md diff --git a/cmd/helm/prune.go b/cmd/helm/prune.go index 354075b3b..0a5c45645 100644 --- a/cmd/helm/prune.go +++ b/cmd/helm/prune.go @@ -27,6 +27,12 @@ import ( const pruneDesc = ` This command purges all deleted releases, cleaning them from removing them permanently so they can't be rolled back. +Internally, it performs the 'helm list --deleted' command to find all releases with the stats 'Status_DELETED', +and then runs the 'helm delete --purge' command on those releases. + +The prune command is designed to encourage a workflow of not immediately purging releases. +This gives users the opportunity to 'rollback' a delete if necessary, and then 'prune' their releases +when they are sure that they are not necessary anymore. ` type pruneCmd struct { diff --git a/docs/helm/helm.md b/docs/helm/helm.md index ef9b729ab..73ff1ea39 100644 --- a/docs/helm/helm.md +++ b/docs/helm/helm.md @@ -67,6 +67,7 @@ Environment: * [helm list](helm_list.md) - List releases * [helm package](helm_package.md) - Package a chart directory into a chart archive * [helm plugin](helm_plugin.md) - Add, list, or remove Helm plugins +* [helm prune](helm_prune.md) - Purges deleted releases * [helm repo](helm_repo.md) - Add, list, remove, update, and index chart repositories * [helm reset](helm_reset.md) - Uninstalls Tiller from a cluster * [helm rollback](helm_rollback.md) - Rollback a release to a previous revision @@ -79,4 +80,4 @@ Environment: * [helm verify](helm_verify.md) - Verify that a chart at the given path has been signed and is valid * [helm version](helm_version.md) - Print the client/server version information -###### Auto generated by spf13/cobra on 16-May-2019 +###### Auto generated by spf13/cobra on 27-Jun-2019 diff --git a/docs/helm/helm_prune.md b/docs/helm/helm_prune.md new file mode 100644 index 000000000..a196200ee --- /dev/null +++ b/docs/helm/helm_prune.md @@ -0,0 +1,51 @@ +## helm prune + +Purges deleted releases + +### Synopsis + + +This command purges all deleted releases, cleaning them from removing them permanently so they can't be rolled back. +Internally, it performs the 'helm list --deleted' command to find all releases with the stats 'Status_DELETED', +and then runs the 'helm delete --purge' command on those releases. + +The prune command is designed to encourage a workflow of not immediately purging releases. +This gives users the opportunity to 'rollback' a delete if necessary, and then 'prune' their releases +when they are sure that they are not necessary anymore. + + +``` +helm prune [flags] +``` + +### Options + +``` + -h, --help help for prune + --no-hooks Prevent hooks from running during deletion + --timeout int Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks) (default 300) + --tls Enable TLS for request + --tls-ca-cert string Path to TLS CA certificate file (default "$HELM_HOME/ca.pem") + --tls-cert string Path to TLS certificate file (default "$HELM_HOME/cert.pem") + --tls-hostname string The server name used to verify the hostname on the returned certificates from the server + --tls-key string Path to TLS key file (default "$HELM_HOME/key.pem") + --tls-verify Enable TLS for request and verify remote +``` + +### Options inherited from parent commands + +``` + --debug Enable verbose output + --home string Location of your Helm config. Overrides $HELM_HOME (default "~/.helm") + --host string Address of Tiller. Overrides $HELM_HOST + --kube-context string Name of the kubeconfig context to use + --kubeconfig string Absolute path of the kubeconfig file to be used + --tiller-connection-timeout int The duration (in seconds) Helm will wait to establish a connection to Tiller (default 300) + --tiller-namespace string Namespace of Tiller (default "kube-system") +``` + +### SEE ALSO + +* [helm](helm.md) - The Helm package manager for Kubernetes. + +###### Auto generated by spf13/cobra on 27-Jun-2019