server

Documentation

Index

• Variables
• func RestConfigDefaults(cfg *rest.Config) *rest.Config
• type Controllers
  • func NewController(cfg *rest.Config, opts *generic.FactoryOptions) (*Controllers, error)
  • func (c *Controllers) Start(ctx context.Context) error
• type ExtensionAPIServer
• type Options
• type Server
  • func New(ctx context.Context, restConfig *rest.Config, opts *Options) (*Server, error)
  • func (c *Server) ListenAndServe(ctx context.Context, httpsPort, httpPort int, opts *server.ListenOpts) error
  • func (c *Server) StartAggregation(ctx context.Context)
• type StartHook

Variables

var ErrConfigRequired = errors.New("rest config is required")

Functions

func RestConfigDefaults

func RestConfigDefaults(cfg *rest.Config) *rest.Config

Types

type Controllers

type Controllers struct {
	RESTConfig *rest.Config
	K8s        kubernetes.Interface
	Core       corev1.Interface
	RBAC       rbacv1.Interface
	API        apiregistrationv1.Interface
	CRD        apiextensionsv1.Interface
	// contains filtered or unexported fields
}

func NewController

func NewController(cfg *rest.Config, opts *generic.FactoryOptions) (*Controllers, error)

func (*Controllers) Start

func (c *Controllers) Start(ctx context.Context) error

type ExtensionAPIServer

type ExtensionAPIServer interface {
	// The ExtensionAPIServer is served at /ext in Steve's mux
	http.Handler
	// Run configures the API server and make the HTTP handler available
	Run(ctx context.Context) error
}

ExtensionAPIServer will run an extension API server. The extension API server will be accessible from Steve at the /ext endpoint and will be compatible with the aggregate API server in Kubernetes.

type Options

type Options struct {
	// Controllers If the controllers are passed in the caller must also start the controllers
	Controllers                *Controllers
	ClientFactory              *client.Factory
	AccessSetLookup            accesscontrol.AccessSetLookup
	AuthMiddleware             auth.Middleware
	Next                       http.Handler
	Router                     router.RouterFunc
	AggregationSecretNamespace string
	AggregationSecretName      string
	ClusterRegistry            string
	ServerVersion              string
	// SQLCache enables the SQLite-based caching mechanism
	SQLCache bool

	// ExtensionAPIServer enables an extension API server that will be served
	// under /ext
	// If nil, Steve's default http handler for unknown routes will be served.
	//
	// In most cases, you'll want to use [github.com/rancher/steve/pkg/ext.NewExtensionAPIServer]
	// to create an ExtensionAPIServer.
	ExtensionAPIServer ExtensionAPIServer
}

type Server

type Server struct {
	http.Handler

	ClientFactory   *client.Factory
	ClusterCache    clustercache.ClusterCache
	SchemaFactory   schema.Factory
	RESTConfig      *rest.Config
	BaseSchemas     *types.APISchemas
	AccessSetLookup accesscontrol.AccessSetLookup
	APIServer       *apiserver.Server
	ClusterRegistry string
	Version         string

	SQLCache bool
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, restConfig *rest.Config, opts *Options) (*Server, error)

func (*Server) ListenAndServe

func (c *Server) ListenAndServe(ctx context.Context, httpsPort, httpPort int, opts *server.ListenOpts) error

func (*Server) StartAggregation

func (c *Server) StartAggregation(ctx context.Context)

type StartHook

type StartHook func(context.Context, *Server) error