Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Add machine readable --output options to kubectl api-resources #116926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Add machine readable --output options to kubectl api-resources #116926

wants to merge 2 commits into from

Conversation

XDRAGON2002
Copy link
Member

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR adds support for json output format for kubectl api-resources.

Which issue(s) this PR fixes:

Fixes kubernetes/kubectl#1382

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Adds json as a possible output format. Made changes to apiresources.go which added support for kubectl api-resources --output json

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@XDRAGON2002
add -o json to apiresources
eb5deba 
Signed-off-by: Anant Vijay <anantvijay3@gmail.com>
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 25, 2023
@k8s-ci-robot
Copy link
Contributor

Please note that we're already in Test Freeze for the release-1.27 branch. This means every merged PR will be automatically fast-forwarded via the periodic ci-fast-forward job to the release branch of the upcoming v1.27.0 release.

Fast forwards are scheduled to happen every 6 hours, whereas the most recent run was: Sat Mar 25 16:24:30 UTC 2023.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 25, 2023
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Mar 25, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: XDRAGON2002
Once this PR has been reviewed and has the lgtm label, please assign brianpursley for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

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

ardaguclu
ardaguclu reviewed Mar 26, 2023
View reviewed changes
staging/src/k8s.io/kubectl/pkg/cmd/apiresources/apiresources.go
@@ -235,6 +238,15 @@ func (o *APIResourceOptions) RunAPIResources() error {
strings.Join(r.APIResource.Categories, ",")); err != nil {
errs = append(errs, err)
}
case "json":
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please check how other commands handle json printing(i.e. commands support --output). We need to also support yaml and that's why, we need to use JsonYamlPrinter.

Since this version of this patch looks hacky;

/hold

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@XDRAGON2002 It is worth to check how wait command handles this

kubernetes/staging/src/k8s.io/kubectl/pkg/cmd/wait/wait.go

Line 152 in 369534c

printer, err := flags.PrintFlags.ToPrinter()

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 26, 2023
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 26, 2023
@XDRAGON2002
Copy link
Member Author

@ardaguclu Thanks for the quick review!
I've updated the previous code to use json.marshal in order to generate a json output instead.

Though while going through the printers approach requested by you, I went through the entire codebase for the printers and ended up here.
I tried to directly use this in order to get the desired output by creating a JSONPrinter and calling PrintObj on it, but since it requires a runtime.Object it didn't work with the groupResource struct.

Any pointers or suggestions regarding how can I improve the implementation?

@k8s-ci-robot
Copy link
Contributor

@XDRAGON2002: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-kubernetes-verify 3b33aa1 link true /test pull-kubernetes-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@XDRAGON2002 XDRAGON2002 closed this Oct 1, 2023
@dharmit dharmit mentioned this pull request Jul 28, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ardaguclu ardaguclu ardaguclu left review comments

@KnVerey KnVerey Awaiting requested review from KnVerey

Assignees
No one assigned
Labels
area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/feature Categorizes issue or PR as related to a new feature. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add machine readable --output options to kubectl api-resources
3 participants
@XDRAGON2002 @k8s-ci-robot @ardaguclu
Morty Proxy This is a proxified and sanitized view of the page, visit original site.