Merge pull request #33 from kubernetes-sigs/feat/connector-subresource

Connector subresource

Author: k8s-ci-robot

internal/sample-apiserver/pkg/apiserver/ext.go

@@ -17,13 +17,18 @@ limitations under the License.
 package apiserver
 
 import (
+	"net/url"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/conversion"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/util/sets"
 	genericregistry "k8s.io/apiserver/pkg/registry/generic"
 	"k8s.io/apiserver/pkg/registry/rest"
 	pkgserver "k8s.io/apiserver/pkg/server"
+
+	"sigs.k8s.io/apiserver-runtime/pkg/builder/resource"
 	"sigs.k8s.io/apiserver-runtime/pkg/builder/resource/resourcestrategy"
 )
 
@@ -34,6 +39,15 @@ var (
 	GenericAPIServerFns []func(*pkgserver.GenericAPIServer) *pkgserver.GenericAPIServer
 )
 
+var (
+	ParameterScheme = runtime.NewScheme()
+	ParameterCodec  = runtime.NewParameterCodec(ParameterScheme)
+)
+
+func init() {
+	metav1.AddMetaToScheme(ParameterScheme)
+}
+
 func BuildAPIGroupInfos(s *runtime.Scheme, g genericregistry.RESTOptionsGetter) ([]*pkgserver.APIGroupInfo, error) {
 	resourcesByGroupVersion := make(map[schema.GroupVersion]sets.String)
 	groups := sets.NewString()
@@ -60,14 +74,28 @@ func BuildAPIGroupInfos(s *runtime.Scheme, g genericregistry.RESTOptionsGetter)
 				// add the defaulting function for this version to the scheme
 				if _, ok := storage.(resourcestrategy.Defaulter); ok {
 					if obj, ok := storage.(runtime.Object); ok {
-						Scheme.AddTypeDefaultingFunc(obj, func(obj interface{}) {
+						s.AddTypeDefaultingFunc(obj, func(obj interface{}) {
 							obj.(resourcestrategy.Defaulter).Default()
 						})
 					}
 				}
+				if c, ok := storage.(rest.Connecter); ok {
+					optionsObj, _, _ := c.NewConnectOptions()
+					if optionsObj != nil {
+						ParameterScheme.AddKnownTypes(gvr.GroupVersion(), optionsObj)
+						Scheme.AddKnownTypes(gvr.GroupVersion(), optionsObj)
+						if _, ok := optionsObj.(resource.QueryParameterObject); ok {
+							if err := ParameterScheme.AddConversionFunc(&url.Values{}, optionsObj, func(src interface{}, dest interface{}, s conversion.Scope) error {
+								return dest.(resource.QueryParameterObject).ConvertFromUrlValues(src.(*url.Values))
+							}); err != nil {
+								return nil, err
+							}
+						}
+					}
+				}
 			}
 		}
-		apiGroupInfo := pkgserver.NewDefaultAPIGroupInfo(group, Scheme, metav1.ParameterCodec, Codecs)
+		apiGroupInfo := pkgserver.NewDefaultAPIGroupInfo(group, Scheme, ParameterCodec, Codecs)
 		apiGroupInfo.VersionedResourcesStorageMap = apis
 		apiGroups = append(apiGroups, &apiGroupInfo)
 	}

pkg/builder/builder_general.go

@@ -2,6 +2,7 @@ package builder
 
 import (
 	"github.com/spf13/pflag"
+	pkgserver "k8s.io/apiserver/pkg/server"
 	"sigs.k8s.io/apiserver-runtime/internal/sample-apiserver/pkg/apiserver"
 	"sigs.k8s.io/apiserver-runtime/internal/sample-apiserver/pkg/cmd/server"
 )
@@ -18,6 +19,12 @@ func (a *Server) WithServerFns(fns ...func(server *GenericAPIServer) *GenericAPI
 	return a
 }
 
+// WithConfigFns sets functions to customize the RecommendedConfig
+func (a *Server) WithConfigFns(fns ...func(config *pkgserver.RecommendedConfig) *pkgserver.RecommendedConfig) *Server {
+	server.RecommendedConfigFns = append(server.RecommendedConfigFns, fns...)
+	return a
+}
+
 // WithFlagFns sets functions to customize the flags for the compiled binary.
 func (a *Server) WithFlagFns(fns ...func(set *pflag.FlagSet) *pflag.FlagSet) *Server {
 	server.FlagsFns = append(server.FlagsFns, fns...)

pkg/builder/builder_misc.go

@@ -4,6 +4,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	openapicommon "k8s.io/kube-openapi/pkg/common"
 	"sigs.k8s.io/apiserver-runtime/internal/sample-apiserver/pkg/cmd/server"
+	"sigs.k8s.io/apiserver-runtime/pkg/util/loopback"
 )
 
 // WithOpenAPIDefinitions registers resource OpenAPI definitions generated by openapi-gen.
