genericapiserver

package
v1.5.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 11, 2016 License: Apache-2.0 Imports: 59 Imported by: 0

Documentation

Overview

Package genericapiserver contains code to setup a generic kubernetes-like API server. This does not contain any kubernetes API specific code. Note that this is a work in progress. We are pulling out generic code (specifically from pkg/master and pkg/apiserver) here. We plan to move this package into a separate repo on github once it is done. For more details: https://github.com/kubernetes/kubernetes/issues/2742

Index

Constants

View Source 
const AllResources = "*"

Variables

This section is empty.

Functions

func DefaultAndValidateRunOptions added in v1.3.0 

func DefaultAndValidateRunOptions(options *options.ServerRunOptions)

func DefaultBuildHandlerChain added in v1.5.0 

func DefaultBuildHandlerChain(apiHandler http.Handler, c *Config) (secure, insecure http.Handler)

func NewRequestInfoResolver added in v1.5.0 

func NewRequestInfoResolver(c *Config) *request.RequestInfoFactory

func NewStorageCodec added in v1.3.0 

func NewStorageCodec(storageMediaType string, ns runtime.StorageSerializer, storageVersion, memoryVersion unversioned.GroupVersion, config storagebackend.Config) (runtime.Codec, error)

NewStorageCodec assembles a storage codec for the provided storage media type, the provided serializer, and the requested storage and memory versions.

func TunnelSyncHealthChecker added in v1.5.0 

func TunnelSyncHealthChecker(tunneler Tunneler) func(req *http.Request) error

TunnelSyncHealthChecker returns a health func that indicates if a tunneler is healthy. It's compatible with healthz.NamedCheck

Types

type APIGroupInfo 

type APIGroupInfo struct {
	GroupMeta apimachinery.GroupMeta
	// Info about the resources in this group. Its a map from version to resource to the storage.
	VersionedResourcesStorageMap map[string]map[string]rest.Storage
	// True, if this is the legacy group ("/v1").
	IsLegacyGroup bool
	// OptionsExternalVersion controls the APIVersion used for common objects in the
	// schema like api.Status, api.DeleteOptions, and api.ListOptions. Other implementors may
	// define a version "v1beta1" but want to use the Kubernetes "v1" internal objects.
	// If nil, defaults to groupMeta.GroupVersion.
	// TODO: Remove this when https://github.com/kubernetes/kubernetes/issues/19018 is fixed.
	OptionsExternalVersion *unversioned.GroupVersion

	// Scheme includes all of the types used by this group and how to convert between them (or
	// to convert objects from outside of this group that are accepted in this API).
	// TODO: replace with interfaces
	Scheme *runtime.Scheme
	// NegotiatedSerializer controls how this group encodes and decodes data
	NegotiatedSerializer runtime.NegotiatedSerializer
	// ParameterCodec performs conversions for query parameters passed to API calls
	ParameterCodec runtime.ParameterCodec

	// SubresourceGroupVersionKind contains the GroupVersionKind overrides for each subresource that is
	// accessible from this API group version. The GroupVersionKind is that of the external version of
	// the subresource. The key of this map should be the path of the subresource. The keys here should
	// match the keys in the Storage map above for subresources.
	SubresourceGroupVersionKind map[string]unversioned.GroupVersionKind
}

Info about an API group.

func NewDefaultAPIGroupInfo added in v1.4.0 

func NewDefaultAPIGroupInfo(group string) APIGroupInfo

NewDefaultAPIGroupInfo returns an APIGroupInfo stubbed with "normal" values exposed for easier composition from other packages

type APIResourceConfigSource added in v1.3.0 

type APIResourceConfigSource interface {
	AnyVersionOfResourceEnabled(resource unversioned.GroupResource) bool
	ResourceEnabled(resource unversioned.GroupVersionResource) bool
	AllResourcesForVersionEnabled(version unversioned.GroupVersion) bool
	AnyResourcesForVersionEnabled(version unversioned.GroupVersion) bool
	AnyResourcesForGroupEnabled(group string) bool
}

APIResourceConfigSource is the interface to determine which versions and resources are enabled

type AddressFunc added in v1.3.0 

