server

Documentation

Index

• Constants
• func Run(opts *ServiceCatalogServerOptions, stopCh <-chan struct{}) error
• func RunServer(opts *ServiceCatalogServerOptions, stopCh <-chan struct{}) error
• type EtcdOptions
  • func NewEtcdOptions() *EtcdOptions
• type ServiceCatalogServerOptions
  • func NewServiceCatalogServerOptions() *ServiceCatalogServerOptions
  • func (s *ServiceCatalogServerOptions) AddFlags(flags *pflag.FlagSet)
  • func (s *ServiceCatalogServerOptions) StorageType() (server.StorageType, error)
  • func (s *ServiceCatalogServerOptions) Validate() error

Constants

const (
	// DefaultEtcdPathPrefix is the default prefix that is prepended to all
	// resource paths in etcd.  It is intended to allow an operator to
	// differentiate the storage of different API servers from one another in
	// a single etcd.
	DefaultEtcdPathPrefix = "/registry"
)

Functions

func Run

func Run(opts *ServiceCatalogServerOptions, stopCh <-chan struct{}) error

Run runs the specified APIServer. This should never exit.

func RunServer

func RunServer(opts *ServiceCatalogServerOptions, stopCh <-chan struct{}) error

RunServer runs an API server with configuration according to opts

Types

type EtcdOptions

type EtcdOptions struct {
	// storage with etcd
	*genericserveroptions.EtcdOptions
}

EtcdOptions contains the complete configuration for an API server that communicates with an etcd. This struct is exported so that it can be used by integration tests

func NewEtcdOptions

func NewEtcdOptions() *EtcdOptions

NewEtcdOptions creates a new, empty, EtcdOptions instance

type ServiceCatalogServerOptions

type ServiceCatalogServerOptions struct {
	StorageTypeString string
	// the runtime configuration of our server
	GenericServerRunOptions *genericserveroptions.ServerRunOptions
	// the admission options
	AdmissionOptions *genericserveroptions.AdmissionOptions
	// the https configuration. certs, etc
	SecureServingOptions *genericserveroptions.SecureServingOptions
	// authn for the API
	AuthenticationOptions *genericserveroptions.DelegatingAuthenticationOptions
	// authz for the API
	AuthorizationOptions *genericserveroptions.DelegatingAuthorizationOptions
	// audit options for api server
	AuditOptions *genericserveroptions.AuditOptions
	// EtcdOptions are options for serving with etcd as the backing store
	EtcdOptions *EtcdOptions
	// DisableAuth disables delegating authentication and authorization for testing scenarios
	DisableAuth bool
	// StandaloneMode if true asserts that we will not depend on a kube-apiserver
	StandaloneMode bool
	// whether or not to serve the OpenAPI spec (at /swagger.json)
	ServeOpenAPISpec bool
}

ServiceCatalogServerOptions contains the aggregation of configuration structs for the service-catalog server. It contains everything needed to configure a basic API server. It is public so that integration tests can access it.

func NewServiceCatalogServerOptions

func NewServiceCatalogServerOptions() *ServiceCatalogServerOptions

NewServiceCatalogServerOptions creates a new instances of ServiceCatalogServerOptions with all sub-options filled in.

func (*ServiceCatalogServerOptions) AddFlags

func (s *ServiceCatalogServerOptions) AddFlags(flags *pflag.FlagSet)

AddFlags adds to the flag set the flags to configure the API Server.

func (*ServiceCatalogServerOptions) StorageType

func (s *ServiceCatalogServerOptions) StorageType() (server.StorageType, error)

StorageType returns the storage type configured on s, or a non-nil error if s holds an invalid storage type

func (*ServiceCatalogServerOptions) Validate

func (s *ServiceCatalogServerOptions) Validate() error

Validate checks all subOptions flags have been set and that they have not been set in a conflictory manner.