Add a 'kubectl clusterinfo dump' option #20672

brendandburns · 2016-02-04T22:14:58Z

@bgrant0607 @smarterclayton @jszczepkowski

Usage:

  # Dump current cluster state to stdout
  kubectl clusterinfo dump

  # Dump current cluster state to /tmp
  kubectl clusterinfo dump --output-directory=/tmp

  # Dump all namespaces to stdout
  kubectl clusterinfo dump --all-namespaces

  # Dump a set of namespaces to /tmp
  kubectl clusterinfo dump --namespaces default,kube-system --output-directory=/tmp

This change is

smarterclayton · 2016-02-04T22:36:25Z

Is this mostly just an alias for kubectl get pods,nodes,rc,events -o yaml > file?

brendandburns · 2016-02-04T22:42:59Z

@smarterclayton more importantly (imho) it dumps the logs for each pod.

You definitely could do this in bash, but it seems less useful.

--brendan

smarterclayton · 2016-02-05T00:56:59Z

Ok - yeah, I don't have an issue with a mustgather style command.

bgrant0607 · 2016-02-05T02:43:01Z

cc @kubernetes/kubectl @dchen1107

bgrant0607 · 2016-02-05T03:21:11Z

pkg/kubectl/cmd/clusterinfo_dump.go

+		},
+	}
+	cmd.Flags().String("output-directory", "", "Where to output the files.  If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory")
+	cmd.Flags().StringSlice("namespaces", []string{api.NamespaceSystem}, "A comma separated list of namespaces to dump.")


Dumping the system namespace by default makes sense, but differs from all other kubectl commands, where the current context provides the default namespace.

How about making the default kube-system plus the namespace from the current context?

bgrant0607 · 2016-02-05T03:29:09Z

I guess this assumes the master kubelet is registered, so we can collect control-plane logs.

Is there a way to get Kubelet logs?

smarterclayton · 2016-02-05T04:29:46Z

The node proxy can be used to grab them, if they're enabled.

bgrant0607 · 2016-02-17T23:39:25Z

@brendandburns Are you planning to finish this for 1.2?

cc @dchen1107

bgrant0607 · 2016-02-17T23:40:27Z

BTW, cluster-info has a dash in it.

brendandburns · 2016-02-29T18:01:26Z

Yes, I'm on finishing this for 1.2 (perhaps not the kubelet logs in this PR, tho)

brendandburns · 2016-02-29T18:16:06Z

PR updated, please take another look.

Thanks!
--brendan

brendandburns · 2016-03-04T21:24:36Z

@bgrant0607 friendly ping on this one...

bgrant0607 · 2016-03-05T03:52:24Z

Please run hack/update-generated-docs.sh

bgrant0607 · 2016-03-05T03:57:29Z

Ok. We can add more resources later, as necessary.

How about a test? Otherwise, this is likely to bitrot.

We're not starting to cherrypick yet. Added v1.2 milestone and cherrypick-candidate label.

bgrant0607 · 2016-03-15T01:41:41Z

No activity. Removing from 1.2.

brendandburns · 2016-05-09T19:09:59Z

@janetkuo friendly ping on this one.

Thanks!

janetkuo · 2016-05-09T22:20:13Z

pkg/kubectl/cmd/clusterinfo.go

@@ -43,6 +43,7 @@ func NewCmdClusterInfo(f *cmdutil.Factory, out io.Writer) *cobra.Command {
 		},
 	}
 	cmdutil.AddInclude3rdPartyFlags(cmd)
+	cmd.AddCommand(NewCmdClusterInfoDump(f, out))


Suggest removing clusterinfo (L37 & L51) since it's deprecated more than 1 year ago.

Suggest adding a hint of dump when printing results of kubectl cluster-info. Most parent commands will print help message with supported sub-commands, but kubectl cluster-info doesn't do that. WDYT?

Something like,

$ kubectl cluster-info Kubernetes master is running at http://xxx ... To further debug and diagnose cluster problems, use `kubectl cluster-info dump`.

I'd rather remove clusterinfo in a different PR

I added that note.

janetkuo · 2016-05-09T23:24:43Z

more importantly (imho) it dumps the logs for each pod.

This should be mentioned in the help (in short/long description and/or examples).

brendandburns · 2016-05-11T18:21:28Z

Comments addressed, please take another look.

--brendan

janetkuo · 2016-05-12T17:17:21Z

pkg/kubectl/cmd/clusterinfo_dump.go