type AddressFunc func() (addresses []string, err error)

type CertInfo 

type CertInfo struct {
	// CertFile is a file containing a PEM-encoded certificate
	CertFile string
	// KeyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile
	KeyFile string
	// Generate indicates that the cert/key pair should be generated if its not present.
	Generate bool
}

type Config 

type Config struct {
	// Destination for audit logs
	AuditWriter io.Writer
	// Allow downstream consumers to disable swagger.
	// This includes returning the generated swagger spec at /swaggerapi and swagger ui at /swagger-ui.
	EnableSwaggerSupport bool
	// Allow downstream consumers to disable swagger ui.
	// Note that this is ignored if EnableSwaggerSupport is false
	EnableSwaggerUI bool
	// Allows api group versions or specific resources to be conditionally enabled/disabled.
	APIResourceConfigSource APIResourceConfigSource
	// allow downstream consumers to disable the index route
	EnableIndex             bool
	EnableProfiling         bool
	EnableVersion           bool
	EnableGarbageCollection bool
	APIPrefix               string
	APIGroupPrefix          string
	CorsAllowedOriginList   []string
	Authenticator           authenticator.Request
	// TODO(roberthbailey): Remove once the server no longer supports http basic auth.
	SupportsBasicAuth      bool
	Authorizer             authorizer.Authorizer
	AdmissionControl       admission.Interface
	MasterServiceNamespace string
	// TODO(ericchiang): Determine if policy escalation checks should be an admission controller.
	AuthorizerRBACSuperUser string

	// LoopbackClientConfig is a config for a privileged loopback connection to the API server
	LoopbackClientConfig *restclient.Config

	// Map requests to contexts. Exported so downstream consumers can provider their own mappers
	RequestContextMapper api.RequestContextMapper

	// Required, the interface for serializing and converting objects to and from the wire
	Serializer runtime.NegotiatedSerializer

	// If specified, requests will be allocated a random timeout between this value, and twice this value.
	// Note that it is up to the request handlers to ignore or honor this timeout. In seconds.
	MinRequestTimeout int

	// Number of masters running; all masters must be started with the
	// same value for this field. (Numbers > 1 currently untested.)
	MasterCount int

	SecureServingInfo   *ServingInfo
	InsecureServingInfo *ServingInfo

	// The port on PublicAddress where a read-write server will be installed.
	// Defaults to 6443 if not set.
	ReadWritePort int

	// ExternalHost is the host name to use for external (public internet) facing URLs (e.g. Swagger)
	ExternalHost string

	// PublicAddress is the IP address where members of the cluster (kubelet,
	// kube-proxy, services, etc.) can reach the GenericAPIServer.
	// If nil or 0.0.0.0, the host's default interface will be used.
	PublicAddress net.IP

	// Control the interval that pod, node IP, and node heath status caches
	// expire.
	CacheTimeout time.Duration

	// The range of IPs to be assigned to services with type=ClusterIP or greater
	ServiceClusterIPRange *net.IPNet

	// The IP address for the GenericAPIServer service (must be inside ServiceClusterIPRange)
	ServiceReadWriteIP net.IP

	// Port for the apiserver service.
	ServiceReadWritePort int

	// The range of ports to be assigned to services with type=NodePort or greater
	ServiceNodePortRange utilnet.PortRange

	// Used to customize default proxy dial/tls options
	ProxyDialer          apiserver.ProxyDialerFunc
	ProxyTLSClientConfig *tls.Config

	// Additional ports to be exposed on the GenericAPIServer service
	// extraServicePorts is injectable in the event that more ports
	// (other than the default 443/tcp) are exposed on the GenericAPIServer
	// and those ports need to be load balanced by the GenericAPIServer
	// service because this pkg is linked by out-of-tree projects
	// like openshift which want to use the GenericAPIServer but also do
	// more stuff.
	ExtraServicePorts []api.ServicePort
	// Additional ports to be exposed on the GenericAPIServer endpoints
	// Port names should align with ports defined in ExtraServicePorts
	ExtraEndpointPorts []api.EndpointPort

	// If non-zero, the "kubernetes" services uses this port as NodePort.
	// TODO(sttts): move into master
	KubernetesServiceNodePort int

	// EnableOpenAPISupport enables OpenAPI support. Allow downstream customers to disable OpenAPI spec.
	EnableOpenAPISupport bool

	// OpenAPIInfo will be directly available as Info section of Open API spec.
	OpenAPIInfo spec.Info

	// OpenAPIDefaultResponse will be used if an web service operation does not have any responses listed.
	OpenAPIDefaultResponse spec.Response

	// OpenAPIDefinitions is a map of type to OpenAPI spec for all types used in this API server. Failure to provide
	// this map or any of the models used by the server APIs will result in spec generation failure.
	OpenAPIDefinitions *common.OpenAPIDefinitions

	// MaxRequestsInFlight is the maximum number of parallel non-long-running requests. Every further
	// request has to wait.
	MaxRequestsInFlight int

	// Predicate which is true for paths of long-running http requests
	LongRunningFunc genericfilters.LongRunningRequestCheck

	// Build the handler chains by decorating the apiHandler.
	BuildHandlerChainsFunc func(apiHandler http.Handler, c *Config) (secure, insecure http.Handler)
}

