Added a new `--sort-by` flag to kubectl api-resources command #81971

laddng · 2019-08-26T23:12:05Z

What type of PR is this?
/kind feature

What this PR does / why we need it:
With the numerous amount of API resources (not counting custom ones), it is sometimes difficult locating them in the output. By default, API resources returned from kubectl api-resources are not sorted by the name column (the first on the left) and often this is the column holding the information one wishes to query. The --sort-by parameter now helps users more easily identify the object to be understood from the returned list.

kubectl api-resources --sort-by=name

Which issue(s) this PR fixes:
Fixes #81875

Special notes for your reviewer:
This is my first Kubernetes PR, so apologies if I did anything wrong!

Does this PR introduce a user-facing change?:

The kubectl's api-resource command now has a `--sort-by` flag to sort resources by name or kind.

k8s-ci-robot · 2019-08-26T23:12:06Z

Welcome @laddng!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2019-08-26T23:12:12Z

Hi @laddng. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

laddng · 2019-09-10T18:07:53Z

/assign @smarterclayton

laddng · 2019-09-10T18:15:53Z

@adohe @ghodss is there any prediction for progressing with this?

laddng · 2019-09-10T18:17:51Z

/unassign @smarterclayton

eloyekunle · 2019-09-10T18:27:59Z

/ok-to-test

soltysh · 2019-09-11T15:11:56Z

staging/src/k8s.io/kubectl/pkg/cmd/apiresources/apiresources.go

+	supportedSortTypes := sets.NewString("", "name", "kind")
+	if len(o.SortBy) > 0 {
+		if !supportedSortTypes.Has(o.SortBy) {
+			return fmt.Errorf("--sort-by accepts only name or kind", o.Output)


unnecessary o.Output:

fmt.Errorf("--sort-by accepts only name or kind")

Thank you for the feedback! I updated my changes 👍

soltysh · 2019-09-11T15:21:26Z

Also please fix the verify errors.
/priority important-longterm
/assign

laddng · 2019-10-07T18:14:31Z

/test pull-kubernetes-e2e-gce-100-performance

soltysh

nits
/lgtm
/approve

soltysh · 2019-10-18T09:46:06Z

staging/src/k8s.io/kubectl/pkg/cmd/apiresources/apiresources.go

@@ -42,6 +42,9 @@ var (
 		# Print the supported API Resources with more information
 		kubectl api-resources -o wide

+		# Print the supported API Resources sorted by a column


sorted by name

soltysh · 2019-10-18T09:46:28Z

staging/src/k8s.io/kubectl/pkg/cmd/apiresources/apiresources.go

@@ -111,6 +116,12 @@ func (o *APIResourceOptions) Validate() error {
 	if !supportedOutputTypes.Has(o.Output) {
 		return fmt.Errorf("--output %v is not available", o.Output)
 	}
+	supportedSortTypes := sets.NewString("", "name", "kind")


This should be instantiated with APIResoruceOptions

k8s-ci-robot · 2019-10-18T09:47:18Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: laddng, soltysh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~staging/src/k8s.io/kubectl/OWNERS~~ [soltysh]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

fejta-bot · 2019-10-18T13:19:10Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

fejta-bot · 2019-10-18T19:58:09Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

fejta-bot · 2019-10-19T02:16:08Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

fejta-bot · 2019-10-19T10:19:08Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

…-flag Added a new `--sort-by` flag to kubectl api-resources command Kubernetes-commit: 3ebee37

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 26, 2019

k8s-ci-robot requested review from adohe-zz and ghodss August 26, 2019 23:12

k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Aug 26, 2019

k8s-ci-robot assigned smarterclayton Sep 10, 2019

k8s-ci-robot unassigned smarterclayton Sep 10, 2019

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 10, 2019

soltysh requested changes Sep 11, 2019

View reviewed changes

k8s-ci-robot assigned soltysh Sep 11, 2019

k8s-ci-robot added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Sep 11, 2019

laddng force-pushed the api-resources-sort-by-flag branch from 6cf2c9b to cf492e9 Compare October 7, 2019 17:17

Add a new --sort-by flag to kubectl api-resources command

cf492e9

laddng requested a review from soltysh October 7, 2019 19:52

soltysh approved these changes Oct 18, 2019

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 18, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 18, 2019

k8s-ci-robot merged commit 3ebee37 into kubernetes:master Oct 19, 2019

k8s-ci-robot added this to the v1.17 milestone Oct 19, 2019

danielhelfand mentioned this pull request Mar 12, 2020

Instantiate SupportedOutputTypes and SupportedSortTypes with APIResourceOptions #89096

Closed

wking pushed a commit to wking/kubernetes that referenced this pull request Jul 21, 2020

Merge pull request kubernetes#81971 from laddng/api-resources-sort-by…

a4e4b8e

…-flag Added a new `--sort-by` flag to kubectl api-resources command Kubernetes-commit: 3ebee37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added a new `--sort-by` flag to kubectl api-resources command #81971

Added a new `--sort-by` flag to kubectl api-resources command #81971

laddng commented Aug 26, 2019

k8s-ci-robot commented Aug 26, 2019

k8s-ci-robot commented Aug 26, 2019

laddng commented Sep 10, 2019

laddng commented Sep 10, 2019

laddng commented Sep 10, 2019

eloyekunle commented Sep 10, 2019

soltysh Sep 11, 2019

laddng Oct 7, 2019

soltysh commented Sep 11, 2019

laddng commented Oct 7, 2019

soltysh left a comment

soltysh Oct 18, 2019

soltysh Oct 18, 2019

k8s-ci-robot commented Oct 18, 2019

fejta-bot commented Oct 18, 2019

fejta-bot commented Oct 18, 2019

fejta-bot commented Oct 19, 2019

fejta-bot commented Oct 19, 2019

Added a new --sort-by flag to kubectl api-resources command #81971

Added a new --sort-by flag to kubectl api-resources command #81971

Conversation

laddng commented Aug 26, 2019

k8s-ci-robot commented Aug 26, 2019

k8s-ci-robot commented Aug 26, 2019

laddng commented Sep 10, 2019

laddng commented Sep 10, 2019

laddng commented Sep 10, 2019

eloyekunle commented Sep 10, 2019

soltysh Sep 11, 2019

Choose a reason for hiding this comment

laddng Oct 7, 2019

Choose a reason for hiding this comment

soltysh commented Sep 11, 2019

laddng commented Oct 7, 2019

soltysh left a comment

Choose a reason for hiding this comment

soltysh Oct 18, 2019

Choose a reason for hiding this comment

soltysh Oct 18, 2019

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 18, 2019

fejta-bot commented Oct 18, 2019

fejta-bot commented Oct 18, 2019

fejta-bot commented Oct 19, 2019

fejta-bot commented Oct 19, 2019

Added a new `--sort-by` flag to kubectl api-resources command #81971

Added a new `--sort-by` flag to kubectl api-resources command #81971