add kubectl api-resources command #42873

xilabao · 2017-03-10T07:06:55Z

What this PR does / why we need it:
As the RBAC role need to be related to resources. I think we can use the command to get the supported resources.

# ./cluster/kubectl.sh api-resources   
NAME                                  SHORTNAMES   APIGROUP                       NAMESPACED   KIND
bindings                                                                          true         Binding
componentstatuses                     cs                                          false        ComponentStatus
configmaps                            cm                                          true         ConfigMap
endpoints                             ep                                          true         Endpoints
events                                ev                                          true         Event
limitranges                           limits                                      true         LimitRange
namespaces                            ns                                          false        Namespace
nodes                                 no                                          false        Node
persistentvolumeclaims                pvc                                         true         PersistentVolumeClaim
persistentvolumes                     pv                                          false        PersistentVolume
pods                                  po                                          true         Pod
podtemplates                                                                      true         PodTemplate
replicationcontrollers                rc                                          true         ReplicationController
resourcequotas                        quota                                       true         ResourceQuota
secrets                                                                           true         Secret
serviceaccounts                       sa                                          true         ServiceAccount
services                              svc                                         true         Service
externaladmissionhookconfigurations                admissionregistration.k8s.io   false        ExternalAdmissionHookConfiguration
initializerconfigurations                          admissionregistration.k8s.io   false        InitializerConfiguration
customresourcedefinitions             crd          apiextensions.k8s.io           false        CustomResourceDefinition
apiservices                                        apiregistration.k8s.io         false        APIService
controllerrevisions                                apps                           true         ControllerRevision
daemonsets                            ds           apps                           true         DaemonSet
deployments                           deploy       apps                           true         Deployment
replicasets                           rs           apps                           true         ReplicaSet
statefulsets                          sts          apps                           true         StatefulSet
tokenreviews                                       authentication.k8s.io          false        TokenReview
localsubjectaccessreviews                          authorization.k8s.io           true         LocalSubjectAccessReview
selfsubjectaccessreviews                           authorization.k8s.io           false        SelfSubjectAccessReview
subjectaccessreviews                               authorization.k8s.io           false        SubjectAccessReview
horizontalpodautoscalers              hpa          autoscaling                    true         HorizontalPodAutoscaler
jobs                                               batch                          true         Job
certificatesigningrequests            csr          certificates.k8s.io            false        CertificateSigningRequest
daemonsets                            ds           extensions                     true         DaemonSet
deployments                           deploy       extensions                     true         Deployment
ingresses                             ing          extensions                     true         Ingress
networkpolicies                       netpol       extensions                     true         NetworkPolicy
podsecuritypolicies                   psp          extensions                     false        PodSecurityPolicy
replicasets                           rs           extensions                     true         ReplicaSet
networkpolicies                       netpol       networking.k8s.io              true         NetworkPolicy
poddisruptionbudgets                  pdb          policy                         true         PodDisruptionBudget
clusterrolebindings                                rbac.authorization.k8s.io      false        ClusterRoleBinding
clusterroles                                       rbac.authorization.k8s.io      false        ClusterRole
rolebindings                                       rbac.authorization.k8s.io      true         RoleBinding
roles                                              rbac.authorization.k8s.io      true         Role
podpresets                                         settings.k8s.io                true         PodPreset
storageclasses                        sc           storage.k8s.io                 false        StorageClass

Which issue this PR fixes: fixes #42932

Special notes for your reviewer:

Release note:

add kubectl api-resources command to discovery of resources

k8s-ci-robot · 2017-03-10T07:06:56Z

Hi @xilabao. 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 @k8s-bot 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.

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.

k8s-reviewable · 2017-03-10T07:08:01Z

This change is

shiywang · 2017-03-10T08:42:03Z

pkg/kubectl/cmd/apiresources.go

