Introduce events flag for describers #24554

ingvagabund · 2016-04-20T20:17:39Z

Printing events for a given object is not always needed. Thus, introducing --show-events=false to kubectl describe to skip events printing.

Fixes: #24239

0xmichalis · 2016-04-21T08:36:57Z

pkg/kubectl/describe.go

@@ -53,7 +53,13 @@ import (
 // if the output could not be generated. Implementers typically
 // abstract the retrieval of the named object from a remote server.
 type Describer interface {
-	Describe(namespace, name string) (output string, err error)
+	Describe(namespace, name string, describerSetting *DescriberSetting) (output string, err error)


Is there any reason for describerSetting to be a pointer?

At this point, no. Later, DescriberSetting could contain non-pointer variables you would not want to copy.

Any reason for it not to be a pointer?

We avoid pointers in apis unless the absense of a value (nil) is something we care about.

Ok, will update the PR.

ingvagabund · 2016-04-21T12:50:05Z

There are three objects that has no unit-tests at all: HorizontalPodAutoscalerDescriber, IngressDescriber, JobDescriber. I could not found proper fake client for them. Could be worth writing one.

ncdc · 2016-04-21T14:12:13Z

cc @kubernetes/rh-cluster-infra @kubernetes/kubectl @kubernetes/rh-ux

ncdc · 2016-04-21T16:19:02Z

pkg/kubectl/describe.go

+
+// DescriberSetting holds display configuration for each object
+// describer to control what is printed.
+type DescriberSetting struct {


I think this should be pluralized - DescriberSettings. Or maybe DescriberOptions.

I though setting is uncountable till this moment. Looks like google says "use plural if there are more things to set". DescriberConfig would work too. If the describer is meant just to "render", rendering settings is quite common. I like this comment [1]. DescriberPreferences is the closest to the behaviour from the point of the describer. On the other hand DescriberOptions makes more sense from the point of the kubectl describe command as events=true is by default and changing to false is providing option to change it.

DescribeOptions is already used so DescriberOptions counts out. Let's use DescriberSettings if noone against :).

[1] http://stackoverflow.com/questions/2074384/options-settings-properties-configuration-preferences-when-and-why/28812395#28812395

ncdc · 2016-04-21T16:20:59Z

Need to run hack/update-generated-docs.sh.

Could you also please add some tests to hack/test-cmd.sh testing usage of this new flag, if possible?

ingvagabund · 2016-04-21T21:25:49Z

@ncdc, yeah, I run that command at the end of our standup and blew my computer away. Sometimes the go compiler just eats all my memory. Was thinking about hack/test-cmd too. It is basically entire cluster set up without bare metal. A lot of objects created. Will put my eye on it tomorrow morning.

ncdc · 2016-04-22T13:30:16Z

There are three objects that has no unit-tests at all: HorizontalPodAutoscalerDescriber, IngressDescriber, JobDescriber. I could not found proper fake client for them. Could be worth writing one

Create separate issues for each one?

j3ffml · 2016-04-25T16:18:50Z

cc @janetkuo

derekwaynecarr · 2016-04-25T17:57:06Z

You will need to add the flag here:
https://github.com/kubernetes/kubernetes/blob/master/hack/verify-flags/known-flags.txt

derekwaynecarr · 2016-04-25T18:00:16Z

pkg/kubectl/cmd/describe.go

@@ -93,11 +94,12 @@ func NewCmdDescribe(f *cmdutil.Factory, out io.Writer) *cobra.Command {
 	kubectl.AddJsonFilenameFlag(cmd, &options.Filenames, usage)
 	cmdutil.AddRecursiveFlag(cmd, &options.Recursive)
 	cmd.Flags().StringP("selector", "l", "", "Selector (label query) to filter on")
+	cmd.Flags().BoolVar(&describerSettings.ShowEvents, "events", true, "If true, display also object events.")


I prefer we call the flag show-events, we use that convention already with the show-all flag, and it parallels the name in the describer settings.

I would update the text to be If true, display events related to the described object.

ncdc · 2016-04-26T14:34:59Z

@k8s-bot test node e2e experimental issue: #23916

j3ffml · 2016-04-26T16:38:57Z

pkg/kubectl/describe_test.go

+				},
+			}, events),
+		},
+		//"HorizontalPodAutoscalerDescriber": &HorizontalPodAutoscalerDescriber{


