apiserver

Documentation

Overview

Package apiserver contains the code that provides a RESTful api service.

Index

• Constants
• Variables
• func APIVersionHandler(versions ...string) restful.RouteFunction
• func CORS(handler http.Handler, allowedOriginPatterns []*regexp.Regexp, ...) http.Handler
• func Handle(storage map[string]RESTStorage, codec runtime.Codec, root string, ...) http.Handler
• func InstallLogsSupport(mux Mux)
• func InstallSupport(container *restful.Container, ws *restful.WebService)
• func InstallValidator(mux Mux, servers map[string]Server)
• func IsReadOnlyReq(req http.Request) bool
• func KindFromRequest(req http.Request) string
• func MakeAsync(fn WorkFunc) <-chan RESTResult
• func MakeAsyncResult(fn WorkResultFunc) <-chan RESTResult
• func NewAlwaysAllowAuthorizer() authorizer.Authorizer
• func NewAlwaysDenyAuthorizer() authorizer.Authorizer
• func NewAuthorizerFromAuthorizationConfig(authorizationMode string, authorizationPolicyFile string) (authorizer.Authorizer, error)
• func NewValidator(servers map[string]Server) (http.Handler, error)
• func RateLimit(rl util.RateLimiter, handler http.Handler) http.Handler
• func ReadOnly(handler http.Handler) http.Handler
• func RecoverPanics(handler http.Handler) http.Handler
• func WithAuthorizationCheck(handler http.Handler, getAttribs RequestAttributeGetter, ...) http.Handler
• type APIGroupVersion
  • func NewAPIGroupVersion(storage map[string]RESTStorage, codec runtime.Codec, canonicalPrefix string, ...) *APIGroupVersion
  • func (g *APIGroupVersion) InstallREST(container *restful.Container, root string, version string)
• type Attributes
• type Mux
• type Operation
  • func (op *Operation) StatusOrResult() (description RESTResult, finished bool)
  • func (op *Operation) WaitFor(timeout time.Duration)
