mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-11-03 23:40:03 +00:00
136 lines
4.1 KiB
Go
136 lines
4.1 KiB
Go
/*
|
|
Copyright 2014 Google Inc. All rights reserved.
|
|
|
|
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 client
|
|
|
|
import (
|
|
"net/url"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/api"
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/util"
|
|
)
|
|
|
|
// RESTClient imposes common Kubernetes API conventions on a set of resource paths.
|
|
// The baseURL is expected to point to an HTTP or HTTPS path that is the parent
|
|
// of one or more resources. The server should return a decodable API resource
|
|
// object, or an api.Status object which contains information about the reason for
|
|
// any failure.
|
|
//
|
|
// Most consumers should use client.New() to get a Kubernetes API client.
|
|
type RESTClient struct {
|
|
baseURL *url.URL
|
|
// A string identifying the version of the API this client is expected to use.
|
|
apiVersion string
|
|
|
|
// LegacyBehavior controls if URLs should encode the namespace as a query param,
|
|
// and if resource case is preserved for supporting older API conventions of
|
|
// Kubernetes. Newer clients should leave this false.
|
|
LegacyBehavior bool
|
|
|
|
// Codec is the encoding and decoding scheme that applies to a particular set of
|
|
// REST resources.
|
|
Codec runtime.Codec
|
|
|
|
// Set specific behavior of the client. If not set http.DefaultClient will be
|
|
// used.
|
|
Client HTTPClient
|
|
|
|
Timeout time.Duration
|
|
|
|
// TODO extract this into a wrapper interface via the RESTClient interface in kubectl.
|
|
Throttle util.RateLimiter
|
|
}
|
|
|
|
// NewRESTClient creates a new RESTClient. This client performs generic REST functions
|
|
// such as Get, Put, Post, and Delete on specified paths. Codec controls encoding and
|
|
// decoding of responses from the server. If this client should use the older, legacy
|
|
// API conventions from Kubernetes API v1beta1 and v1beta2, set legacyBehavior true.
|
|
func NewRESTClient(baseURL *url.URL, apiVersion string, c runtime.Codec, legacyBehavior bool, maxQPS float32, maxBurst int) *RESTClient {
|
|
base := *baseURL
|
|
if !strings.HasSuffix(base.Path, "/") {
|
|
base.Path += "/"
|
|
}
|
|
base.RawQuery = ""
|
|
base.Fragment = ""
|
|
|
|
var throttle util.RateLimiter
|
|
if maxQPS > 0 {
|
|
throttle = util.NewTokenBucketRateLimiter(maxQPS, maxBurst)
|
|
}
|
|
return &RESTClient{
|
|
baseURL: &base,
|
|
apiVersion: apiVersion,
|
|
|
|
Codec: c,
|
|
|
|
LegacyBehavior: legacyBehavior,
|
|
|
|
Throttle: throttle,
|
|
}
|
|
}
|
|
|
|
// Verb begins a request with a verb (GET, POST, PUT, DELETE).
|
|
//
|
|
// Example usage of RESTClient's request building interface:
|
|
// c := NewRESTClient(url, codec)
|
|
// resp, err := c.Verb("GET").
|
|
// Path("pods").
|
|
// SelectorParam("labels", "area=staging").
|
|
// Timeout(10*time.Second).
|
|
// Do()
|
|
// if err != nil { ... }
|
|
// list, ok := resp.(*api.PodList)
|
|
//
|
|
func (c *RESTClient) Verb(verb string) *Request {
|
|
if c.Throttle != nil {
|
|
c.Throttle.Accept()
|
|
}
|
|
return NewRequest(c.Client, verb, c.baseURL, c.apiVersion, c.Codec, c.LegacyBehavior, c.LegacyBehavior).Timeout(c.Timeout)
|
|
}
|
|
|
|
// Post begins a POST request. Short for c.Verb("POST").
|
|
func (c *RESTClient) Post() *Request {
|
|
return c.Verb("POST")
|
|
}
|
|
|
|
// Put begins a PUT request. Short for c.Verb("PUT").
|
|
func (c *RESTClient) Put() *Request {
|
|
return c.Verb("PUT")
|
|
}
|
|
|
|
// Patch begins a PATCH request. Short for c.Verb("Patch").
|
|
func (c *RESTClient) Patch(pt api.PatchType) *Request {
|
|
return c.Verb("PATCH").SetHeader("Content-Type", string(pt))
|
|
}
|
|
|
|
// Get begins a GET request. Short for c.Verb("GET").
|
|
func (c *RESTClient) Get() *Request {
|
|
return c.Verb("GET")
|
|
}
|
|
|
|
// Delete begins a DELETE request. Short for c.Verb("DELETE").
|
|
func (c *RESTClient) Delete() *Request {
|
|
return c.Verb("DELETE")
|
|
}
|
|
|
|
// APIVersion returns the APIVersion this RESTClient is expected to use.
|
|
func (c *RESTClient) APIVersion() string {
|
|
return c.apiVersion
|
|
}
|