update kubectl help output for better organization #25524

adohe-zz · 2016-05-12T06:18:38Z

Pull Request Guidelines

Please read our contributor guidelines.
See our developer guide.
Follow the instructions for labeling and writing a release note for this PR in the block below.

* Use the release-note-* labels to set the release note state 
* Clear this block to use the PR title as the release note 
-OR-
* Enter your extended release note here

This change is

adohe-zz · 2016-05-12T06:20:57Z

Please refer #21585 for more detail. Add the initial implementation, @bgrant0607 @smarterclayton @janetkuo ptal.

bgrant0607 · 2016-05-12T06:24:49Z

Thanks @adohe!

janetkuo · 2016-05-12T17:28:18Z

.generated_docs

@@ -105,7 +107,11 @@ docs/user-guide/kubectl/kubectl_rollout_resume.md
 docs/user-guide/kubectl/kubectl_rollout_undo.md
 docs/user-guide/kubectl/kubectl_run.md
 docs/user-guide/kubectl/kubectl_scale.md
+<<<<<<< HEAD


unresolved merge conflict

janetkuo · 2016-05-12T17:29:23Z

Needs a rebase.

adohe-zz · 2016-05-13T02:23:05Z

@janetkuo will do it today.

smarterclayton · 2016-05-13T14:18:20Z

Looks mostly ok to me

janetkuo · 2016-05-13T18:10:06Z

pkg/kubectl/cmd/cmd.go

