"kubectl explain" should be able to explain "apiservices" and "customresourcedefinition" #49465

xiangpengzhao · 2017-07-24T03:52:29Z

Is this a BUG REPORT or FEATURE REQUEST?:
/kind bug

What happened:

# kubectl explain apiservices
error: group apiregistration.k8s.io has not been registered

# kubectl explain customresourcedefinition
error: group apiextensions.k8s.io has not been registered

What you expected to happen:
kubectl explain should be able to explain the above two resources.

Print something as below, etc.

DESCRIPTION:
APIService represents a server for a particular GroupVersion. Name must be "version.group".

FIELDS:
......

How to reproduce it (as minimally and precisely as possible):
Run the commands above.

Anything else we need to know?:
/sig cli
/sig api-machinery

Environment:

Kubernetes version (use kubectl version): a9bf441
Cloud provider or hardware configuration**:
OS (e.g. from /etc/os-release):
Kernel (e.g. uname -a):
Install tools:
Others:

The text was updated successfully, but these errors were encountered:

dixudx · 2017-07-24T10:11:51Z

/cc

xiangpengzhao · 2017-07-24T15:05:36Z

@kubernetes/sig-cli-bugs

k8s-ci-robot · 2017-07-24T15:05:44Z

@xiangpengzhao: Reiterating the mentions to trigger a notification:
@kubernetes/sig-cli-bugs.

In response to this:

@kubernetes/sig-cli-bugs

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.

caesarxuchao · 2017-07-27T21:15:37Z

cc @mbohlool

mbohlool · 2017-07-27T21:16:27Z

This look like a problem with old swagger 1.2. We do not aggregate swagger 1.2 spec. When kubectl move to OpenAPI, it should by fix this by design.

@mbohlool

Automatic merge from submit-queue (batch tested with PRs 53228, 53232, 53353). 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>. Openapi explain **What this PR does / why we need it**: This rewrites `kubectl explain` but using openapi rather than swagger 1.2. Also removes the former code. **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #49465, fixes partially #44589, fixes partially #38637 **Special notes for your reviewer**: FYI @mbohlool **Release note**: ```release-note `kubectl explain` now uses openapi rather than swagger 1.2. ```

nikhita · 2018-01-16T19:40:06Z

This is still not fixed (even after kubectl moving to OpenAPI).

There are two problems here:

kubectl explain uses groups registered into a group registry. This can be fixed by:

--- a/pkg/kubectl/cmd/explain.go
+++ b/pkg/kubectl/cmd/explain.go
@@ -26,7 +26,6 @@ import (
 	"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
 	cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
 	"k8s.io/kubernetes/pkg/kubectl/explain"
-	"k8s.io/kubernetes/pkg/kubectl/scheme"
 	"k8s.io/kubernetes/pkg/kubectl/util/i18n"
 )
 
@@ -91,7 +90,6 @@ func RunExplain(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, ar
 		return err
 	}
 
-	// TODO: We should deduce the group for a resource by discovering the supported resources at server.
 	fullySpecifiedGVR, groupResource := schema.ParseResourceArg(inModel)
 	gvk := schema.GroupVersionKind{}
 	if fullySpecifiedGVR != nil {
@@ -104,20 +102,12 @@ func RunExplain(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, ar
 		}
 	}
 