Did you mean to comment this out?

I have changed all the three describers into TODO note. Opened separate issue for them [1].

[1] #24731

eparis · 2016-04-29T12:26:11Z

/me has no idea what the bot did in #24554 (comment)

j3ffml · 2016-04-29T16:27:25Z

Looks good, but please squash commits.

ingvagabund · 2016-05-05T20:21:17Z

New PetSetDescriber introduced, not covered in this PR.

Introduce DescriberSettings for Describer display options Introduce --show-events flag and DescriberSettings in Describer methods Introduce unit-tests Regenerated kubectl describe docs Add events flag tests to test-cmd.sh Signed-off-by: dhodovsk@redhat.com Signed-off-by: jchaloup@redhat.com

ingvagabund · 2016-05-06T10:33:56Z

@ncdc @eparis @jlowdermilk can you reset lgtm flag?

smarterclayton · 2016-05-06T16:25:09Z

LGTM

k8s-bot · 2016-05-08T08:34:43Z

GCE e2e build/test passed for commit dd2c9c5.

k8s-github-robot · 2016-05-08T21:04:49Z

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

k8s-bot · 2016-05-08T21:37:31Z

GCE e2e build/test passed for commit dd2c9c5.

k8s-github-robot · 2016-05-08T21:41:28Z

Automatic merge from submit-queue

googlebot added the cla: yes label Apr 20, 2016

k8s-github-robot assigned j3ffml Apr 20, 2016

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

0xmichalis reviewed Apr 21, 2016
View reviewed changes

ingvagabund force-pushed the dhodovska-events-flag-for-describers branch 2 times, most recently from 824d311 to 7120cd7 Compare April 21, 2016 13:23

ncdc reviewed Apr 21, 2016
View reviewed changes

k8s-github-robot added the kind/old-docs label Apr 22, 2016

ingvagabund force-pushed the dhodovska-events-flag-for-describers branch 2 times, most recently from 74f9146 to 5ac2705 Compare April 22, 2016 12:18

k8s-github-robot added the needs-ok-to-merge label Apr 22, 2016

ncdc added the ok-to-merge label Apr 22, 2016

k8s-github-robot removed the needs-ok-to-merge label Apr 22, 2016

ingvagabund changed the title ~~WIP: introduce events flag for describers~~ Introduce events flag for describers Apr 25, 2016

derekwaynecarr reviewed Apr 25, 2016
View reviewed changes

ingvagabund force-pushed the dhodovska-events-flag-for-describers branch from dad88b7 to 712eeca Compare April 26, 2016 13:20

ingvagabund force-pushed the dhodovska-events-flag-for-describers branch from 712eeca to dabee4d Compare April 26, 2016 15:58

j3ffml reviewed Apr 26, 2016
View reviewed changes

ingvagabund force-pushed the dhodovska-events-flag-for-describers branch 2 times, most recently from 3a78128 to a595332 Compare April 27, 2016 08:13

k8s-github-robot added the kind/old-docs label Apr 29, 2016

eparis removed the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Apr 29, 2016

eparis mentioned this pull request Apr 29, 2016

mungegithub misbehaves when github returns 502s kubernetes-retired/contrib#867

Closed

ingvagabund force-pushed the dhodovska-events-flag-for-describers branch from be01d0b to a6a4b1d Compare April 29, 2016 17:24

j3ffml added release-note Denotes a PR that will be considered when it comes time to generate release notes. lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed release-note-label-needed labels Apr 29, 2016

ingvagabund force-pushed the dhodovska-events-flag-for-describers branch from a6a4b1d to dd2c9c5 Compare May 6, 2016 09:44

k8s-github-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/design Categorizes issue or PR as related to design. labels May 6, 2016

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

k8s-github-robot assigned bgrant0607 and unassigned j3ffml May 6, 2016