Config is a structure used to configure a GenericAPIServer.

func NewConfig added in v1.3.0 

func NewConfig(options *options.ServerRunOptions) *Config

func (*Config) Complete added in v1.5.0 

func (c *Config) Complete() completedConfig

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

func (*Config) SkipComplete added in v1.5.0 

func (c *Config) SkipComplete() completedConfig

SkipComplete provides a way to construct a server instance without config completion.

type DefaultResourceEncodingConfig added in v1.3.0 

type DefaultResourceEncodingConfig struct {
	Groups map[string]*GroupResourceEncodingConfig
}

func NewDefaultResourceEncodingConfig added in v1.3.0 

func NewDefaultResourceEncodingConfig() *DefaultResourceEncodingConfig

func (*DefaultResourceEncodingConfig) InMemoryEncodingFor added in v1.3.0 

func (o *DefaultResourceEncodingConfig) InMemoryEncodingFor(resource unversioned.GroupResource) (unversioned.GroupVersion, error)

func (*DefaultResourceEncodingConfig) SetResourceEncoding added in v1.3.0 

func (o *DefaultResourceEncodingConfig) SetResourceEncoding(resourceBeingStored unversioned.GroupResource, externalEncodingVersion, internalVersion unversioned.GroupVersion)

func (*DefaultResourceEncodingConfig) SetVersionEncoding added in v1.3.0 

func (o *DefaultResourceEncodingConfig) SetVersionEncoding(group string, externalEncodingVersion, internalVersion unversioned.GroupVersion)

func (*DefaultResourceEncodingConfig) StorageEncodingFor added in v1.3.0 

func (o *DefaultResourceEncodingConfig) StorageEncodingFor(resource unversioned.GroupResource) (unversioned.GroupVersion, error)

type DefaultStorageFactory added in v1.3.0 

type DefaultStorageFactory struct {
	// StorageConfig describes how to create a storage backend in general.
	// Its authentication information will be used for every storage.Interface returned.
	StorageConfig storagebackend.Config

	Overrides map[unversioned.GroupResource]groupResourceOverrides

	// DefaultMediaType is the media type used to store resources. If it is not set, "application/json" is used.
	DefaultMediaType string

	// DefaultSerializer is used to create encoders and decoders for the storage.Interface.
	DefaultSerializer runtime.StorageSerializer

	// ResourceEncodingConfig describes how to encode a particular GroupVersionResource
	ResourceEncodingConfig ResourceEncodingConfig

	// APIResourceConfigSource indicates whether the *storage* is enabled, NOT the API
	// This is discrete from resource enablement because those are separate concerns.  How this source is configured
	// is left to the caller.
	APIResourceConfigSource APIResourceConfigSource
	// contains filtered or unexported fields
}

DefaultStorageFactory takes a GroupResource and returns back its storage interface. This result includes: 1. Merged etcd config, including: auth, server locations, prefixes 2. Resource encodings for storage: group,version,kind to store as 3. Cohabitating default: some resources like hpa are exposed through multiple APIs. They must agree on 1 and 2

