Added warning msg for `kubectl get` #28352

vefimova · 2016-07-01T13:48:22Z

added warning description regarding terminated pods to get long help message
added printing of warning message in case of get pods if there are hidden pods

Fixes #22986 (initiall PR and discussion are here #26417)

Output examples:

# kubectl get pods

NAME                       READY     STATUS             RESTARTS   AGE
dapi-test-pod1             0/1       Terminating        0          22h
liveness-http              0/1       CrashLoopBackOff   11245      22d
ubuntu1-1206318548-oh9tc   0/1       CrashLoopBackOff   2336       8d
  info: 1 completed object(s) was(were) not shown in pods list. Pass --show-all to see all objects.

# kubectl get pods,namespaces

NAME                          READY     STATUS             RESTARTS   AGE
po/dapi-test-pod1             0/1       Terminating        0          22h
po/liveness-http              1/1       Running            11242      22d
po/ubuntu1-1206318548-oh9tc   0/1       CrashLoopBackOff   2335       8d
 info: 1 completed object(s) was(were) not shown in pods list. Pass --show-all to see all objects.

NAME             STATUS    AGE
ns/default       Active    89d
ns/kube-system   Active    41d

# kubectl get pods -a

NAME                       READY     STATUS             RESTARTS   AGE
busybox                    0/1       Error              0          27d
dapi-test-pod1             0/1       Terminating        0          22h
liveness-http              0/1       CrashLoopBackOff   11245      22d
ubuntu1-1206318548-oh9tc   0/1       CrashLoopBackOff   2336       8d

# kubectl get -h

Display one or many resources.

