diff options
author | Martin Polden <mpolden@mpolden.no> | 2023-10-12 15:38:37 +0200 |
---|---|---|
committer | Martin Polden <mpolden@mpolden.no> | 2023-10-12 15:51:50 +0200 |
commit | 9ac3c380ff55d09f5899a92de96718842a088af0 (patch) | |
tree | 9077205b9d48c94cdbad634ae772cb292eca07d3 | |
parent | f8b9cdcde2ca96a311cbecd6b1229d18f37b116a (diff) |
Improve vespa status documentation
-rw-r--r-- | client/go/internal/cli/cmd/status.go | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/client/go/internal/cli/cmd/status.go b/client/go/internal/cli/cmd/status.go index b10801ae546..001f4ba43f1 100644 --- a/client/go/internal/cli/cmd/status.go +++ b/client/go/internal/cli/cmd/status.go @@ -25,9 +25,14 @@ func newStatusCmd(cli *CLI) *cobra.Command { "status document", // TODO: Remove on Vespa 9 "status query", // TODO: Remove on Vespa 9 }, - Short: "Verify that container service(s) are ready to use", + Short: "Show Vespa endpoints and status", + Long: `Show Vespa endpoints and status. + +This command shows the current endpoints, and their status, of a deployed Vespa +application.`, Example: `$ vespa status -$ vespa status --cluster mycluster`, +$ vespa status --cluster mycluster +$ vespa status --cluster mycluster --wait 600`, DisableAutoGenTag: true, SilenceUsage: true, Args: cobra.MaximumNArgs(1), @@ -68,7 +73,7 @@ func newStatusDeployCmd(cli *CLI) *cobra.Command { var waitSecs int cmd := &cobra.Command{ Use: "deploy", - Short: "Verify that the deploy service is ready to use", + Short: "Show status of the Vespa deploy service", Example: `$ vespa status deploy`, DisableAutoGenTag: true, SilenceUsage: true, @@ -95,10 +100,17 @@ func newStatusDeploymentCmd(cli *CLI) *cobra.Command { var waitSecs int cmd := &cobra.Command{ Use: "deployment", - Short: "Verify that deployment has converged on latest, or given, ID", + Short: "Show status of a Vespa deployment", + Long: `Show status of a Vespa deployment. + +This commands shows whether a Vespa deployment has converged on the latest run + (Vespa Cloud) or config generation (self-hosted). If an argument is given, +show the convergence status of that particular run or generation. +`, Example: `$ vespa status deployment $ vespa status deployment -t cloud [run-id] $ vespa status deployment -t local [session-id] +$ vespa status deployment -t local [session-id] --wait 600 `, DisableAutoGenTag: true, SilenceUsage: true, |