+		Example: apiresources_example,
+		Run: func(cmd *cobra.Command, args []string) {
+			err := RunApiResources(f, out)
+			cmdutil.CheckErr(err)


I think we can move those two lines into one

shiywang · 2017-03-10T08:42:39Z

pkg/kubectl/cmd/apiresources.go

+
+func RunApiResources(f cmdutil.Factory, output io.Writer) error {
+	w := tabwriter.NewWriter(output, 10, 4, 3, ' ', 0)
+	fmt.Fprintln(w, "NAME\tNAMESPACED\tKIND\tVERBS")


why not add to HumanReadablePrinter ?

shiywang · 2017-03-10T08:51:03Z

pkg/kubectl/cmd/apiresources.go

+	}
+	sort.Strings(resources)
+	for _, r := range resources {
+		if _, err := fmt.Fprintf(w, "%s\t%v\t%s\t%v\n", m[r].Name, m[r].Namespaced, m[r].Kind, m[r].Verbs); err != nil {


should we also support other format of output like json, yaml ?

fabianofranz · 2017-03-10T18:49:24Z

cc @kubernetes/sig-cli-feature-requests @kubernetes/sig-cli-pr-reviews @deads2k @smarterclayton

@xilabao is there a proposal or issue related to this?

xilabao · 2017-03-11T00:30:18Z

@xilabao is there a proposal or issue related to this?

I have just added. #42932

liggitt · 2017-03-11T03:36:32Z

you would also need to know the API group

showing a resource that allows no verbs is debatable

adohe-zz · 2017-03-12T03:57:01Z

Please also take aggregated api-servers into consideration @xilabao

liggitt · 2017-03-13T00:27:23Z

If you use discovery data, aggregated servers and TPR data will automatically work

xilabao · 2017-03-13T01:04:44Z

@liggitt I will updated it. But I have a question. which should we add, api servers or api group?
another question @shiywang mentioned. should we also support other format of output like json, yaml ?

liggitt · 2017-03-13T01:06:33Z

API group

liggitt · 2017-03-13T01:07:23Z

I would not expect someone to use this as an API… if they want that, they should use the actual discovery API

adohe-zz · 2017-03-13T03:09:12Z

I would not expect someone to use this as an API… if they want that, they should use the actual discovery API

This is exactly what I expect, we should figure out the real use case of this command.

xilabao · 2017-03-13T09:44:45Z

@ALL PTAL

xilabao · 2017-03-14T00:36:30Z

@fabianofranz @liggitt @adohe @shiywang PTAL

adohe-zz · 2017-03-16T13:24:01Z

pkg/kubectl/cmd/apiresources.go

+
+func RunApiResources(f cmdutil.Factory, output io.Writer) error {
+	w := printers.GetNewTabWriter(output)
+	fmt.Fprintln(w, "NAME\tNAMESPACED\tAPIGROUP\tKIND\tVERBS")


I would expect we move this down before where we really need to output.

adohe-zz · 2017-03-18T02:34:00Z

/assign @adohe

tengqm · 2018-03-21T08:39:25Z

/test pull-kubernetes-e2e-kops-aws

k8s-ci-robot · 2018-03-21T08:39:40Z

@tengqm: you can't request testing unless you are a kubernetes member.

In response to this:

/test pull-kubernetes-e2e-kops-aws

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.

soltysh

/lgtm
/approve no-issue

soltysh · 2018-03-21T16:08:56Z

/retest

k8s-github-robot · 2018-03-23T08:42:03Z

[MILESTONENOTIFIER] Milestone Pull Request: Up-to-date for process

@adohe @soltysh @xilabao

Pull Request Labels

sig/cli: Pull Request will be escalated to these SIGs if needed.
priority/important-longterm: Escalate to the pull request owners; move out of the milestone after 1 attempt.
kind/feature: New functionality.

Help

smarterclayton · 2018-04-03T18:55:53Z

/approve

k8s-ci-robot · 2018-04-03T18:56:24Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adohe, smarterclayton, soltysh, xilabao

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:

~~docs/OWNERS~~ [smarterclayton]
~~hack/OWNERS~~ [smarterclayton,soltysh]
~~pkg/kubectl/OWNERS~~ [adohe,smarterclayton,soltysh]

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

k8s-github-robot · 2018-04-03T20:42:42Z

/test all [submit-queue is verifying that this PR is safe to merge]

k8s-github-robot · 2018-04-03T21:35:08Z

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions here.

Automatic merge from submit-queue (batch tested with PRs 63589, 63644, 63861, 63872, 63847). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. cleanup kubectl apiresources **What this PR does / why we need it**: #42873 introduce this new subcommand. This PR does * binding flags to struct * some code cleanups **Which issue(s) this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*: Fixes # **Special notes for your reviewer**: /cc soltysh juanvallejo **Release note**: ```release-note None ```

srikumar-b · 2018-11-27T20:57:02Z

Is there a way to query for sub resource like pods/log, pods/status etc?

liggitt · 2018-11-28T04:55:54Z

Is there a way to query for sub resource like pods/log, pods/status etc?

there is not currently

k8s-github-robot assigned fabianofranz Mar 10, 2017

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 10, 2017

k8s-github-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. release-note-label-needed labels Mar 10, 2017

xilabao force-pushed the add-apiresources-command branch from f523c7e to 31aebf6 Compare March 10, 2017 07:18

shiywang reviewed Mar 10, 2017

View reviewed changes

xilabao force-pushed the add-apiresources-command branch from 31aebf6 to 9fbe191 Compare March 11, 2017 00:26

xilabao force-pushed the add-apiresources-command branch from 9fbe191 to 7af26ec Compare March 13, 2017 07:23

k8s-github-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 13, 2017

xilabao force-pushed the add-apiresources-command branch from 7af26ec to 5421370 Compare March 13, 2017 07:42

adohe-zz reviewed Mar 16, 2017

View reviewed changes

xilabao force-pushed the add-apiresources-command branch from 5421370 to bd86db0 Compare March 17, 2017 00:48

k8s-ci-robot assigned adohe-zz Mar 18, 2017

soltysh added the sig/cli Categorizes an issue or PR as relevant to SIG CLI. label Mar 20, 2018

soltysh added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 21, 2018

soltysh approved these changes Mar 21, 2018

View reviewed changes

k8s-github-robot added milestone/needs-approval and removed milestone/incomplete-labels labels Mar 21, 2018

soltysh added the status/approved-for-milestone label Mar 23, 2018

k8s-github-robot removed the milestone/needs-approval label Mar 23, 2018

superbrothers mentioned this pull request Mar 24, 2018

role missing in kubectl get command line completion kubernetes/kubectl#357

Closed

liggitt mentioned this pull request Mar 26, 2018

kubectl dynamic acquire resource types #61691

Closed

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 3, 2018

k8s-github-robot merged commit 229d2df into kubernetes:master Apr 3, 2018

tengqm mentioned this pull request Apr 4, 2018

Document the kubectl api-resources command kubernetes/website#7958

Closed

2 tasks

dixudx mentioned this pull request Apr 19, 2018

add crds for shortname for customresourcedefinition in ValidResourceTypeList #62844

Closed

dixudx mentioned this pull request May 10, 2018

cleanup kubectl apiresources #63644

Merged

warmchang mentioned this pull request Nov 6, 2018

Issue with k8s.io/docs/concepts/overview/working-with-objects/namespaces/ kubernetes/website#10889

Closed

1 task

nikhita mentioned this pull request Dec 5, 2018

Issue with k8s.io/docs/concepts/overview/working-with-objects/namespaces/ kubernetes/website#11542

Closed

2 tasks

dixudx mentioned this pull request Aug 11, 2019

remove unknown command kubernetes/website#15766

Closed

daixiang0 mentioned this pull request Aug 12, 2019

comment version kubernetes/website#15808

Closed

0x5d mentioned this pull request May 4, 2021

rpk cloud get namespaces/clusters redpanda-data/redpanda#1322

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add kubectl api-resources command #42873

add kubectl api-resources command #42873

xilabao commented Mar 10, 2017 •

edited

Loading

k8s-ci-robot commented Mar 10, 2017

k8s-reviewable commented Mar 10, 2017

shiywang Mar 10, 2017

shiywang Mar 10, 2017

shiywang Mar 10, 2017

fabianofranz commented Mar 10, 2017

xilabao commented Mar 11, 2017

liggitt commented Mar 11, 2017

adohe-zz commented Mar 12, 2017

liggitt commented Mar 13, 2017

xilabao commented Mar 13, 2017

liggitt commented Mar 13, 2017

liggitt commented Mar 13, 2017

adohe-zz commented Mar 13, 2017

xilabao commented Mar 13, 2017

xilabao commented Mar 14, 2017

adohe-zz Mar 16, 2017

xilabao Mar 17, 2017

adohe-zz commented Mar 18, 2017

tengqm commented Mar 21, 2018

k8s-ci-robot commented Mar 21, 2018

soltysh left a comment

soltysh commented Mar 21, 2018

k8s-github-robot commented Mar 23, 2018

smarterclayton commented Apr 3, 2018

k8s-ci-robot commented Apr 3, 2018

k8s-github-robot commented Apr 3, 2018

k8s-github-robot commented Apr 3, 2018

srikumar-b commented Nov 27, 2018

liggitt commented Nov 28, 2018

add kubectl api-resources command #42873

add kubectl api-resources command #42873

Conversation

xilabao commented Mar 10, 2017 • edited Loading

k8s-ci-robot commented Mar 10, 2017

k8s-reviewable commented Mar 10, 2017

shiywang Mar 10, 2017

Choose a reason for hiding this comment

shiywang Mar 10, 2017

Choose a reason for hiding this comment

shiywang Mar 10, 2017

Choose a reason for hiding this comment

fabianofranz commented Mar 10, 2017

xilabao commented Mar 11, 2017

liggitt commented Mar 11, 2017

adohe-zz commented Mar 12, 2017

liggitt commented Mar 13, 2017

xilabao commented Mar 13, 2017

liggitt commented Mar 13, 2017

liggitt commented Mar 13, 2017

adohe-zz commented Mar 13, 2017

xilabao commented Mar 13, 2017

xilabao commented Mar 14, 2017

adohe-zz Mar 16, 2017

Choose a reason for hiding this comment

xilabao Mar 17, 2017

Choose a reason for hiding this comment

adohe-zz commented Mar 18, 2017

tengqm commented Mar 21, 2018

k8s-ci-robot commented Mar 21, 2018

soltysh left a comment

Choose a reason for hiding this comment

soltysh commented Mar 21, 2018

k8s-github-robot commented Mar 23, 2018

smarterclayton commented Apr 3, 2018

k8s-ci-robot commented Apr 3, 2018

k8s-github-robot commented Apr 3, 2018

k8s-github-robot commented Apr 3, 2018

srikumar-b commented Nov 27, 2018

liggitt commented Nov 28, 2018

xilabao commented Mar 10, 2017 •

edited

Loading