bgrant0607 assigned smarterclayton and unassigned bgrant0607 May 7, 2016

k8s-github-robot merged commit 41b7b04 into kubernetes:master May 8, 2016

ingvagabund deleted the dhodovska-events-flag-for-describers branch May 9, 2016 04:56

ingvagabund mentioned this pull request May 9, 2016

test-cmd.sh: extend tests with kubectl describe --events=false|true flag check #24730

Closed

foxish mentioned this pull request Jan 21, 2017

mungegithub misbehaves when github returns 502s kubernetes/test-infra#1628

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce events flag for describers #24554

Introduce events flag for describers #24554

ingvagabund commented Apr 20, 2016 •

edited

Loading

0xmichalis Apr 21, 2016

ingvagabund Apr 21, 2016

0xmichalis Apr 21, 2016

ingvagabund Apr 21, 2016

ingvagabund commented Apr 21, 2016 •

edited

Loading

ncdc commented Apr 21, 2016

ncdc Apr 21, 2016

ingvagabund Apr 21, 2016 •

edited

Loading

ncdc commented Apr 21, 2016

ingvagabund commented Apr 21, 2016 •

edited

Loading

ncdc commented Apr 22, 2016

j3ffml commented Apr 25, 2016

derekwaynecarr commented Apr 25, 2016

derekwaynecarr Apr 25, 2016 •

edited

Loading

ncdc Apr 26, 2016

ncdc commented Apr 26, 2016

j3ffml Apr 26, 2016

ingvagabund Apr 26, 2016 •

edited

Loading

eparis commented Apr 29, 2016

j3ffml commented Apr 29, 2016

ingvagabund commented May 5, 2016

ingvagabund commented May 6, 2016

smarterclayton commented May 6, 2016

k8s-bot commented May 8, 2016

k8s-github-robot commented May 8, 2016

k8s-bot commented May 8, 2016

k8s-github-robot commented May 8, 2016

Introduce events flag for describers #24554

Introduce events flag for describers #24554

Conversation

ingvagabund commented Apr 20, 2016 • edited Loading

0xmichalis Apr 21, 2016

Choose a reason for hiding this comment

ingvagabund Apr 21, 2016

Choose a reason for hiding this comment

0xmichalis Apr 21, 2016

Choose a reason for hiding this comment

ingvagabund Apr 21, 2016

Choose a reason for hiding this comment

ingvagabund commented Apr 21, 2016 • edited Loading

ncdc commented Apr 21, 2016

ncdc Apr 21, 2016

Choose a reason for hiding this comment

ingvagabund Apr 21, 2016 • edited Loading

Choose a reason for hiding this comment

ncdc commented Apr 21, 2016

ingvagabund commented Apr 21, 2016 • edited Loading

ncdc commented Apr 22, 2016

j3ffml commented Apr 25, 2016

derekwaynecarr commented Apr 25, 2016

derekwaynecarr Apr 25, 2016 • edited Loading

Choose a reason for hiding this comment

ncdc Apr 26, 2016

Choose a reason for hiding this comment

ncdc commented Apr 26, 2016

j3ffml Apr 26, 2016

Choose a reason for hiding this comment

ingvagabund Apr 26, 2016 • edited Loading

Choose a reason for hiding this comment

eparis commented Apr 29, 2016

j3ffml commented Apr 29, 2016

ingvagabund commented May 5, 2016

ingvagabund commented May 6, 2016

smarterclayton commented May 6, 2016

k8s-bot commented May 8, 2016

k8s-github-robot commented May 8, 2016

k8s-bot commented May 8, 2016

k8s-github-robot commented May 8, 2016

ingvagabund commented Apr 20, 2016 •

edited

Loading

ingvagabund commented Apr 21, 2016 •

edited

Loading

ingvagabund Apr 21, 2016 •

edited

Loading

ingvagabund commented Apr 21, 2016 •

edited

Loading

derekwaynecarr Apr 25, 2016 •

edited

Loading

ingvagabund Apr 26, 2016 •

edited

Loading