• type OperationHandler
  • func (h *OperationHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type Operations
  • func NewOperations() *Operations
  • func (ops *Operations) Get(id string) *Operation
  • func (ops *Operations) List() *api.ServerOpList
  • func (ops *Operations) NewOperation(from <-chan RESTResult, onReceive func(RESTResult)) *Operation
• type ProxyHandler
  • func (r *ProxyHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type RESTHandler
  • func (h *RESTHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type RESTResult
• type RESTStorage
• type RedirectHandler
  • func (r *RedirectHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type Redirector
• type RequestAttributeGetter
  • func NewRequestAttributeGetter(userContexts authhandlers.RequestContext) RequestAttributeGetter
• type ResourceWatcher
• type Server
• type ServerStatus
• type WatchHandler
  • func (h *WatchHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type WatchServer
  • func (w *WatchServer) HandleWS(ws *websocket.Conn)
  • func (self *WatchServer) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type WorkFunc
• type WorkResultFunc

Constants

const (
	ModeAlwaysAllow string = "AlwaysAllow"
	ModeAlwaysDeny  string = "AlwaysDeny"
	ModeABAC        string = "ABAC"
)

const (
	StatusUnprocessableEntity = 422
)

Variables

var AuthorizationModeChoices = []string{ModeAlwaysAllow, ModeAlwaysDeny, ModeABAC}

Keep this list in sync with constant list above.

Functions

func APIVersionHandler

func APIVersionHandler(versions ...string) restful.RouteFunction

APIVersionHandler returns a handler which will list the provided versions as available.

func CORS

func CORS(handler http.Handler, allowedOriginPatterns []*regexp.Regexp, allowedMethods []string, allowedHeaders []string, allowCredentials string) http.Handler

TODO: use restful.CrossOriginResourceSharing Simple CORS implementation that wraps an http Handler For a more detailed implementation use https://github.com/martini-contrib/cors or implement CORS at your proxy layer Pass nil for allowedMethods and allowedHeaders to use the defaults

func Handle

func Handle(storage map[string]RESTStorage, codec runtime.Codec, root string, version string, selfLinker runtime.SelfLinker) http.Handler

Handle returns a Handler function that exposes the provided storage interfaces as RESTful resources at prefix, serialized by codec, and also includes the support http resources.

func InstallLogsSupport

func InstallLogsSupport(mux Mux)

InstallLogsSupport registers the APIServer log support function into a mux.

func InstallSupport

func InstallSupport(container *restful.Container, ws *restful.WebService)

TODO: document all handlers InstallSupport registers the APIServer support functions

func InstallValidator

func InstallValidator(mux Mux, servers map[string]Server)

TODO: Convert to go-restful

func IsReadOnlyReq

func IsReadOnlyReq(req http.Request) bool

IsReadOnlyReq() is true for any (or at least many) request which has no observable side effects on state of apiserver (though there may be internal side effects like caching and logging).

func KindFromRequest

func KindFromRequest(req http.Request) string

KindFromRequest returns Kind if Kind can be extracted from the request. Otherwise, the empty string.

func MakeAsync

func MakeAsync(fn WorkFunc) <-chan RESTResult

MakeAsync takes a function and executes it, delivering the result in the way required by RESTStorage's Update, Delete, and Create methods.

func MakeAsyncResult

func MakeAsyncResult(fn WorkResultFunc) <-chan RESTResult

MakeAsync takes a function and executes it, delivering the result in the way required by RESTStorage's Update, Delete, and Create methods.

func NewAlwaysAllowAuthorizer

func NewAlwaysAllowAuthorizer() authorizer.Authorizer

func NewAlwaysDenyAuthorizer

func NewAlwaysDenyAuthorizer() authorizer.Authorizer

func NewAuthorizerFromAuthorizationConfig

func NewAuthorizerFromAuthorizationConfig(authorizationMode string, authorizationPolicyFile string) (authorizer.Authorizer, error)

NewAuthorizerFromAuthorizationConfig returns the right sort of authorizer.Authorizer based on the authorizationMode xor an error. authorizationMode should be one of AuthorizationModeChoices.

func NewValidator

func NewValidator(servers map[string]Server) (http.Handler, error)

NewValidator creates a validator for a set of servers.

func RateLimit

func RateLimit(rl util.RateLimiter, handler http.Handler) http.Handler

RateLimit uses rl to rate limit accepting requests to 'handler'.

func ReadOnly

func ReadOnly(handler http.Handler) http.Handler

ReadOnly passes all GET requests on to handler, and returns an error on all other requests.

func RecoverPanics

func RecoverPanics(handler http.Handler) http.Handler

RecoverPanics wraps an http Handler to recover and log panics.

func WithAuthorizationCheck

func WithAuthorizationCheck(handler http.Handler, getAttribs RequestAttributeGetter, a authorizer.Authorizer) http.Handler

WithAuthorizationCheck passes all authorized requests on to handler, and returns a forbidden error otherwise.

Types

type APIGroupVersion

type APIGroupVersion struct {
	// contains filtered or unexported fields
}

TODO: This is a whole API version right now. Maybe should rename it. APIGroupVersion is a http.Handler that exposes multiple RESTStorage objects It handles URLs of the form: /${storage_key}[/${object_name}] Where 'storage_key' points to a RESTStorage object stored in storage.

TODO: consider migrating this to go-restful which is a more full-featured version of the same thing.

func NewAPIGroupVersion

func NewAPIGroupVersion(storage map[string]RESTStorage, codec runtime.Codec, canonicalPrefix string, selfLinker runtime.SelfLinker) *APIGroupVersion

NewAPIGroupVersion returns an object that will serve a set of REST resources and their associated operations. The provided codec controls serialization and deserialization. This is a helper method for registering multiple sets of REST handlers under different prefixes onto a server. TODO: add multitype codec serialization

func (*APIGroupVersion) InstallREST

func (g *APIGroupVersion) InstallREST(container *restful.Container, root string, version string)

InstallREST registers the REST handlers (storage, watch, and operations) into a restful Container. It is expected that the provided path root prefix will serve all operations. Root MUST NOT end in a slash. A restful WebService is created for the group and version.

type Attributes

type Attributes struct {
}

Attributes implements authorizer.Attributes interface.

type Mux

type Mux interface {
	Handle(pattern string, handler http.Handler)
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
}

mux is an object that can register http handlers.

type Operation

type Operation struct {
	ID string
	// contains filtered or unexported fields
}

Operation represents an ongoing action which the server is performing.

func (*Operation) StatusOrResult

func (op *Operation) StatusOrResult() (description RESTResult, finished bool)

StatusOrResult returns status information or the result of the operation if it is complete, with a bool indicating true in the latter case.

func (*Operation) WaitFor

func (op *Operation) WaitFor(timeout time.Duration)

WaitFor waits for the specified duration, or until the operation finishes, whichever happens first.

type OperationHandler

type OperationHandler struct {
	// contains filtered or unexported fields
}

func (*OperationHandler) ServeHTTP

func (h *OperationHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type Operations

type Operations struct {
	// contains filtered or unexported fields
}

Operations tracks all the ongoing operations.

func NewOperations

func NewOperations() *Operations

NewOperations returns a new Operations repository.

func (*Operations) Get

func (ops *Operations) Get(id string) *Operation

Get returns the operation with the given ID, or nil.

func (*Operations) List

func (ops *Operations) List() *api.ServerOpList

List lists operations for an API client.

func (*Operations) NewOperation

func (ops *Operations) NewOperation(from <-chan RESTResult, onReceive func(RESTResult)) *Operation

NewOperation adds a new operation. It is lock-free. 'onReceive' will be called with the value read from 'from', when it is read.

type ProxyHandler

type ProxyHandler struct {
	// contains filtered or unexported fields
}

ProxyHandler provides a http.Handler which will proxy traffic to locations specified by items implementing Redirector.

func (*ProxyHandler) ServeHTTP

func (r *ProxyHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type RESTHandler

type RESTHandler struct {
	// contains filtered or unexported fields
}

RESTHandler implements HTTP verbs on a set of RESTful resources identified by name.

func (*RESTHandler) ServeHTTP

func (h *RESTHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP handles requests to all RESTStorage objects.

type RESTResult

type RESTResult struct {
	// The result of this operation. May be nil if the operation has no meaningful
	// result (like Delete)
	runtime.Object

	// May be set true to indicate that the Update operation resulted in the object
	// being created.
	Created bool
}

RESTResult indicates the result of a REST transformation.

type RESTStorage

type RESTStorage interface {
	// New returns an empty object that can be used with Create and Update after request data has been put into it.
	// This object must be a pointer type for use with Codec.DecodeInto([]byte, runtime.Object)
	New() runtime.Object

	// List selects resources in the storage which match to the selector.
	List(ctx api.Context, label, field labels.Selector) (runtime.Object, error)

	// Get finds a resource in the storage by id and returns it.
	// Although it can return an arbitrary error value, IsNotFound(err) is true for the
	// returned error value err when the specified resource is not found.
	Get(ctx api.Context, id string) (runtime.Object, error)

	// Delete finds a resource in the storage and deletes it.
	// Although it can return an arbitrary error value, IsNotFound(err) is true for the
	// returned error value err when the specified resource is not found.
	Delete(ctx api.Context, id string) (<-chan RESTResult, error)

	// Create creates a new version of a resource.
	Create(ctx api.Context, obj runtime.Object) (<-chan RESTResult, error)

	// Update finds a resource in the storage and updates it. Some implementations
	// may allow updates creates the object - they should set the Created flag of
	// the returned RESTResultto true. In the event of an asynchronous error returned
	// via an api.Status object, the Created flag is ignored.
	Update(ctx api.Context, obj runtime.Object) (<-chan RESTResult, error)
}

RESTStorage is a generic interface for RESTful storage services. Resources which are exported to the RESTful API of apiserver need to implement this interface.

type RedirectHandler

type RedirectHandler struct {
	// contains filtered or unexported fields
}

func (*RedirectHandler) ServeHTTP

func (r *RedirectHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type Redirector

type Redirector interface {
	// ResourceLocation should return the remote location of the given resource, or an error.
	ResourceLocation(ctx api.Context, id string) (remoteLocation string, err error)
}

Redirector know how to return a remote resource's location.

type RequestAttributeGetter

type RequestAttributeGetter interface {
	GetAttribs(req *http.Request) (attribs authorizer.Attributes)
}

RequestAttributeGetter is a function that extracts authorizer.Attributes from an http.Request

func NewRequestAttributeGetter

func NewRequestAttributeGetter(userContexts authhandlers.RequestContext) RequestAttributeGetter

NewAttributeGetter returns an object which implements the RequestAttributeGetter interface.

type ResourceWatcher

type ResourceWatcher interface {
	// 'label' selects on labels; 'field' selects on the object's fields. Not all fields
	// are supported; an error should be returned if 'field' tries to select on a field that
	// isn't supported. 'resourceVersion' allows for continuing/starting a watch at a
	// particular version.
	Watch(ctx api.Context, label, field labels.Selector, resourceVersion string) (watch.Interface, error)
}

ResourceWatcher should be implemented by all RESTStorage objects that want to offer the ability to watch for changes through the watch api.

type Server

type Server struct {
	Addr string
	Port int
	Path string
}

type ServerStatus

type ServerStatus struct {
	Component  string        `json:"component,omitempty"`
	Health     string        `json:"health,omitempty"`
	HealthCode health.Status `json:"healthCode,omitempty"`
	Msg        string        `json:"msg,omitempty"`
	Err        string        `json:"err,omitempty"`
}

type WatchHandler

type WatchHandler struct {
	// contains filtered or unexported fields
}

func (*WatchHandler) ServeHTTP

func (h *WatchHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP processes watch requests.

type WatchServer

type WatchServer struct {
	// contains filtered or unexported fields
}

WatchServer serves a watch.Interface over a websocket or vanilla HTTP.

func (*WatchServer) HandleWS

func (w *WatchServer) HandleWS(ws *websocket.Conn)

HandleWS implements a websocket handler.

func (*WatchServer) ServeHTTP

func (self *WatchServer) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP serves a series of JSON encoded events via straight HTTP with Transfer-Encoding: chunked.

type WorkFunc

type WorkFunc func() (result runtime.Object, err error)

WorkFunc is used to perform any time consuming work for an api call, after the input has been validated. Pass one of these to MakeAsync to create an appropriate return value for the Update, Delete, and Create methods.

type WorkResultFunc

type WorkResultFunc func() (result RESTResult, err error)

WorkFunc is used to perform any time consuming work for an api call, after the input has been validated. Pass one of these to MakeAsync to create an appropriate return value for the Update, Delete, and Create methods.