@@ -38,3 +39,11 @@ func (a *Server) WithAdditionalSchemesToBuild(s ...*runtime.Scheme) *Server {
 	a.schemes = append(a.schemes, s...)
 	return a
 }
+
+// ExposeLoopbackClientConfig exposes loopback client config as an external variable.
+func (a *Server) ExposeLoopbackClientConfig() *Server {
+	return a.WithServerFns(func(c *GenericAPIServer) *GenericAPIServer {
+		loopback.SetLoopbackClientConfig(c.LoopbackClientConfig)
+		return c
+	})
+}

pkg/builder/resource/subresource_types.go

@@ -0,0 +1,38 @@
+/*
+Copyright 2020 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package resource
+
+import "net/url"
+
+// StatusSubResource defines interface for registering status subresource to a parent resource.
+type StatusSubResource interface {
+	SubResource
+	// CopyTo copies the content of the status subresource to a parent resource.
+	CopyTo(parent ObjectWithStatusSubResource)
+}
+
+// SubResource defines interface for registering arbitrary subresource to the parent resource.
+type SubResource interface {
+	SubResourceName() string
+	// TODO: fill the details for this interface.
+}
+
+// QueryParameterObject allows the object to be casted to url.Values.
+// It's specifically for Connector subresource.
+type QueryParameterObject interface {
+	ConvertFromUrlValues(values *url.Values) error
+}

pkg/builder/resource/types.go

@@ -82,19 +82,6 @@ type MultiVersionObject interface {
 	ConvertFromStorageVersion(storageObj runtime.Object) error
 }
 
-// StatusSubResource defines interface for registering status subresource to a parent resource.
-type StatusSubResource interface {
-	SubResource
-	// CopyTo copies the content of the status subresource to a parent resource.
-	CopyTo(parent ObjectWithStatusSubResource)
-}
-
-// SubResource defines interface for registering arbitrary subresource to the parent resource.
-type SubResource interface {
-	SubResourceName() string
-	// TODO: fill the details for this interface.
-}
-
 // ObjectWithStatusSubResource defines an interface for getting and setting the status sub-resource for a resource.
 type ObjectWithStatusSubResource interface {
 	Object
@@ -121,8 +108,9 @@ func AddToScheme(objs ...Object) func(s *runtime.Scheme) error {
 			s.AddKnownTypes(obj.GetGroupVersionResource().GroupVersion(), obj.New(), obj.NewList())
 			if obj.IsStorageVersion() {
 				s.AddKnownTypes(schema.GroupVersion{
-					Group:   runtime.APIVersionInternal,
-					Version: obj.GetGroupVersionResource().Version}, obj.New(), obj.NewList())
+					Group:   obj.GetGroupVersionResource().Group,
+					Version: runtime.APIVersionInternal,
+				}, obj.New(), obj.NewList())
 			} else {
 				multiVersionObj, ok := obj.(MultiVersionObject)
 				if !ok {

pkg/builder/rest/provider.go

@@ -27,7 +27,7 @@ import (
 type ResourceHandlerProvider = apiserver.StorageProvider
 
 // StaticHandlerProvider returns itself as the request handler.
-type StaticHandlerProvider struct {
+type StaticHandlerProvider struct { // TODO: privatize
 	rest.Storage
 }
 

pkg/util/loopback/loopback_client.go

@@ -0,0 +1,39 @@
+/*
+Copyright 2020 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package loopback is a set of utilities for apiserver loopback connections.
+package loopback
+
+import (
+	"sync"
+
+	"k8s.io/client-go/rest"
+)
+
+var setLoopbackClientOnce sync.Once
+var loopbackClientConfig *rest.Config
+
+// SetLoopbackClientConfig provides loopback client config for one time
+func SetLoopbackClientConfig(c *rest.Config) {
+	setLoopbackClientOnce.Do(func() {
+		loopbackClientConfig = c
+	})
+}
+
+// GetLoopbackClientConfig gets loopback client config
+func GetLoopbackClientConfig() *rest.Config {
+	return loopbackClientConfig
+}