func BuildDefaultStorageFactory added in v1.3.0 

func BuildDefaultStorageFactory(storageConfig storagebackend.Config, defaultMediaType string, serializer runtime.StorageSerializer,
	defaultResourceEncoding *DefaultResourceEncodingConfig, storageEncodingOverrides map[string]unversioned.GroupVersion, resourceEncodingOverrides []unversioned.GroupVersionResource,
	defaultAPIResourceConfig *ResourceConfig, resourceConfigOverrides config.ConfigurationMap) (*DefaultStorageFactory, error)

Builds the DefaultStorageFactory. Merges defaultResourceConfig with the user specified overrides and merges defaultAPIResourceConfig with the corresponding user specified overrides as well.

func NewDefaultStorageFactory added in v1.3.0 

func NewDefaultStorageFactory(config storagebackend.Config, defaultMediaType string, defaultSerializer runtime.StorageSerializer, resourceEncodingConfig ResourceEncodingConfig, resourceConfig APIResourceConfigSource) *DefaultStorageFactory

func (*DefaultStorageFactory) AddCohabitatingResources added in v1.3.0 

func (s *DefaultStorageFactory) AddCohabitatingResources(groupResources ...unversioned.GroupResource)

AddCohabitatingResources links resources together the order of the slice matters! its the priority order of lookup for finding a storage location

func (*DefaultStorageFactory) Backends added in v1.3.0 

func (s *DefaultStorageFactory) Backends() []string

Get all backends for all registered storage destinations. Used for getting all instances for health validations.

func (*DefaultStorageFactory) NewConfig added in v1.4.0 

func (s *DefaultStorageFactory) NewConfig(groupResource unversioned.GroupResource) (*storagebackend.Config, error)

New finds the storage destination for the given group and resource. It will return an error if the group has no storage destination configured.

func (*DefaultStorageFactory) ResourcePrefix added in v1.4.0 

func (s *DefaultStorageFactory) ResourcePrefix(groupResource unversioned.GroupResource) string

func (*DefaultStorageFactory) SetEtcdLocation added in v1.3.0 

func (s *DefaultStorageFactory) SetEtcdLocation(groupResource unversioned.GroupResource, location []string)

func (*DefaultStorageFactory) SetEtcdPrefix added in v1.3.0 

func (s *DefaultStorageFactory) SetEtcdPrefix(groupResource unversioned.GroupResource, prefix string)

func (*DefaultStorageFactory) SetResourceEtcdPrefix added in v1.4.0 

func (s *DefaultStorageFactory) SetResourceEtcdPrefix(groupResource unversioned.GroupResource, prefix string)

SetResourceEtcdPrefix sets the prefix for a resource, but not the base-dir. You'll end up in `etcdPrefix/resourceEtcdPrefix`.

func (*DefaultStorageFactory) SetSerializer added in v1.3.0 

func (s *DefaultStorageFactory) SetSerializer(groupResource unversioned.GroupResource, mediaType string, serializer runtime.StorageSerializer)

type GenericAPIServer 

type GenericAPIServer struct {
	// ServiceClusterIPRange is used to build cluster IPs for discovery.  It is exposed so that `master.go` can
	// construct service storage.
	// TODO refactor this so that `master.go` drives the value used for discovery and the value here isn't exposed.
	// that structure will force usage in the correct direction where the "owner" of the value is the source of
	// truth for its value.
	ServiceClusterIPRange *net.IPNet

	// ServiceNodePortRange is only used for `master.go` to construct its RESTStorage for the legacy API group
	// TODO refactor this closer to the point of use.
	ServiceNodePortRange utilnet.PortRange

	// LoopbackClientConfig is a config for a privileged loopback connection to the API server
	LoopbackClientConfig *restclient.Config

	// The registered APIs
	HandlerContainer *genericmux.APIContainer

	SecureServingInfo   *ServingInfo
	InsecureServingInfo *ServingInfo

	// ExternalAddress is the address (hostname or IP and port) that should be used in
	// external (public internet) URLs for this GenericAPIServer.
	ExternalAddress string

	// ClusterIP is the IP address of the GenericAPIServer within the cluster.
	ClusterIP net.IP

	// Serializer controls how common API objects not in a group/version prefix are serialized for this server.
	// Individual APIGroups may define their own serializers.
	Serializer runtime.NegotiatedSerializer

	// "Outputs"
	Handler         http.Handler
	InsecureHandler http.Handler

	// Used for custom proxy dialing, and proxy TLS options
	ProxyTransport http.RoundTripper

	MasterCount               int
	KubernetesServiceNodePort int // TODO(sttts): move into master
	PublicReadWritePort       int
	ServiceReadWriteIP        net.IP
	ServiceReadWritePort      int
	ExtraServicePorts         []api.ServicePort
	ExtraEndpointPorts        []api.EndpointPort
	// contains filtered or unexported fields
}

