Serve OpenAPI spec only when --serve-openapi-spec switch is enabled (openshift#1612)

* support serving openapi spec

* Add runtime option to toggle if the API server exposes the OpenAPI spec

Author: luksa

Diff for: Makefile

@@ -191,7 +191,7 @@ $(BINDIR)/e2e.test: .init $(NEWEST_E2ETEST_SOURCE) $(NEWEST_GO_FILE)
 	$(DOCKER_CMD) $(BINDIR)/openapi-gen \
 		--v 1 --logtostderr \
 		--go-header-file "vendor/github.com/kubernetes/repo-infra/verify/boilerplate/boilerplate.go.txt" \
-		--input-dirs "github.com/kubernetes-incubator/service-catalog/pkg/apis/servicecatalog/v1beta1,k8s.io/api/core/v1,k8s.io/apimachinery/pkg/apis/meta/v1" \
+		--input-dirs "github.com/kubernetes-incubator/service-catalog/pkg/apis/servicecatalog/v1beta1,k8s.io/api/core/v1,k8s.io/apimachinery/pkg/apis/meta/v1,k8s.io/apimachinery/pkg/version,k8s.io/apimachinery/pkg/runtime" \
 		--output-package "github.com/kubernetes-incubator/service-catalog/pkg/openapi"
 	touch $@
 

Diff for: charts/catalog/templates/apiserver-deployment.yaml

@@ -61,6 +61,9 @@ spec:
         - --feature-gates
         - OriginatingIdentity=true
         {{- end }}
+        {{- if .Values.apiserver.serveOpenAPISpec }}
+        - --serve-openapi-spec
+        {{- end }}
         ports:
         - containerPort: 8443
         volumeMounts:
@@ -94,10 +97,10 @@ spec:
         resources:
           requests:
             cpu: 100m
-            memory: 20Mi
+            memory: 30Mi
           limits:
             cpu: 100m
-            memory: 30Mi
+            memory: 40Mi
         env:
         - name: ETCD_DATA_DIR
           value: /etcd-data-dir

Diff for: charts/catalog/values.yaml

@@ -67,6 +67,8 @@ apiserver:
     # If specified, audit log goes to specified path.
     logPath: "/tmp/service-catalog-apiserver-audit.log"
   serviceAccount: service-catalog-apiserver
+  # if true, makes the API server serve the OpenAPI schema (which is problematic with older versions of kubectl)
+  serveOpenAPISpec: false
 controllerManager:
   # Log level; valid values are in the range 0 - 10
   verbosity: 10

Diff for: cmd/apiserver/app/server/options.go

@@ -57,6 +57,8 @@ type ServiceCatalogServerOptions struct {
 	DisableAuth bool
 	// StandaloneMode if true asserts that we will not depend on a kube-apiserver
 	StandaloneMode bool
+	// whether or not to serve the OpenAPI spec (at /swagger.json)
+	ServeOpenAPISpec bool
 }
 
 // NewServiceCatalogServerOptions creates a new instances of
@@ -95,6 +97,13 @@ func (s *ServiceCatalogServerOptions) AddFlags(flags *pflag.FlagSet) {
 		"Disable authentication and authorization for testing purposes",
 	)
 
+	flags.BoolVar(
+		&s.ServeOpenAPISpec,
+		"serve-openapi-spec",
+		false,
+		"Whether this API server should serve the OpenAPI spec (problematic with older versions of kubectl)",
+	)
+
 	s.GenericServerRunOptions.AddUniversalFlags(flags)
 	s.AdmissionOptions.AddFlags(flags)
 	s.SecureServingOptions.AddFlags(flags)

Diff for: cmd/apiserver/app/server/util.go

@@ -19,8 +19,10 @@ package server
 import (
 	"fmt"
 	"net"
+	"strings"
 	"time"
 
+	"github.com/go-openapi/spec"
 	"github.com/golang/glog"
 
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -36,6 +38,7 @@ import (
 	"github.com/kubernetes-incubator/service-catalog/pkg/apiserver/authenticator"
 	"github.com/kubernetes-incubator/service-catalog/pkg/client/clientset_generated/internalclientset"
 	informers "github.com/kubernetes-incubator/service-catalog/pkg/client/informers_generated/internalversion"
+	"github.com/kubernetes-incubator/service-catalog/pkg/openapi"
 	"github.com/kubernetes-incubator/service-catalog/pkg/version"
 )
 
@@ -87,8 +90,23 @@ func buildGenericConfig(s *ServiceCatalogServerOptions) (*genericapiserver.Recom
 		return nil, nil, err
 	}
 
-	// TODO: add support for OpenAPI config
-	// see https://github.com/kubernetes-incubator/service-catalog/issues/721
+	if s.ServeOpenAPISpec {
+		genericConfig.OpenAPIConfig = genericapiserver.DefaultOpenAPIConfig(
+			openapi.GetOpenAPIDefinitions, api.Scheme)
+		if genericConfig.OpenAPIConfig.Info == nil {
+			genericConfig.OpenAPIConfig.Info = &spec.Info{}
+		}
+		if genericConfig.OpenAPIConfig.Info.Version == "" {
+			if genericConfig.Version != nil {
+				genericConfig.OpenAPIConfig.Info.Version = strings.Split(genericConfig.Version.String(), "-")[0]
+			} else {
+				genericConfig.OpenAPIConfig.Info.Version = "unversioned"
+			}
+		}
+	} else {
+		glog.Warning("OpenAPI spec will not be served")
+	}
+
 	genericConfig.SwaggerConfig = genericapiserver.DefaultSwaggerConfig()
 	// TODO: investigate if we need metrics unique to service catalog, but take defaults for now
 	// see https://github.com/kubernetes-incubator/service-catalog/issues/677

Diff for: pkg/openapi/openapi_generated.go

@@ -11049,5 +11049,154 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
 			Dependencies: []string{
 				"k8s.io/apimachinery/pkg/runtime.RawExtension"},
 		},
+		"k8s.io/apimachinery/pkg/runtime.RawExtension": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Description: "RawExtension is used to hold extensions in external versions.\n\nTo use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.\n\n// Internal package: type MyAPIObject struct {\n\truntime.TypeMeta `json:\",inline\"`\n\tMyPlugin runtime.Object `json:\"myPlugin\"`\n} type PluginA struct {\n\tAOption string `json:\"aOption\"`\n}\n\n// External package: type MyAPIObject struct {\n\truntime.TypeMeta `json:\",inline\"`\n\tMyPlugin runtime.RawExtension `json:\"myPlugin\"`\n} type PluginA struct {\n\tAOption string `json:\"aOption\"`\n}\n\n// On the wire, the JSON will look something like this: {\n\t\"kind\":\"MyAPIObject\",\n\t\"apiVersion\":\"v1\",\n\t\"myPlugin\": {\n\t\t\"kind\":\"PluginA\",\n\t\t\"aOption\":\"foo\",\n\t},\n}\n\nSo what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)",
+					Properties: map[string]spec.Schema{
+						"Raw": {
+							SchemaProps: spec.SchemaProps{
+								Description: "Raw is the underlying serialization of this object.",
+								Type:        []string{"string"},
+								Format:      "byte",
+							},
+						},
+					},
+					Required: []string{"Raw"},
+				},
+			},
+			Dependencies: []string{},
+		},
+		"k8s.io/apimachinery/pkg/runtime.TypeMeta": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Description: "TypeMeta is shared by all top level objects. The proper way to use it is to inline it in your type, like this: type MyAwesomeAPIObject struct {\n     runtime.TypeMeta    `json:\",inline\"`\n     ... // other fields\n} func (obj *MyAwesomeAPIObject) SetGroupVersionKind(gvk *metav1.GroupVersionKind) { metav1.UpdateTypeMeta(obj,gvk) }; GroupVersionKind() *GroupVersionKind\n\nTypeMeta is provided here for convenience. You may use it directly from this package or define your own with the same fields.",
+					Properties: map[string]spec.Schema{
+						"apiVersion": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"kind": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+					},
+				},
+			},
+			Dependencies: []string{},
+		},
+		"k8s.io/apimachinery/pkg/runtime.Unknown": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Description: "Unknown allows api objects with unknown types to be passed-through. This can be used to deal with the API objects from a plug-in. Unknown objects still have functioning TypeMeta features-- kind, version, etc. metadata and field mutatation.",
+					Properties: map[string]spec.Schema{
+						"apiVersion": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"kind": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"Raw": {
+							SchemaProps: spec.SchemaProps{
+								Description: "Raw will hold the complete serialized object which couldn't be matched with a registered type. Most likely, nothing should be done with this except for passing it through the system.",
+								Type:        []string{"string"},
+								Format:      "byte",
+							},
+						},
+						"ContentEncoding": {
+							SchemaProps: spec.SchemaProps{
+								Description: "ContentEncoding is encoding used to encode 'Raw' data. Unspecified means no encoding.",
+								Type:        []string{"string"},
+								Format:      "",
+							},
+						},
+						"ContentType": {
+							SchemaProps: spec.SchemaProps{
+								Description: "ContentType  is serialization method used to serialize 'Raw'. Unspecified means ContentTypeJSON.",
+								Type:        []string{"string"},
+								Format:      "",
+							},
+						},
+					},
+					Required: []string{"Raw", "ContentEncoding", "ContentType"},
+				},
+			},
+			Dependencies: []string{},
+		},
+		"k8s.io/apimachinery/pkg/version.Info": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Description: "Info contains versioning information. how we'll want to distribute that information.",
+					Properties: map[string]spec.Schema{
+						"major": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"minor": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"gitVersion": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"gitCommit": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"gitTreeState": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"buildDate": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"goVersion": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"compiler": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"platform": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+					},
+					Required: []string{"major", "minor", "gitVersion", "gitCommit", "gitTreeState", "buildDate", "goVersion", "compiler", "platform"},
+				},
+			},
+			Dependencies: []string{},
+		},
 	}
 }

Diff for: test/integration/framework.go

@@ -102,6 +102,7 @@ func withConfigGetFreshApiserverAndClient(
 			AuditOptions:            genericserveroptions.NewAuditOptions(),
 			DisableAuth:             true,
 			StandaloneMode:          true, // this must be true because we have no kube server for integration.
+			ServeOpenAPISpec:        true,
 		}
 		options.SecureServingOptions.BindPort = securePort
 		options.SecureServingOptions.ServerCert.CertDirectory = certDir