346 lines
12 KiB
Go
346 lines
12 KiB
Go
|
/*
|
||
|
|
Copyright 2015 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 discovery
|
||
|
|
|
||
|
|
import (
|
||
|
|
"encoding/json"
|
||
|
|
"fmt"
|
||
|
|
"net/url"
|
||
|
|
"sort"
|
||
|
|
"strings"
|
||
|
|
|
||
|
|
"github.com/emicklei/go-restful/swagger"
|
||
|
|
|
||
|
|
"k8s.io/client-go/1.5/pkg/api"
|
||
|
|
"k8s.io/client-go/1.5/pkg/api/errors"
|
||
|
|
"k8s.io/client-go/1.5/pkg/api/unversioned"
|
||
|
|
"k8s.io/client-go/1.5/pkg/api/v1"
|
||
|
|
"k8s.io/client-go/1.5/pkg/runtime"
|
||
|
|
"k8s.io/client-go/1.5/pkg/runtime/serializer"
|
||
|
|
"k8s.io/client-go/1.5/pkg/version"
|
||
|
|
"k8s.io/client-go/1.5/rest"
|
||
|
|
)
|
||
|
|
|
||
|
|
// DiscoveryInterface holds the methods that discover server-supported API groups,
|
||
|
|
// versions and resources.
|
||
|
|
type DiscoveryInterface interface {
|
||
|
|
ServerGroupsInterface
|
||
|
|
ServerResourcesInterface
|
||
|
|
ServerVersionInterface
|
||
|
|
SwaggerSchemaInterface
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerGroupsInterface has methods for obtaining supported groups on the API server
|
||
|
|
type ServerGroupsInterface interface {
|
||
|
|
// ServerGroups returns the supported groups, with information like supported versions and the
|
||
|
|
// preferred version.
|
||
|
|
ServerGroups() (*unversioned.APIGroupList, error)
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerResourcesInterface has methods for obtaining supported resources on the API server
|
||
|
|
type ServerResourcesInterface interface {
|
||
|
|
// ServerResourcesForGroupVersion returns the supported resources for a group and version.
|
||
|
|
ServerResourcesForGroupVersion(groupVersion string) (*unversioned.APIResourceList, error)
|
||
|
|
// ServerResources returns the supported resources for all groups and versions.
|
||
|
|
ServerResources() (map[string]*unversioned.APIResourceList, error)
|
||
|
|
// ServerPreferredResources returns the supported resources with the version preferred by the
|
||
|
|
// server.
|
||
|
|
ServerPreferredResources() ([]unversioned.GroupVersionResource, error)
|
||
|
|
// ServerPreferredNamespacedResources returns the supported namespaced resources with the
|
||
|
|
// version preferred by the server.
|
||
|
|
ServerPreferredNamespacedResources() ([]unversioned.GroupVersionResource, error)
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerVersionInterface has a method for retrieving the server's version.
|
||
|
|
type ServerVersionInterface interface {
|
||
|
|
// ServerVersion retrieves and parses the server's version (git version).
|
||
|
|
ServerVersion() (*version.Info, error)
|
||
|
|
}
|
||
|
|
|
||
|
|
// SwaggerSchemaInterface has a method to retrieve the swagger schema.
|
||
|
|
type SwaggerSchemaInterface interface {
|
||
|
|
// SwaggerSchema retrieves and parses the swagger API schema the server supports.
|
||
|
|
SwaggerSchema(version unversioned.GroupVersion) (*swagger.ApiDeclaration, error)
|
||
|
|
}
|
||
|
|
|
||
|
|
// DiscoveryClient implements the functions that discover server-supported API groups,
|
||
|
|
// versions and resources.
|
||
|
|
type DiscoveryClient struct {
|
||
|
|
*rest.RESTClient
|
||
|
|
|
||
|
|
LegacyPrefix string
|
||
|
|
}
|
||
|
|
|
||
|
|
// Convert unversioned.APIVersions to unversioned.APIGroup. APIVersions is used by legacy v1, so
|
||
|
|
// group would be "".
|
||
|
|
func apiVersionsToAPIGroup(apiVersions *unversioned.APIVersions) (apiGroup unversioned.APIGroup) {
|
||
|
|
groupVersions := []unversioned.GroupVersionForDiscovery{}
|
||
|
|
for _, version := range apiVersions.Versions {
|
||
|
|
groupVersion := unversioned.GroupVersionForDiscovery{
|
||
|
|
GroupVersion: version,
|
||
|
|
Version: version,
|
||
|
|
}
|
||
|
|
groupVersions = append(groupVersions, groupVersion)
|
||
|
|
}
|
||
|
|
apiGroup.Versions = groupVersions
|
||
|
|
// There should be only one groupVersion returned at /api
|
||
|
|
apiGroup.PreferredVersion = groupVersions[0]
|
||
|
|
return
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerGroups returns the supported groups, with information like supported versions and the
|
||
|
|
// preferred version.
|
||
|
|
func (d *DiscoveryClient) ServerGroups() (apiGroupList *unversioned.APIGroupList, err error) {
|
||
|
|
// Get the groupVersions exposed at /api
|
||
|
|
v := &unversioned.APIVersions{}
|
||
|
|
err = d.Get().AbsPath(d.LegacyPrefix).Do().Into(v)
|
||
|
|
apiGroup := unversioned.APIGroup{}
|
||
|
|
if err == nil {
|
||
|
|
apiGroup = apiVersionsToAPIGroup(v)
|
||
|
|
}
|
||
|
|
if err != nil && !errors.IsNotFound(err) && !errors.IsForbidden(err) {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
|
||
|
|
// Get the groupVersions exposed at /apis
|
||
|
|
apiGroupList = &unversioned.APIGroupList{}
|
||
|
|
err = d.Get().AbsPath("/apis").Do().Into(apiGroupList)
|
||
|
|
if err != nil && !errors.IsNotFound(err) && !errors.IsForbidden(err) {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
// to be compatible with a v1.0 server, if it's a 403 or 404, ignore and return whatever we got from /api
|
||
|
|
if err != nil && (errors.IsNotFound(err) || errors.IsForbidden(err)) {
|
||
|
|
apiGroupList = &unversioned.APIGroupList{}
|
||
|
|
}
|
||
|
|
|
||
|
|
// append the group retrieved from /api to the list
|
||
|
|
apiGroupList.Groups = append(apiGroupList.Groups, apiGroup)
|
||
|
|
return apiGroupList, nil
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerResourcesForGroupVersion returns the supported resources for a group and version.
|
||
|
|
func (d *DiscoveryClient) ServerResourcesForGroupVersion(groupVersion string) (resources *unversioned.APIResourceList, err error) {
|
||
|
|
url := url.URL{}
|
||
|
|
if len(groupVersion) == 0 {
|
||
|
|
return nil, fmt.Errorf("groupVersion shouldn't be empty")
|
||
|
|
}
|
||
|
|
if len(d.LegacyPrefix) > 0 && groupVersion == "v1" {
|
||
|
|
url.Path = d.LegacyPrefix + "/" + groupVersion
|
||
|
|
} else {
|
||
|
|
url.Path = "/apis/" + groupVersion
|
||
|
|
}
|
||
|
|
resources = &unversioned.APIResourceList{}
|
||
|
|
err = d.Get().AbsPath(url.String()).Do().Into(resources)
|
||
|
|
if err != nil {
|
||
|
|
// ignore 403 or 404 error to be compatible with an v1.0 server.
|
||
|
|
if groupVersion == "v1" && (errors.IsNotFound(err) || errors.IsForbidden(err)) {
|
||
|
|
return resources, nil
|
||
|
|
}
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
return resources, nil
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerResources returns the supported resources for all groups and versions.
|
||
|
|
func (d *DiscoveryClient) ServerResources() (map[string]*unversioned.APIResourceList, error) {
|
||
|
|
apiGroups, err := d.ServerGroups()
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
groupVersions := unversioned.ExtractGroupVersions(apiGroups)
|
||
|
|
result := map[string]*unversioned.APIResourceList{}
|
||
|
|
for _, groupVersion := range groupVersions {
|
||
|
|
resources, err := d.ServerResourcesForGroupVersion(groupVersion)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
result[groupVersion] = resources
|
||
|
|
}
|
||
|
|
return result, nil
|
||
|
|
}
|
||
|
|
|
||
|
|
// ErrGroupDiscoveryFailed is returned if one or more API groups fail to load.
|
||
|
|
type ErrGroupDiscoveryFailed struct {
|
||
|
|
// Groups is a list of the groups that failed to load and the error cause
|
||
|
|
Groups map[unversioned.GroupVersion]error
|
||
|
|
}
|
||
|
|
|
||
|
|
// Error implements the error interface
|
||
|
|
func (e *ErrGroupDiscoveryFailed) Error() string {
|
||
|
|
var groups []string
|
||
|
|
for k, v := range e.Groups {
|
||
|
|
groups = append(groups, fmt.Sprintf("%s: %v", k, v))
|
||
|
|
}
|
||
|
|
sort.Strings(groups)
|
||
|
|
return fmt.Sprintf("unable to retrieve the complete list of server APIs: %s", strings.Join(groups, ", "))
|
||
|
|
}
|
||
|
|
|
||
|
|
// IsGroupDiscoveryFailedError returns true if the provided error indicates the server was unable to discover
|
||
|
|
// a complete list of APIs for the client to use.
|
||
|
|
func IsGroupDiscoveryFailedError(err error) bool {
|
||
|
|
_, ok := err.(*ErrGroupDiscoveryFailed)
|
||
|
|
return err != nil && ok
|
||
|
|
}
|
||
|
|
|
||
|
|
// serverPreferredResources returns the supported resources with the version preferred by the
|
||
|
|
// server. If namespaced is true, only namespaced resources will be returned.
|
||
|
|
func (d *DiscoveryClient) serverPreferredResources(namespaced bool) ([]unversioned.GroupVersionResource, error) {
|
||
|
|
results := []unversioned.GroupVersionResource{}
|
||
|
|
serverGroupList, err := d.ServerGroups()
|
||
|
|
if err != nil {
|
||
|
|
return results, err
|
||
|
|
}
|
||
|
|
|
||
|
|
var failedGroups map[unversioned.GroupVersion]error
|
||
|
|
for _, apiGroup := range serverGroupList.Groups {
|
||
|
|
preferredVersion := apiGroup.PreferredVersion
|
||
|
|
groupVersion := unversioned.GroupVersion{Group: apiGroup.Name, Version: preferredVersion.Version}
|
||
|
|
apiResourceList, err := d.ServerResourcesForGroupVersion(preferredVersion.GroupVersion)
|
||
|
|
if err != nil {
|
||
|
|
if failedGroups == nil {
|
||
|
|
failedGroups = make(map[unversioned.GroupVersion]error)
|
||
|
|
}
|
||
|
|
failedGroups[groupVersion] = err
|
||
|
|
continue
|
||
|
|
}
|
||
|
|
for _, apiResource := range apiResourceList.APIResources {
|
||
|
|
// ignore the root scoped resources if "namespaced" is true.
|
||
|
|
if namespaced && !apiResource.Namespaced {
|
||
|
|
continue
|
||
|
|
}
|
||
|
|
if strings.Contains(apiResource.Name, "/") {
|
||
|
|
continue
|
||
|
|
}
|
||
|
|
results = append(results, groupVersion.WithResource(apiResource.Name))
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if len(failedGroups) > 0 {
|
||
|
|
return results, &ErrGroupDiscoveryFailed{Groups: failedGroups}
|
||
|
|
}
|
||
|
|
return results, nil
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerPreferredResources returns the supported resources with the version preferred by the
|
||
|
|
// server.
|
||
|
|
func (d *DiscoveryClient) ServerPreferredResources() ([]unversioned.GroupVersionResource, error) {
|
||
|
|
return d.serverPreferredResources(false)
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerPreferredNamespacedResources returns the supported namespaced resources with the
|
||
|
|
// version preferred by the server.
|
||
|
|
func (d *DiscoveryClient) ServerPreferredNamespacedResources() ([]unversioned.GroupVersionResource, error) {
|
||
|
|
return d.serverPreferredResources(true)
|
||
|
|
}
|
||
|
|
|
||
|
|
// ServerVersion retrieves and parses the server's version (git version).
|
||
|
|
func (d *DiscoveryClient) ServerVersion() (*version.Info, error) {
|
||
|
|
body, err := d.Get().AbsPath("/version").Do().Raw()
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
var info version.Info
|
||
|
|
err = json.Unmarshal(body, &info)
|
||
|
|
if err != nil {
|
||
|
|
return nil, fmt.Errorf("got '%s': %v", string(body), err)
|
||
|
|
}
|
||
|
|
return &info, nil
|
||
|
|
}
|
||
|
|
|
||
|
|
// SwaggerSchema retrieves and parses the swagger API schema the server supports.
|
||
|
|
func (d *DiscoveryClient) SwaggerSchema(version unversioned.GroupVersion) (*swagger.ApiDeclaration, error) {
|
||
|
|
if version.Empty() {
|
||
|
|
return nil, fmt.Errorf("groupVersion cannot be empty")
|
||
|
|
}
|
||
|
|
|
||
|
|
groupList, err := d.ServerGroups()
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
groupVersions := unversioned.ExtractGroupVersions(groupList)
|
||
|
|
// This check also takes care the case that kubectl is newer than the running endpoint
|
||
|
|
if stringDoesntExistIn(version.String(), groupVersions) {
|
||
|
|
return nil, fmt.Errorf("API version: %v is not supported by the server. Use one of: %v", version, groupVersions)
|
||
|
|
}
|
||
|
|
var path string
|
||
|
|
if len(d.LegacyPrefix) > 0 && version == v1.SchemeGroupVersion {
|
||
|
|
path = "/swaggerapi" + d.LegacyPrefix + "/" + version.Version
|
||
|
|
} else {
|
||
|
|
path = "/swaggerapi/apis/" + version.Group + "/" + version.Version
|
||
|
|
}
|
||
|
|
|
||
|
|
body, err := d.Get().AbsPath(path).Do().Raw()
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
var schema swagger.ApiDeclaration
|
||
|
|
err = json.Unmarshal(body, &schema)
|
||
|
|
if err != nil {
|
||
|
|
return nil, fmt.Errorf("got '%s': %v", string(body), err)
|
||
|
|
}
|
||
|
|
return &schema, nil
|
||
|
|
}
|
||
|
|
|
||
|
|
func setDiscoveryDefaults(config *rest.Config) error {
|
||
|
|
config.APIPath = ""
|
||
|
|
config.GroupVersion = nil
|
||
|
|
codec := runtime.NoopEncoder{Decoder: api.Codecs.UniversalDecoder()}
|
||
|
|
config.NegotiatedSerializer = serializer.NegotiatedSerializerWrapper(
|
||
|
|
runtime.SerializerInfo{Serializer: codec},
|
||
|
|
runtime.StreamSerializerInfo{},
|
||
|
|
)
|
||
|
|
if len(config.UserAgent) == 0 {
|
||
|
|
config.UserAgent = rest.DefaultKubernetesUserAgent()
|
||
|
|
}
|
||
|
|
return nil
|
||
|
|
}
|
||
|
|
|
||
|
|
// NewDiscoveryClientForConfig creates a new DiscoveryClient for the given config. This client
|
||
|
|
// can be used to discover supported resources in the API server.
|
||
|
|
func NewDiscoveryClientForConfig(c *rest.Config) (*DiscoveryClient, error) {
|
||
|
|
config := *c
|
||
|
|
if err := setDiscoveryDefaults(&config); err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
client, err := rest.UnversionedRESTClientFor(&config)
|
||
|
|
return &DiscoveryClient{RESTClient: client, LegacyPrefix: "/api"}, err
|
||
|
|
}
|
||
|
|
|
||
|
|
// NewDiscoveryClientForConfig creates a new DiscoveryClient for the given config. If
|
||
|
|
// there is an error, it panics.
|
||
|
|
func NewDiscoveryClientForConfigOrDie(c *rest.Config) *DiscoveryClient {
|
||
|
|
client, err := NewDiscoveryClientForConfig(c)
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
return client
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
// New creates a new DiscoveryClient for the given RESTClient.
|
||
|
|
func NewDiscoveryClient(c *rest.RESTClient) *DiscoveryClient {
|
||
|
|
return &DiscoveryClient{RESTClient: c, LegacyPrefix: "/api"}
|
||
|
|
}
|
||
|
|
|
||
|
|
func stringDoesntExistIn(str string, slice []string) bool {
|
||
|
|
for _, s := range slice {
|
||
|
|
if s == str {
|
||
|
|
return false
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return true
|
||
|
|
}
|