-	if len(apiVersionString) == 0 {
-		groupMeta, err := scheme.Registry.Group(gvk.Group)
-		if err != nil {
-			return err
-		}
-		apiVersion = groupMeta.GroupVersion
-
-	} else {
-		apiVersion, err = schema.ParseGroupVersion(apiVersionString)
-		if err != nil {
+	if len(apiVersionString) != 0 {
+		if apiVersion, err = schema.ParseGroupVersion(apiVersionString); err != nil {
 			return err
 		}
+		gvk = apiVersion.WithKind(gvk.Kind)
 	}
-	gvk = apiVersion.WithKind(gvk.Kind)
 
 	resources, err := f.OpenAPISchema()
 	if err != nil {

However, after this it gives:

error: Couldn't find resource for "apiextensions.k8s.io/v1beta1, Kind=CustomResourceDefinition"

This occurs because of incorrect openAPI schema for apiextensions and apiregisteration.

kubectl explain looks up the gvk of the resource in question from a list of resources:

kubernetes/pkg/kubectl/cmd/util/openapi/openapi.go

Lines 71 to 77 in ff626a3

    
           func (d *document) LookupResource(gvk schema.GroupVersionKind) proto.Schema { 
        
           	modelName, found := d.resources[gvk] 
        
           	if !found { 
        
           		return nil 
        
           	} 
        
           	return d.models.LookupModel(modelName) 
        
           }

It gets the gvk here:

kubernetes/pkg/kubectl/cmd/util/openapi/openapi.go

Line 59 in ff626a3

gvk := parseGroupVersionKind(model)

parseGroupVersionKind finds the gvk through groupVersionKindExtensionKey:

kubernetes/pkg/kubectl/cmd/util/openapi/openapi.go

Lines 83 to 87 in ff626a3

    
           // Get the extensions 
        
           gvkExtension, ok := extensions[groupVersionKindExtensionKey] 
        
           if !ok { 
        
           	return schema.GroupVersionKind{} 
        
           }

Here, groupVersionKindExtensionKey is "x-kubernetes-group-version-kind" and is the key used to lookup the GroupVersionKind value for an object definition from the definition's "extensions" map.

However, we do not generate x-kubernetes- extensions for apiextensions-apiserver and aggregator yet (#52741), due to which it fails.

/reopen

k8s-ci-robot · 2018-01-16T19:40:06Z

@nikhita: you can't re-open an issue/PR unless you authored it or you are assigned to it.

In response to this:

This is still not fixed (even after kubectl moving to OpenAPI).

There are two problems here:

kubectl uses groups registered into a group registry. This can be fixed by:
--- a/pkg/kubectl/cmd/explain.go
+++ b/pkg/kubectl/cmd/explain.go
@@ -26,7 +26,6 @@ import (
	"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
	cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
	"k8s.io/kubernetes/pkg/kubectl/explain"
-	"k8s.io/kubernetes/pkg/kubectl/scheme"
	"k8s.io/kubernetes/pkg/kubectl/util/i18n"
)

@@ -91,7 +90,6 @@ func RunExplain(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, ar
		return err
	}

-	// TODO: We should deduce the group for a resource by discovering the supported resources at server.
	fullySpecifiedGVR, groupResource := schema.ParseResourceArg(inModel)
	gvk := schema.GroupVersionKind{}
	if fullySpecifiedGVR != nil {
@@ -104,20 +102,12 @@ func RunExplain(f cmdutil.Factory, out, cmdErr io.Writer, cmd *cobra.Command, ar
		}
	}

-	if len(apiVersionString) == 0 {
-		groupMeta, err := scheme.Registry.Group(gvk.Group)
-		if err != nil {
-			return err
-		}
-		apiVersion = groupMeta.GroupVersion
-
-	} else {
-		apiVersion, err = schema.ParseGroupVersion(apiVersionString)
-		if err != nil {
+	if len(apiVersionString) != 0 {
+		if apiVersion, err = schema.ParseGroupVersion(apiVersionString); err != nil {
			return err
		}
+		gvk = apiVersion.WithKind(gvk.Kind)
	}
-	gvk = apiVersion.WithKind(gvk.Kind)

	resources, err := f.OpenAPISchema()
	if err != nil {
However, after this it gives:
error: Couldn't find resource for "apiextensions.k8s.io/v1beta1, Kind=CustomResourceDefinition"
This occurs because of incorrect openAPI schema. The schema does not contain apiextensions and apiregisteration.

kubectl explain looks up the gvk of the resource in question from a list of resources:

kubernetes/pkg/kubectl/cmd/util/openapi/openapi.go

Lines 71 to 77 in ff626a3

func (d *document) LookupResource(gvk schema.GroupVersionKind) proto.Schema {

modelName, found := d.resources[gvk]

if !found {

return nil

}

return d.models.LookupModel(modelName)

}

It gets the gvk here:

kubernetes/pkg/kubectl/cmd/util/openapi/openapi.go

Line 59 in ff626a3

gvk := parseGroupVersionKind(model)

parseGroupVersionKind finds the gvk through groupVersionKindExtensionKey:

kubernetes/pkg/kubectl/cmd/util/openapi/openapi.go

Lines 83 to 87 in ff626a3

// Get the extensions

gvkExtension, ok := extensions[groupVersionKindExtensionKey]

if !ok {

return schema.GroupVersionKind{}

}

Here, groupVersionKindExtensionKey is "x-kubernetes-group-version-kind" and is the key used to lookup the GroupVersionKind value for an object definition from the definition's "extensions" map.

However, we do not generate x-kubernetes- extensions for apiextensions-apiserver and aggregator yet (#52741), due to which it fails.

/reopen

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.

xiangpengzhao · 2018-01-17T02:56:49Z

/reopen

fejta-bot · 2018-04-17T04:53:51Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

nikhita · 2018-04-17T06:23:26Z

/remove-lifecycle stale

nikhita · 2018-06-01T09:35:33Z

Looks like the blocker was fixed in #64174 🎉

I will move forward with the fix.

nikhita · 2018-06-01T09:36:12Z

/assign

fejta-bot · 2018-08-30T09:55:57Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

nikhita · 2018-09-03T17:56:41Z

/remove-lifecycle stale

liggitt · 2018-11-24T16:41:46Z

fixed in 1.11 in #64174

k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Jul 24, 2017

xiangpengzhao mentioned this issue Jul 24, 2017

add cronjobs to all #49326

Merged

apelisse mentioned this issue Oct 3, 2017

Openapi explain #53228

Merged

k8s-github-robot closed this as completed in #53228 Oct 4, 2017

This was referenced Jan 16, 2018

oc explain crd/volumesnapshot/volumesnapshotdata yields error openshift/origin#16127

Closed

Extension API Server and Aggregator Server's OpenAPI spec missing x-kubernetes- extensions #52741

Closed

k8s-ci-robot reopened this Jan 17, 2018

nikhita mentioned this issue Jan 23, 2018

Umbrella issue for CRDs moving to GA #58682

Closed

54 tasks

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 17, 2018

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 17, 2018

nak3 mentioned this issue Apr 21, 2018

Add apiservices to ValidResourceTypeList #62932

Closed

k8s-ci-robot assigned nikhita Jun 1, 2018

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 30, 2018

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 3, 2018

liggitt closed this as completed Nov 24, 2018

liggitt added the area/custom-resources label Feb 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

"kubectl explain" should be able to explain "apiservices" and "customresourcedefinition" #49465

"kubectl explain" should be able to explain "apiservices" and "customresourcedefinition" #49465

xiangpengzhao commented Jul 24, 2017

dixudx commented Jul 24, 2017

xiangpengzhao commented Jul 24, 2017

k8s-ci-robot commented Jul 24, 2017

caesarxuchao commented Jul 27, 2017

mbohlool commented Jul 27, 2017

nikhita commented Jan 16, 2018 •

edited

k8s-ci-robot commented Jan 16, 2018

xiangpengzhao commented Jan 17, 2018

fejta-bot commented Apr 17, 2018

nikhita commented Apr 17, 2018

nikhita commented Jun 1, 2018

nikhita commented Jun 1, 2018

fejta-bot commented Aug 30, 2018

nikhita commented Sep 3, 2018

liggitt commented Nov 24, 2018

"kubectl explain" should be able to explain "apiservices" and "customresourcedefinition" #49465

"kubectl explain" should be able to explain "apiservices" and "customresourcedefinition" #49465

Comments

xiangpengzhao commented Jul 24, 2017

dixudx commented Jul 24, 2017

xiangpengzhao commented Jul 24, 2017

k8s-ci-robot commented Jul 24, 2017

caesarxuchao commented Jul 27, 2017

mbohlool commented Jul 27, 2017

nikhita commented Jan 16, 2018 • edited

k8s-ci-robot commented Jan 16, 2018

xiangpengzhao commented Jan 17, 2018

fejta-bot commented Apr 17, 2018

nikhita commented Apr 17, 2018

nikhita commented Jun 1, 2018

nikhita commented Jun 1, 2018

fejta-bot commented Aug 30, 2018

nikhita commented Sep 3, 2018

liggitt commented Nov 24, 2018

nikhita commented Jan 16, 2018 •

edited