Merge pull request #39359 from tianshapjq/add-top-specification

Automatic merge from submit-queue

add some specifications on the top command

**What this PR does / why we need it**:
the top command is available when heapster works fine on the server, but the specifications doesn't mention about this. So I added some specifications here.
This commit is contained in:
Kubernetes Submit Queue 2017-01-04 08:45:54 -08:00 committed by GitHub
commit 17f8d82fa3

View File

@ -32,13 +32,15 @@ var (
topLong = templates.LongDesc(`
Display Resource (CPU/Memory/Storage) usage.
The top command allows you to see the resource consumption for nodes or pods.`)
The top command allows you to see the resource consumption for nodes or pods.
This command requires Heapster to be correctly configured and working on the server. `)
)
func NewCmdTop(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command {
cmd := &cobra.Command{
Use: "top",
Short: "Display Resource (CPU/Memory/Storage) usage",
Short: "Display Resource (CPU/Memory/Storage) usage.",
Long: topLong,
Run: cmdutil.DefaultSubCommandRun(errOut),
}