Possible resource types include (case insensitive): pods (aka 'po'), services (aka 'svc'), deployments (aka 'deploy'),
replicasets (aka 'rs'), replicationcontrollers (aka 'rc'), nodes (aka 'no'), events (aka 'ev'), limitranges (aka 'limits'),
persistentvolumes (aka 'pv'), persistentvolumeclaims (aka 'pvc'), resourcequotas (aka 'quota'), namespaces (aka 'ns'),
serviceaccounts (aka 'sa'), ingresses (aka 'ing'), horizontalpodautoscalers (aka 'hpa'), daemonsets (aka 'ds'), configmaps (aka 'cm'),
componentstatuses (aka 'cs), endpoints (aka 'ep'), petsets (alpha feature, may be unstable) and secrets.

This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases.
You can see the full results for any resource by providing the '--show-all' flag.

By specifying the output as 'template' and providing a Go template as the value
of the --template flag, you can filter the attributes of the fetched resource(s).

Examples:

.........

This change is

j3ffml · 2016-07-01T16:56:44Z

pkg/kubectl/kubectl.go

@@ -30,6 +30,11 @@ import (

 const (
 	kubectlAnnotationPrefix = "kubectl.kubernetes.io/"
+	Warn                    = `


Give this a more meaningful name, e.g. HiddenPodsWarning.

smarterclayton · 2016-07-01T22:29:10Z

I would like to review this as well, but will not have time until Monday.

therc · 2016-07-01T22:45:51Z

pkg/kubectl/resource_printer.go

+	handlerMap    map[reflect.Type]*handlerEntry
+	options       PrintOptions
+	lastType      reflect.Type
+	hiddenPodsNum int


We need to do something similar for replicasets in #27510 and we might need it again for other objects. Can you change the field name to something more generic like hiddenEntryNum, hiddenObjNum, hiddenCount or similar? That way, we can reuse the code and logic.

Added changes for reuse the same var hiddenObjNum for all objects and valid printing in case of user getting several resource types at once: kubectl get pods,namespaces (added output example in PR description)

Thank you so much!

smarterclayton · 2016-08-02T22:08:22Z

Looks better, will review.

j3ffml · 2016-08-10T21:48:45Z

@smarterclayton still planning to review this?

smarterclayton · 2016-08-11T02:37:09Z

pkg/kubectl/kubectl.go

@@ -30,6 +30,11 @@ import (

 const (
 	kubectlAnnotationPrefix = "kubectl.kubernetes.io/"
+	HiddenPodsWarning       = `
+WARN: By default only active pods are displayed, to display terminated


This message needs to be more generic, and doesn't need the warning prefix. It really belongs directly inside of the get comment.

This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases. You can see the full results for any resource by providing the `--show-all` flag.

Should be a separate paragraph and in get.go in the help text.

A separate warning can remain here, but I would recommend making it shorter:

Edit: provided a clearer message below for the actual inline output.

- added warning description regarding terminated objects to `get` long help message - added printing of warning message in case of `get pods` if there are hidden pods Fixes kubernetes#22986

vefimova · 2016-08-16T20:58:45Z

@jlowdermilk @smarterclayton

So guys, WDYT is patch ready to be merged?

smarterclayton · 2016-08-16T21:14:53Z

LGTM

k8s-bot · 2016-08-17T10:40:05Z

GCE e2e build/test passed for commit f20c40e.

k8s-github-robot · 2016-08-17T12:11:49Z

Automatic merge from submit-queue

smarterclayton · 2016-08-17T14:56:51Z

As a future note I recommended to someone else with a similar problem that the next change to this code should hoist filtering up as a generic tool that happens before printing. That will make this more resilient to future change

therc · 2016-08-17T16:18:41Z

That would be me for get rs.

adohe-zz · 2016-09-05T06:31:09Z

@smarterclayton I think you mean this #29115, actually I am planning this.

googlebot added the cla: yes label Jul 1, 2016

vefimova force-pushed the fix_22986-1 branch from 785bcdd to 8cc40a5 Compare July 1, 2016 13:48

vefimova mentioned this pull request Jul 1, 2016

Added warning msg for kubectl get pods and clarification msg for kubectl create/run in case of conflict with terminated pods/jobs #26417

Closed

k8s-github-robot assigned j3ffml Jul 1, 2016

k8s-github-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. release-note-label-needed labels Jul 1, 2016

vefimova force-pushed the fix_22986-1 branch from 8cc40a5 to 28b21a8 Compare July 1, 2016 15:31

k8s-github-robot added the kind/design Categorizes issue or PR as related to design. label Jul 1, 2016

vefimova force-pushed the fix_22986-1 branch 2 times, most recently from a721563 to ec2a786 Compare July 1, 2016 16:23

j3ffml reviewed Jul 1, 2016
View reviewed changes

vefimova force-pushed the fix_22986-1 branch from ec2a786 to 64ee433 Compare July 1, 2016 17:45

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

smarterclayton mentioned this pull request Jul 1, 2016

Make kubectl get rs show empty entries last and only if run with --show-all #27510

Closed

therc reviewed Jul 1, 2016
View reviewed changes

vefimova force-pushed the fix_22986-1 branch from 64ee433 to ce07350 Compare July 4, 2016 21:55

k8s-github-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 4, 2016

j3ffml assigned smarterclayton Jul 8, 2016

therc mentioned this pull request Jul 11, 2016

Add warning for kubectl get rs for hidden objects #28754

Closed

vefimova force-pushed the fix_22986-1 branch from ce07350 to f25dd5f Compare July 13, 2016 16:04

k8s-github-robot removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. kind/design Categorizes issue or PR as related to design. labels Jul 13, 2016

vefimova force-pushed the fix_22986-1 branch from f25dd5f to 2c1da04 Compare July 13, 2016 17:50

vefimova force-pushed the fix_22986-1 branch from 85b465b to 3ae7309 Compare August 2, 2016 08:46

k8s-github-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Aug 2, 2016

vefimova force-pushed the fix_22986-1 branch from 3ae7309 to abd08f4 Compare August 5, 2016 16:49

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

j3ffml 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 Aug 9, 2016

smarterclayton reviewed Aug 11, 2016
View reviewed changes

vefimova force-pushed the fix_22986-1 branch from abd08f4 to 64ca05d Compare August 11, 2016 23:44

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

vefimova force-pushed the fix_22986-1 branch from 64ca05d to 05a6c42 Compare August 12, 2016 17:11

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

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

[k8s.io] Probing container should be restarted with a exec "cat /tmp/health" liveness probe [Conformance] {Kubernetes e2e suite} #30264

Closed

Added warning msg for kubectl get

f20c40e

- added warning description regarding terminated objects to `get` long help message - added printing of warning message in case of `get pods` if there are hidden pods Fixes kubernetes#22986

vefimova force-pushed the fix_22986-1 branch from 05a6c42 to f20c40e Compare August 15, 2016 22:50

smarterclayton added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 16, 2016

k8s-github-robot merged commit aedeccd into kubernetes:master Aug 17, 2016

derekwaynecarr mentioned this pull request Aug 22, 2016

Improve (or remove) phrasing(s) that confuse users of kubectl get #31160

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added warning msg for `kubectl get` #28352

Added warning msg for `kubectl get` #28352

vefimova commented Jul 1, 2016 •

edited

Loading

j3ffml Jul 1, 2016

vefimova Jul 1, 2016

smarterclayton commented Jul 1, 2016

therc Jul 1, 2016

vefimova Jul 13, 2016

therc Jul 13, 2016

smarterclayton commented Aug 2, 2016

j3ffml commented Aug 10, 2016

smarterclayton Aug 11, 2016 •

edited

Loading

smarterclayton Aug 11, 2016 •

edited

Loading

vefimova Aug 11, 2016

vefimova commented Aug 16, 2016

smarterclayton commented Aug 16, 2016

k8s-bot commented Aug 17, 2016

k8s-github-robot commented Aug 17, 2016

smarterclayton commented Aug 17, 2016

therc commented Aug 17, 2016

adohe-zz commented Sep 5, 2016

Added warning msg for kubectl get #28352

Added warning msg for kubectl get #28352

Conversation

vefimova commented Jul 1, 2016 • edited Loading

Output examples:

# kubectl get pods

# kubectl get pods,namespaces

# kubectl get pods -a

# kubectl get -h

j3ffml Jul 1, 2016

Choose a reason for hiding this comment

vefimova Jul 1, 2016

Choose a reason for hiding this comment

smarterclayton commented Jul 1, 2016

therc Jul 1, 2016

Choose a reason for hiding this comment

vefimova Jul 13, 2016

Choose a reason for hiding this comment

therc Jul 13, 2016

Choose a reason for hiding this comment

smarterclayton commented Aug 2, 2016

j3ffml commented Aug 10, 2016

smarterclayton Aug 11, 2016 • edited Loading

Choose a reason for hiding this comment

smarterclayton Aug 11, 2016 • edited Loading

Choose a reason for hiding this comment

vefimova Aug 11, 2016

Choose a reason for hiding this comment

vefimova commented Aug 16, 2016

smarterclayton commented Aug 16, 2016

k8s-bot commented Aug 17, 2016

k8s-github-robot commented Aug 17, 2016

smarterclayton commented Aug 17, 2016

therc commented Aug 17, 2016

adohe-zz commented Sep 5, 2016

Added warning msg for `kubectl get` #28352

Added warning msg for `kubectl get` #28352

vefimova commented Jul 1, 2016 •

edited

Loading

smarterclayton Aug 11, 2016 •

edited

Loading

smarterclayton Aug 11, 2016 •

edited

Loading