GenericAPIServer contains state for a Kubernetes cluster api server.

func (*GenericAPIServer) AddAPIGroupForDiscovery 

func (s *GenericAPIServer) AddAPIGroupForDiscovery(apiGroup unversioned.APIGroup)

func (*GenericAPIServer) AddPostStartHook added in v1.5.0 

func (s *GenericAPIServer) AddPostStartHook(name string, hook PostStartHookFunc) error

AddPostStartHook allows you to add a PostStartHook.

func (*GenericAPIServer) DynamicApisDiscovery added in v1.5.0 

func (s *GenericAPIServer) DynamicApisDiscovery() *restful.WebService

DynamicApisDiscovery returns a webservice serving api group discovery. Note: during the server runtime apiGroupsForDiscovery might change.

func (*GenericAPIServer) InstallAPIGroup added in v1.3.0 

func (s *GenericAPIServer) InstallAPIGroup(apiGroupInfo *APIGroupInfo) error

Exposes the given api group in the API.

func (*GenericAPIServer) InstallOpenAPI added in v1.4.0 

func (s *GenericAPIServer) InstallOpenAPI()

InstallOpenAPI installs spec endpoints for each web service.

func (*GenericAPIServer) InstallSwaggerAPI 

func (s *GenericAPIServer) InstallSwaggerAPI()

InstallSwaggerAPI installs the /swaggerapi/ endpoint to allow schema discovery and traversal. It is optional to allow consumers of the Kubernetes GenericAPIServer to register their own web services into the Kubernetes mux prior to initialization of swagger, so that other resource types show up in the documentation.

func (*GenericAPIServer) MinRequestTimeout 

func (s *GenericAPIServer) MinRequestTimeout() time.Duration

MinRequestTimeout is exposed so that third party resource storage can be build in a different location. TODO refactor third party resource storage

func (*GenericAPIServer) RemoveAPIGroupForDiscovery 

func (s *GenericAPIServer) RemoveAPIGroupForDiscovery(groupName string)

func (*GenericAPIServer) RequestContextMapper 

func (s *GenericAPIServer) RequestContextMapper() api.RequestContextMapper

RequestContextMapper is exposed so that third party resource storage can be build in a different location. TODO refactor third party resource storage

func (*GenericAPIServer) Run 

func (s *GenericAPIServer) Run()

func (*GenericAPIServer) RunPostStartHooks added in v1.5.0 

func (s *GenericAPIServer) RunPostStartHooks()

RunPostStartHooks runs the PostStartHooks for the server

type GroupResourceEncodingConfig added in v1.3.0 

type GroupResourceEncodingConfig struct {
	DefaultExternalEncoding   unversioned.GroupVersion
	ExternalResourceEncodings map[string]unversioned.GroupVersion

	DefaultInternalEncoding   unversioned.GroupVersion
	InternalResourceEncodings map[string]unversioned.GroupVersion
}

type GroupVersionResourceConfig added in v1.3.0 

