From 0a9413beefef1c36b55df280b0ad593d9d5a8393 Mon Sep 17 00:00:00 2001 From: Maciej Kwiek Date: Thu, 5 Jan 2017 15:20:24 +0100 Subject: [PATCH] Improve `helm status` help text `helm status -h` now shows what kind of information is displayed when running `helm status` --- cmd/helm/status.go | 6 ++++++ docs/helm/helm_status.md | 6 ++++++ docs/man/man1/helm_status.1 | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/cmd/helm/status.go b/cmd/helm/status.go index 92d4e3768..f97ba945e 100644 --- a/cmd/helm/status.go +++ b/cmd/helm/status.go @@ -29,6 +29,12 @@ import ( var statusHelp = ` This command shows the status of a named release. +The status consists of: +- last deployment time +- k8s namespace in which the release lives +- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING) +- list of resources that this release consists of, sorted by kind +- additional notes provided by the chart ` type statusCmd struct { diff --git a/docs/helm/helm_status.md b/docs/helm/helm_status.md index 197bc6e2d..ac7434e4d 100644 --- a/docs/helm/helm_status.md +++ b/docs/helm/helm_status.md @@ -7,6 +7,12 @@ displays the status of the named release This command shows the status of a named release. +The status consists of: +- last deployment time +- k8s namespace in which the release lives +- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING) +- list of resources that this release consists of, sorted by kind +- additional notes provided by the chart ``` diff --git a/docs/man/man1/helm_status.1 b/docs/man/man1/helm_status.1 index f6e90b290..2de465b3c 100644 --- a/docs/man/man1/helm_status.1 +++ b/docs/man/man1/helm_status.1 @@ -16,6 +16,12 @@ helm\-status \- displays the status of the named release .SH DESCRIPTION .PP This command shows the status of a named release. +The status consists of: +- last deployment time +- k8s namespace in which the release lives +- state of the release (can be: UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED or DELETING) +- list of resources that this release consists of, sorted by kind +- additional notes provided by the chart .SH OPTIONS