diff options
author | Daniel J Walsh <dwalsh@redhat.com> | 2019-03-06 17:10:20 -0500 |
---|---|---|
committer | Daniel J Walsh <dwalsh@redhat.com> | 2019-03-07 13:46:59 -0500 |
commit | 9a39c60e46d927489efa0ef5d4ece7c76fceceb7 (patch) | |
tree | 980c7dec92a361532a18c601f3fb34767e99b0f4 /cmd/podman/play_kube.go | |
parent | 1b253cf73a360557196213684cec63b37407ed7c (diff) | |
download | podman-9a39c60e46d927489efa0ef5d4ece7c76fceceb7.tar.gz podman-9a39c60e46d927489efa0ef5d4ece7c76fceceb7.tar.bz2 podman-9a39c60e46d927489efa0ef5d4ece7c76fceceb7.zip |
Fix help commands to show short and long description.
Cleanup lots of help information to look good when displayed.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'cmd/podman/play_kube.go')
-rw-r--r-- | cmd/podman/play_kube.go | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/cmd/podman/play_kube.go b/cmd/podman/play_kube.go index 1910b68b5..980f3a09c 100644 --- a/cmd/podman/play_kube.go +++ b/cmd/podman/play_kube.go @@ -32,8 +32,10 @@ const ( var ( playKubeCommand cliconfig.KubePlayValues - playKubeDescription = "Play a Pod and its containers based on a Kubrernetes YAML" - _playKubeCommand = &cobra.Command{ + playKubeDescription = `Command reads in a structured file of Kubernetes YAML. + + It creates the pod and containers described in the YAML. The containers within the pod are then started and the ID of the new Pod is output.` + _playKubeCommand = &cobra.Command{ Use: "kube [flags] KUBEFILE", Short: "Play a pod based on Kubernetes YAML", Long: playKubeDescription, @@ -49,6 +51,7 @@ var ( func init() { playKubeCommand.Command = _playKubeCommand + playKubeCommand.SetHelpTemplate(HelpTemplate()) playKubeCommand.SetUsageTemplate(UsageTemplate()) flags := playKubeCommand.Flags() flags.StringVar(&playKubeCommand.Authfile, "authfile", "", "Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. Use REGISTRY_AUTH_FILE environment variable to override") |