type GroupVersionResourceConfig struct {
	// Whether to enable or disable this entire group version.  This dominates any enablement check.
	// Enable=true means the group version is enabled, and EnabledResources/DisabledResources are considered.
	// Enable=false means the group version is disabled, and EnabledResources/DisabledResources are not considered.
	Enable bool

	// DisabledResources lists the resources that are specifically disabled for a group/version
	// DisabledResources trumps EnabledResources
	DisabledResources sets.String

	// EnabledResources lists the resources that should be enabled by default.  This is a little
	// unusual, but we need it for compatibility with old code for now.  An empty set means
	// enable all, a non-empty set means that all other resources are disabled.
	EnabledResources sets.String
}

Specifies the overrides for various API group versions. This can be used to enable/disable entire group versions or specific resources.

func NewGroupVersionResourceConfig added in v1.3.0 

func NewGroupVersionResourceConfig() *GroupVersionResourceConfig

type InstallSSHKey added in v1.3.0 

type InstallSSHKey func(user string, data []byte) error

type PostStartHookContext added in v1.5.0 

type PostStartHookContext struct {
	// LoopbackClientConfig is a config for a privileged loopback connection to the API server
	LoopbackClientConfig *restclient.Config
}

PostStartHookContext provides information about this API server to a PostStartHookFunc

type PostStartHookFunc added in v1.5.0 

type PostStartHookFunc func(context PostStartHookContext) error

PostStartHookFunc is a function that is called after the server has started. It must properly handle cases like:

  1. asynchronous start in multiple API server processes
  2. conflicts between the different processes all trying to perform the same action
  3. partially complete work (API server crashes while running your hook)
  4. API server access **BEFORE** your hook has completed

Think of it like a mini-controller that is super privileged and gets to run in-process If you use this feature, tag @deads2k on github who has promised to review code for anyone's PostStartHook until it becomes easier to use.

type PostStartHookProvider added in v1.5.0 

type PostStartHookProvider interface {
	PostStartHook() (string, PostStartHookFunc, error)
}

PostStartHookProvider is an interface in addition to provide a post start hook for the api server

type RESTOptionsGetter added in v1.5.0 

type RESTOptionsGetter func(resource unversioned.GroupResource) generic.RESTOptions

type RESTStorageProvider added in v1.5.0 

type RESTStorageProvider interface {
	NewRESTStorage(apiResourceConfigSource APIResourceConfigSource, restOptionsGetter RESTOptionsGetter) (APIGroupInfo, bool)
}

type ResourceConfig added in v1.3.0 

type ResourceConfig struct {
	GroupVersionResourceConfigs map[unversioned.GroupVersion]*GroupVersionResourceConfig
}

func NewResourceConfig added in v1.3.0 

func NewResourceConfig() *ResourceConfig

func (*ResourceConfig) AllResourcesForVersionEnabled added in v1.3.0 

func (o *ResourceConfig) AllResourcesForVersionEnabled(version unversioned.GroupVersion) bool

func (*ResourceConfig) AnyResourcesForGroupEnabled added in v1.4.0 

func (o *ResourceConfig) AnyResourcesForGroupEnabled(group string) bool

func (*ResourceConfig) AnyResourcesForVersionEnabled added in v1.3.0 

func (o *ResourceConfig) AnyResourcesForVersionEnabled(version unversioned.GroupVersion) bool

func (*ResourceConfig) AnyVersionOfResourceEnabled added in v1.3.0 

func (o *ResourceConfig) AnyVersionOfResourceEnabled(resource unversioned.GroupResource) bool

AnyResourcesForVersionEnabled only considers matches based on exactly group/resource lexical matching. This means that resource renames across versions are NOT considered to be the same resource by this method. You'll need to manually check using the ResourceEnabled function.

func (*ResourceConfig) DisableResources added in v1.3.0 

func (o *ResourceConfig) DisableResources(resources ...unversioned.GroupVersionResource)

func (*ResourceConfig) DisableVersions added in v1.3.0 

func (o *ResourceConfig) DisableVersions(versions ...unversioned.GroupVersion)

DisableVersions disables the versions entirely. No resources (even those whitelisted in EnabledResources) will be enabled

func (*ResourceConfig) EnableResources added in v1.3.0 

func (o *ResourceConfig) EnableResources(resources ...unversioned.GroupVersionResource)

func (*ResourceConfig) EnableVersions added in v1.3.0 

