apiserver

Documentation

Index

• func DefaultAPIResourceConfigSource() *serverstorage.ResourceConfig
• type APIAggregator
  • func (s *APIAggregator) AddAPIService(apiService *apiregistration.APIService) error
  • func (s *APIAggregator) RemoveAPIService(apiServiceName string)
• type APIHandlerManager
• type APIServiceRegistrationController
  • func NewAPIServiceRegistrationController(apiServiceInformer informers.APIServiceInformer, ...) *APIServiceRegistrationController
  • func (c *APIServiceRegistrationController) Run(stopCh <-chan struct{})
• type CompletedConfig
  • func (c CompletedConfig) NewWithDelegate(delegationTarget genericapiserver.DelegationTarget) (*APIAggregator, error)
• type Config
  • func (cfg *Config) Complete() CompletedConfig
• type ExtraConfig
• type ServiceResolver
  • func NewClusterIPServiceResolver(services listersv1.ServiceLister) ServiceResolver
  • func NewEndpointServiceResolver(services listersv1.ServiceLister, endpoints listersv1.EndpointsLister) ServiceResolver
  • func NewLoopbackServiceResolver(delegate ServiceResolver, host *url.URL) ServiceResolver

Functions

func DefaultAPIResourceConfigSource

func DefaultAPIResourceConfigSource() *serverstorage.ResourceConfig

DefaultAPIResourceConfigSource returns default configuration for an APIResource.

Types

type APIAggregator

type APIAggregator struct {
	GenericAPIServer *genericapiserver.GenericAPIServer

	// provided for easier embedding
	APIRegistrationInformers informers.SharedInformerFactory
	// contains filtered or unexported fields
}

APIAggregator contains state for a Kubernetes cluster master/api server.

func (*APIAggregator) AddAPIService

func (s *APIAggregator) AddAPIService(apiService *apiregistration.APIService) error

AddAPIService adds an API service. It is not thread-safe, so only call it on one thread at a time please. It's a slow moving API, so it's ok to run the controller on a single thread

func (*APIAggregator) RemoveAPIService

func (s *APIAggregator) RemoveAPIService(apiServiceName string)

RemoveAPIService removes the APIService from being handled. It is not thread-safe, so only call it on one thread at a time please. It's a slow moving API, so it's ok to run the controller on a single thread.

type APIHandlerManager

type APIHandlerManager interface {
	AddAPIService(apiService *apiregistration.APIService) error
	RemoveAPIService(apiServiceName string)
}

APIHandlerManager defines the behaviour that an API handler should have.

type APIServiceRegistrationController

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

APIServiceRegistrationController is responsible for registering and removing API services.

func NewAPIServiceRegistrationController

func NewAPIServiceRegistrationController(apiServiceInformer informers.APIServiceInformer, apiHandlerManager APIHandlerManager) *APIServiceRegistrationController

NewAPIServiceRegistrationController returns a new APIServiceRegistrationController.

func (*APIServiceRegistrationController) Run

func (c *APIServiceRegistrationController) Run(stopCh <-chan struct{})

Run starts APIServiceRegistrationController which will process all registration requests until stopCh is closed.

type CompletedConfig

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

CompletedConfig same as Config, just to swap private object.

func (CompletedConfig) NewWithDelegate

func (c CompletedConfig) NewWithDelegate(delegationTarget genericapiserver.DelegationTarget) (*APIAggregator, error)

NewWithDelegate returns a new instance of APIAggregator from the given config.

type Config

type Config struct {
	GenericConfig *genericapiserver.RecommendedConfig
	ExtraConfig   ExtraConfig
}

Config represents the configuration needed to create an APIAggregator.

func (*Config) Complete

func (cfg *Config) Complete() CompletedConfig

Complete fills in any fields not set that are required to have valid data. It's mutating the receiver.

type ExtraConfig

type ExtraConfig struct {
	// ProxyClientCert/Key are the client cert used to identify this proxy. Backing APIServices use
	// this to confirm the proxy's identity
	ProxyClientCert []byte
	ProxyClientKey  []byte

	// If present, the Dial method will be used for dialing out to delegate
	// apiservers.
	ProxyTransport *http.Transport

	// Mechanism by which the Aggregator will resolve services. Required.
	ServiceResolver ServiceResolver
}

ExtraConfig represents APIServices-specific configuration

type ServiceResolver

type ServiceResolver interface {
	ResolveEndpoint(namespace, name string) (*url.URL, error)
}

A ServiceResolver knows how to get a URL given a service.

func NewClusterIPServiceResolver

func NewClusterIPServiceResolver(services listersv1.ServiceLister) ServiceResolver

NewClusterIPServiceResolver returns a ServiceResolver that directly calls the service's cluster IP.

func NewEndpointServiceResolver

func NewEndpointServiceResolver(services listersv1.ServiceLister, endpoints listersv1.EndpointsLister) ServiceResolver

NewEndpointServiceResolver returns a ServiceResolver that chooses one of the service's endpoints.

func NewLoopbackServiceResolver

func NewLoopbackServiceResolver(delegate ServiceResolver, host *url.URL) ServiceResolver

NewLoopbackServiceResolver returns a ServiceResolver that routes the kubernetes/default service to loopback.