+	cmd := &cobra.Command{
+		Use:   "dump",
+		Short: "Dump lots of relevant info for debugging and diagnosis.",
+		Long:  dumpLong + "\n" + dumpExample,


Should add the example with Command.Example:

Example: dumpExample,

janetkuo · 2016-05-12T17:19:57Z

A few nits; otherwise LGTM.

You'll need to run hack/update-generated-docs.sh also

brendandburns · 2016-05-16T23:57:14Z

Comments addressed, docs generated. ptal.

thanks!
--brendan

bgrant0607 · 2016-05-17T06:29:56Z

@brendandburns Tests failed

brendandburns · 2016-05-17T17:25:02Z

Test fixed. ptal.

janetkuo · 2016-05-19T21:32:28Z

LGTM. Squash and feel free to apply the tag.

k8s-bot · 2016-05-23T23:11:23Z

GCE e2e build/test passed for commit 178b5f7.

k8s-github-robot · 2016-05-24T20:13:42Z

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

k8s-bot · 2016-05-24T21:03:19Z

GCE e2e build/test passed for commit 178b5f7.

k8s-github-robot · 2016-05-24T21:24:17Z

Automatic merge from submit-queue

googlebot added the cla: yes label Feb 4, 2016

k8s-github-robot assigned bgrant0607 Feb 4, 2016

k8s-github-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 4, 2016

bgrant0607 reviewed Feb 5, 2016
View reviewed changes

brendandburns force-pushed the dump branch from b1df4ee to bb1edce Compare February 29, 2016 18:15

k8s-github-robot added the kind/old-docs label Mar 1, 2016

brendandburns force-pushed the dump branch from bb1edce to 2c99162 Compare March 4, 2016 21:22

bgrant0607 added the cherrypick-candidate label Mar 5, 2016

bgrant0607 added this to the v1.2 milestone Mar 5, 2016

bgrant0607 assigned j3ffml and unassigned bgrant0607 Mar 6, 2016

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

bgrant0607 removed this from the v1.2 milestone Mar 15, 2016

bgrant0607 unassigned j3ffml Mar 15, 2016

janetkuo reviewed May 9, 2016
View reviewed changes

bgrant0607 mentioned this pull request May 10, 2016

There should be a single way that pods and other resources are identified in k8s component logs wherever possible #23338

Closed

brendandburns force-pushed the dump branch from e110df9 to dfa7a7f Compare May 11, 2016 18:21

janetkuo reviewed May 12, 2016
View reviewed changes

brendandburns added 3 commits May 16, 2016 16:50

Add a 'kubectl clusterinfo dump' option

3c9fb1b

Address comments.

092afb6

address comments

d8daa07

brendandburns force-pushed the dump branch from dfa7a7f to f75e6b3 Compare May 16, 2016 23:56

address comments

178b5f7

brendandburns force-pushed the dump branch from f75e6b3 to 178b5f7 Compare May 17, 2016 17:24

brendandburns added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 23, 2016

k8s-github-robot merged commit 50524c7 into kubernetes:master May 24, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a 'kubectl clusterinfo dump' option #20672

Add a 'kubectl clusterinfo dump' option #20672

brendandburns commented Feb 4, 2016 •

edited by mikedanese

Loading

smarterclayton commented Feb 4, 2016

brendandburns commented Feb 4, 2016

smarterclayton commented Feb 5, 2016

bgrant0607 commented Feb 5, 2016

bgrant0607 Feb 5, 2016

bgrant0607 commented Feb 5, 2016

smarterclayton commented Feb 5, 2016

bgrant0607 commented Feb 17, 2016

bgrant0607 commented Feb 17, 2016

brendandburns commented Feb 29, 2016

brendandburns commented Feb 29, 2016

brendandburns commented Mar 4, 2016

bgrant0607 commented Mar 5, 2016

bgrant0607 commented Mar 5, 2016

bgrant0607 commented Mar 15, 2016

brendandburns commented May 9, 2016

janetkuo May 9, 2016

janetkuo May 9, 2016

brendandburns May 11, 2016

janetkuo commented May 9, 2016

brendandburns commented May 11, 2016

janetkuo May 12, 2016 •

edited

Loading

brendandburns May 16, 2016

janetkuo commented May 12, 2016

brendandburns commented May 16, 2016

bgrant0607 commented May 17, 2016

brendandburns commented May 17, 2016

janetkuo commented May 19, 2016

k8s-bot commented May 23, 2016

k8s-github-robot commented May 24, 2016

k8s-bot commented May 24, 2016

k8s-github-robot commented May 24, 2016

Add a 'kubectl clusterinfo dump' option #20672

Add a 'kubectl clusterinfo dump' option #20672

Conversation

brendandburns commented Feb 4, 2016 • edited by mikedanese Loading

smarterclayton commented Feb 4, 2016

brendandburns commented Feb 4, 2016

smarterclayton commented Feb 5, 2016

bgrant0607 commented Feb 5, 2016

bgrant0607 Feb 5, 2016

Choose a reason for hiding this comment

bgrant0607 commented Feb 5, 2016

smarterclayton commented Feb 5, 2016

bgrant0607 commented Feb 17, 2016

bgrant0607 commented Feb 17, 2016

brendandburns commented Feb 29, 2016

brendandburns commented Feb 29, 2016

brendandburns commented Mar 4, 2016

bgrant0607 commented Mar 5, 2016

bgrant0607 commented Mar 5, 2016

bgrant0607 commented Mar 15, 2016

brendandburns commented May 9, 2016

janetkuo May 9, 2016

Choose a reason for hiding this comment

janetkuo May 9, 2016

Choose a reason for hiding this comment

brendandburns May 11, 2016

Choose a reason for hiding this comment

janetkuo commented May 9, 2016

brendandburns commented May 11, 2016

janetkuo May 12, 2016 • edited Loading

Choose a reason for hiding this comment

brendandburns May 16, 2016

Choose a reason for hiding this comment

janetkuo commented May 12, 2016

brendandburns commented May 16, 2016

bgrant0607 commented May 17, 2016

brendandburns commented May 17, 2016

janetkuo commented May 19, 2016

k8s-bot commented May 23, 2016

k8s-github-robot commented May 24, 2016

k8s-bot commented May 24, 2016

k8s-github-robot commented May 24, 2016

brendandburns commented Feb 4, 2016 •

edited by mikedanese

Loading

janetkuo May 12, 2016 •

edited

Loading