-	cmds.AddCommand(NewCmdConvert(f, out))
+	groups := templates.CommandGroups{
+		{
+			Message: "Basic Commads:",


typo: Commands

run and expose should be basics

janetkuo · 2016-05-13T18:20:26Z

@adohe can you put the help output in the PR description (and update it when updating this PR)?

janetkuo · 2016-05-13T18:47:59Z

pkg/kubectl/cmd/cmd.go

+				NewCmdRollingUpdate(f, out),
+				NewCmdScale(f, out),
+				NewCmdAutoscale(f, out),
+				rollout.NewCmdRollout(f, out),


More rollout to before rolling-update

adohe-zz · 2016-05-21T16:47:54Z

@janetkuo ptal. And the help output is:

[tony@localhost kubernetes]$ cluster/kubectl.sh --help
kubectl controls the Kubernetes cluster manager.

Find more information at https://github.com/kubernetes/kubernetes.

Basic Commands:
  create         Create a resource by filename or stdin
  get            Display one or many resources
  edit           Edit a resource on the server
  set            Set specific features on objects
  delete         Delete resources by filenames, stdin, resources and names, or by resources and label selector.
  explain        Documentation of resources.
  run            Run a particular image on the cluster.
  expose         Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service

Deploy Commands:
  rollout        rollout manages a deployment
  rolling-update Perform a rolling update of the given ReplicationController.
  scale          Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
  autoscale      Auto-scale a Deployment, ReplicaSet, or ReplicationController

Cluster Management Commands:
  cluster-info   Display cluster info
  cordon         Mark node as unschedulable
  drain          Drain node in preparation for maintenance
  uncordon       Mark node as schedulable
  taint          Update the taints on one or more nodes

Troubleshooting and Debugging Commands:
  describe       Show details of a specific resource or group of resources
  logs           Print the logs for a container in a pod.
  attach         Attach to a running container.
  exec           Execute a command in a container.
  port-forward   Forward one or more local ports to a pod.
  proxy          Run a proxy to the Kubernetes API server

Advanced Commands:
  patch          Update field(s) of a resource using strategic merge patch.
  replace        Replace a resource by filename or stdin.
  apply          Apply a configuration to a resource by filename or stdin
  convert        Convert config files between different API versions

Settings Commands:
  config         config modifies kubeconfig files
  label          Update the labels on a resource
  annotate       Update the annotations on a resource

Other Commands:
  version        Print the client and server version information.
  api-versions   Print the supported API versions on the server, in the form of "group/version".
  help           Help about any command

Use "kubectl help <command>" for more information about a given command.
Use "kubectl options" for a list of global command-line options (applies to all commands).

janetkuo · 2016-05-23T17:04:29Z

@adohe thanks! Looks pretty nice.
A few more suggestions:

config: does it belong to Cluster Management?
apply: suggest putting it to be the first of advanced commands
place uncordon right after cordon

smarterclayton · 2016-05-23T17:11:43Z

I don't think of config as managing clusters - it's possible the name of Cluster Management should be clearer.

adohe-zz · 2016-08-19T03:13:36Z

[root@localhost kubernetes]# kc help
kubectl controls the Kubernetes cluster manager.

Find more information at https://github.com/kubernetes/kubernetes.
Basic Commands (Beginner):
  create         Create a resource by filename or stdin
  expose         Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service
  run            Run a particular image on the cluster
  set            Set specific features on objects

Basic Commands (Intermediate):
  get            Display one or many resources
  explain        Documentation of resources
  edit           Edit a resource on the server
  delete         Delete resources by filenames, stdin, resources and names, or by resources and label selector

Deploy Commands:
  rollout        Manage a deployment rollout
  rolling-update Perform a rolling update of the given ReplicationController
  scale          Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job
  autoscale      Auto-scale a Deployment, ReplicaSet, or ReplicationController

Cluster Management Commands:
  cluster-info   Display cluster info
  top            Display Resource (CPU/Memory/Storage) usage
  cordon         Mark node as unschedulable
  uncordon       Mark node as schedulable
  drain          Drain node in preparation for maintenance
  taint          Update the taints on one or more nodes

Troubleshooting and Debugging Commands:
  describe       Show details of a specific resource or group of resources
  logs           Print the logs for a container in a pod
  attach         Attach to a running container
  exec           Execute a command in a container
  port-forward   Forward one or more local ports to a pod
  proxy          Run a proxy to the Kubernetes API server

Advanced Commands:
  apply          Apply a configuration to a resource by filename or stdin
  patch          Update field(s) of a resource using strategic merge patch
  replace        Replace a resource by filename or stdin
  convert        Convert config files between different API versions

Settings Commands:
  label          Update the labels on a resource
  annotate       Update the annotations on a resource
  completion     Output shell completion code for the given shell (bash or zsh)

Other Commands:
  api-versions   Print the supported API versions on the server, in the form of "group/version"
  config         Modify kubeconfig files
  help           Help about any command
  version        Print the client and server version information


Usage:
  kubectl [command]

Use "kubectl <command> --help" for more information about a given command.
Use "kubectl options" for a list of global command-line options (applies to all commands).

[root@localhost kubernetes]# kc --help
kubectl controls the Kubernetes cluster manager.

Find more information at https://github.com/kubernetes/kubernetes.
Basic Commands (Beginner):
  create         Create a resource by filename or stdin
  expose         Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service
  run            Run a particular image on the cluster
  set            Set specific features on objects

Basic Commands (Intermediate):
  get            Display one or many resources
  explain        Documentation of resources
  edit           Edit a resource on the server
  delete         Delete resources by filenames, stdin, resources and names, or by resources and label selector

Deploy Commands:
  rollout        Manage a deployment rollout
  rolling-update Perform a rolling update of the given ReplicationController
  scale          Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job
  autoscale      Auto-scale a Deployment, ReplicaSet, or ReplicationController

Cluster Management Commands:
  cluster-info   Display cluster info
  top            Display Resource (CPU/Memory/Storage) usage
  cordon         Mark node as unschedulable
  uncordon       Mark node as schedulable
  drain          Drain node in preparation for maintenance
  taint          Update the taints on one or more nodes

Troubleshooting and Debugging Commands:
  describe       Show details of a specific resource or group of resources
  logs           Print the logs for a container in a pod
  attach         Attach to a running container
  exec           Execute a command in a container
  port-forward   Forward one or more local ports to a pod
  proxy          Run a proxy to the Kubernetes API server

Advanced Commands:
  apply          Apply a configuration to a resource by filename or stdin
  patch          Update field(s) of a resource using strategic merge patch
  replace        Replace a resource by filename or stdin
  convert        Convert config files between different API versions

Settings Commands:
  label          Update the labels on a resource
  annotate       Update the annotations on a resource
  completion     Output shell completion code for the given shell (bash or zsh)

Other Commands:
  api-versions   Print the supported API versions on the server, in the form of "group/version"
  config         Modify kubeconfig files
  help           Help about any command
  version        Print the client and server version information


Usage:
  kubectl [command]

Use "kubectl <command> --help" for more information about a given command.
Use "kubectl options" for a list of global command-line options (applies to all commands).

since kubectl top is a new command, I just put it in cluster management part, is that ok? @smarterclayton @janetkuo @fabianofranz ptal.

fabianofranz · 2016-08-19T18:01:01Z

@adohe looks like there are a few problems with linebreak balancing (some missing, some places with two in a row), left from the changes required to move the Usage section to the bottom. Give me a few minutes to fix it then I'll PR it to your repo so you can add it here.

smarterclayton · 2016-08-19T18:37:11Z

I think cluster management is the right place for top.

On Fri, Aug 19, 2016 at 2:01 PM, Fabiano Franz notifications@github.com
wrote:

@adohe https://github.com/AdoHe looks like there are a few problems
with linebreak balancing (some missing, some places with two in a row),
left from the changes required to move the Usage section to the bottom.
Give me a few minutes to fix it then I'll PR it to your repo so you can add
it here.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#25524 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABG_p_pNHu-H-8m6p-biNjbzBZTUcytSks5qhe9sgaJpZM4IcwGY
.

janetkuo · 2016-08-19T18:38:14Z

+1 for putting top under cluster management

googlebot · 2016-08-19T23:56:51Z

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

fabianofranz · 2016-08-20T00:42:01Z

LGTM after the changes in adohe-zz#1 were included. @smarterclayton @janetkuo mind looking and tagging?

adohe-zz · 2016-08-20T00:46:05Z

@fabianofranz really thanks for your help :)

adohe-zz · 2016-08-20T01:26:32Z

@k8s-bot test this issue: #IGNORE

adohe-zz · 2016-08-20T01:26:54Z

@janetkuo ptal.

adohe-zz · 2016-08-20T11:57:39Z

@k8s-bot test this issue: #IGNORE

adohe-zz · 2016-08-21T14:19:13Z

@k8s-bot test this issue: #IGNORE

k8s-bot · 2016-08-21T14:57:09Z

GCE e2e build/test passed for commit b411fe2.

k8s-github-robot · 2016-08-21T15:32:44Z

@k8s-bot test this [submit-queue is verifying that this PR is safe to merge]

k8s-bot · 2016-08-21T16:08:48Z

GCE e2e build/test passed for commit b411fe2.

k8s-github-robot · 2016-08-21T16:08:56Z

Automatic merge from submit-queue

googlebot added the cla: yes label May 12, 2016

bgrant0607 assigned janetkuo May 12, 2016

k8s-github-robot added kind/old-docs size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels May 12, 2016

k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 12, 2016

janetkuo added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-label-needed labels May 12, 2016

janetkuo reviewed May 12, 2016
View reviewed changes

janetkuo reviewed May 13, 2016
View reviewed changes

adohe-zz force-pushed the kubectl_reorg branch 2 times, most recently from 9c83195 to 2d71cb2 Compare May 21, 2016 16:46

k8s-github-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 21, 2016

adohe-zz force-pushed the kubectl_reorg branch from 2d71cb2 to 5b123a3 Compare May 22, 2016 03:36

k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 22, 2016

adohe-zz force-pushed the kubectl_reorg branch from 5b123a3 to 0d8e99a Compare May 23, 2016 02:46

k8s-github-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 23, 2016

adohe-zz force-pushed the kubectl_reorg branch 2 times, most recently from 9c343b8 to 9ab896b Compare August 19, 2016 04:07

fabianofranz mentioned this pull request Aug 19, 2016

Several fixes to the help templating engine adohe-zz/kubernetes#1

Merged

googlebot added cla: no and removed cla: yes labels Aug 19, 2016

update kubectl help output for better organization

b411fe2

adohe-zz force-pushed the kubectl_reorg branch from c92d139 to b411fe2 Compare August 20, 2016 00:03

googlebot added cla: yes and removed cla: no labels Aug 20, 2016

smarterclayton added this to the v1.4 milestone Aug 20, 2016

smarterclayton added priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Aug 20, 2016

k8s-github-robot mentioned this pull request Aug 20, 2016

[k8s.io] ScheduledJob should not schedule new jobs when ForbidConcurrent {Kubernetes e2e suite} #30549

Closed

k8s-github-robot merged commit a956dd1 into kubernetes:master Aug 21, 2016

adohe-zz deleted the kubectl_reorg branch August 21, 2016 23:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update kubectl help output for better organization #25524

update kubectl help output for better organization #25524

adohe-zz commented May 12, 2016 •

edited by k8s-oncall

Loading

adohe-zz commented May 12, 2016 •

edited

Loading

bgrant0607 commented May 12, 2016

janetkuo May 12, 2016

janetkuo commented May 12, 2016

adohe-zz commented May 13, 2016

smarterclayton commented May 13, 2016

janetkuo May 13, 2016

janetkuo May 13, 2016

janetkuo commented May 13, 2016

janetkuo May 13, 2016

janetkuo May 19, 2016

adohe-zz commented May 21, 2016

janetkuo commented May 23, 2016

smarterclayton commented May 23, 2016

adohe-zz commented Aug 19, 2016 •

edited

Loading

fabianofranz commented Aug 19, 2016

smarterclayton commented Aug 19, 2016

janetkuo commented Aug 19, 2016

googlebot commented Aug 19, 2016

fabianofranz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 21, 2016

k8s-bot commented Aug 21, 2016

k8s-github-robot commented Aug 21, 2016

k8s-bot commented Aug 21, 2016

k8s-github-robot commented Aug 21, 2016

update kubectl help output for better organization #25524

update kubectl help output for better organization #25524

Conversation

adohe-zz commented May 12, 2016 • edited by k8s-oncall Loading

Pull Request Guidelines

adohe-zz commented May 12, 2016 • edited Loading

bgrant0607 commented May 12, 2016

janetkuo May 12, 2016

Choose a reason for hiding this comment

janetkuo commented May 12, 2016

adohe-zz commented May 13, 2016

smarterclayton commented May 13, 2016

janetkuo May 13, 2016

Choose a reason for hiding this comment

janetkuo May 13, 2016

Choose a reason for hiding this comment

janetkuo commented May 13, 2016

janetkuo May 13, 2016

Choose a reason for hiding this comment

janetkuo May 19, 2016

Choose a reason for hiding this comment

adohe-zz commented May 21, 2016

janetkuo commented May 23, 2016

smarterclayton commented May 23, 2016

adohe-zz commented Aug 19, 2016 • edited Loading

fabianofranz commented Aug 19, 2016

smarterclayton commented Aug 19, 2016

janetkuo commented Aug 19, 2016

googlebot commented Aug 19, 2016

fabianofranz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 20, 2016

adohe-zz commented Aug 21, 2016

k8s-bot commented Aug 21, 2016

k8s-github-robot commented Aug 21, 2016

k8s-bot commented Aug 21, 2016

k8s-github-robot commented Aug 21, 2016

adohe-zz commented May 12, 2016 •

edited by k8s-oncall

Loading

adohe-zz commented May 12, 2016 •

edited

Loading

adohe-zz commented Aug 19, 2016 •

edited

Loading