func (o *ResourceConfig) EnableVersions(versions ...unversioned.GroupVersion)

func (*ResourceConfig) ResourceEnabled added in v1.3.0 

func (o *ResourceConfig) ResourceEnabled(resource unversioned.GroupVersionResource) bool

type ResourceEncodingConfig added in v1.3.0 

type ResourceEncodingConfig interface {
	// StorageEncoding returns the serialization format for the resource.
	// TODO this should actually return a GroupVersionKind since you can logically have multiple "matching" Kinds
	// For now, it returns just the GroupVersion for consistency with old behavior
	StorageEncodingFor(unversioned.GroupResource) (unversioned.GroupVersion, error)

	// InMemoryEncodingFor returns the groupVersion for the in memory representation the storage should convert to.
	InMemoryEncodingFor(unversioned.GroupResource) (unversioned.GroupVersion, error)
}

type SSHTunneler added in v1.3.0 

type SSHTunneler struct {
	SSHUser        string
	SSHKeyfile     string
	InstallSSHKey  InstallSSHKey
	HealthCheckURL *url.URL
	// contains filtered or unexported fields
}

func (*SSHTunneler) Dial added in v1.3.0 

func (c *SSHTunneler) Dial(net, addr string) (net.Conn, error)

func (*SSHTunneler) Run added in v1.3.0 

func (c *SSHTunneler) Run(getAddresses AddressFunc)

Run establishes tunnel loops and returns

func (*SSHTunneler) SecondsSinceSSHKeySync added in v1.3.0 

func (c *SSHTunneler) SecondsSinceSSHKeySync() int64

func (*SSHTunneler) SecondsSinceSync added in v1.3.0 

func (c *SSHTunneler) SecondsSinceSync() int64

func (*SSHTunneler) Stop added in v1.3.0 

func (c *SSHTunneler) Stop()

Stop gracefully shuts down the tunneler

type ServingInfo added in v1.5.0 

type ServingInfo struct {
	// BindAddress is the ip:port to serve on
	BindAddress string
	// ServerCert is the TLS cert info for serving secure traffic
	ServerCert CertInfo
	// ClientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates
	ClientCA string
}

type StorageFactory added in v1.3.0 

type StorageFactory interface {
	// New finds the storage destination for the given group and resource. It will
	// return an error if the group has no storage destination configured.
	NewConfig(groupResource unversioned.GroupResource) (*storagebackend.Config, error)

	// ResourcePrefix returns the overridden resource prefix for the GroupResource
	// This allows for cohabitation of resources with different native types and provides
	// centralized control over the shape of etcd directories
	ResourcePrefix(groupResource unversioned.GroupResource) string

	// Backends gets all backends for all registered storage destinations.
	// Used for getting all instances for health validations.
	Backends() []string
}

StorageFactory is the interface to locate the storage for a given GroupResource

type Tunneler added in v1.3.0 

type Tunneler interface {
	Run(AddressFunc)
	Stop()
	Dial(net, addr string) (net.Conn, error)
	SecondsSinceSync() int64
	SecondsSinceSSHKeySync() int64
}

func NewSSHTunneler added in v1.3.0 

func NewSSHTunneler(sshUser, sshKeyfile string, healthCheckURL *url.URL, installSSHKey InstallSSHKey) Tunneler

Source Files

View all Source files

Directories

Path Synopsis
Package filters contains all the http handler chain filters which are not api related.
 Package filters contains all the http handler chain filters which are not api related.
Package mux contains abstractions for http multiplexing of APIs.
 Package mux contains abstractions for http multiplexing of APIs.
Package openapi contains code to generate OpenAPI discovery spec (which initial version of it also known as Swagger 2.0).
 Package openapi contains code to generate OpenAPI discovery spec (which initial version of it also known as Swagger 2.0).
common
package common holds shared codes and types between open API code generator and spec generator.
 package common holds shared codes and types between open API code generator and spec generator.
package options is the public flags and options used by a generic api server.
 package options is the public flags and options used by a generic api server.
Package routes holds a collection of optional genericapiserver http handlers.
 Package routes holds a collection of optional genericapiserver http handlers.
data/swagger

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.