octant

Documentation

Index

• func GetFrontendHandler() (http.Handler, error)
• func SetFrontendHandler(handlerFn func() (http.Handler, error))
• type HandlerFactory
  • func NewHandlerFactory(optionList ...Option) *HandlerFactory
  • func (hf *HandlerFactory) Handler(ctx context.Context) (http.Handler, error)
  • func (hf *HandlerFactory) SetFrontend(fn HandlerFactoryFunc)
• type HandlerFactoryFunc
• type Option
  • func BackendHandler(fn func(ctx context.Context) (http.Handler, error)) Option
  • func FrontendURL(proxyURL string) Option
• type ProxiedFrontendHandler
  • func NewProxiedFrontend(ctx context.Context, targetURL string) (*ProxiedFrontendHandler, error)
  • func (p ProxiedFrontendHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Functions

func GetFrontendHandler

func GetFrontendHandler() (http.Handler, error)

func SetFrontendHandler

func SetFrontendHandler(handlerFn func() (http.Handler, error))

Types

type HandlerFactory

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

HandlerFactory is a factory that generate's Octant's HTTP handler. Octant has a frontend and backend handler and they will both be populated in the generated handler.

func NewHandlerFactory

func NewHandlerFactory(optionList ...Option) *HandlerFactory

NewHandlerFactory creates an instance of HandlerFactory.

func (*HandlerFactory) Handler

func (hf *HandlerFactory) Handler(ctx context.Context) (http.Handler, error)

Handler returns an HTTP handler.

func (*HandlerFactory) SetFrontend

func (hf *HandlerFactory) SetFrontend(fn HandlerFactoryFunc)

type HandlerFactoryFunc

type HandlerFactoryFunc func(ctx context.Context) (http.Handler, error)

type Option

type Option func(o *options)

Option is a functional option for configuring Octant.

func BackendHandler

func BackendHandler(fn func(ctx context.Context) (http.Handler, error)) Option

BackendHandler sets the handler for Octant's backend.

func FrontendURL

func FrontendURL(proxyURL string) Option

FrontendURL configures Octant to use a proxy for rendering its frontend.

type ProxiedFrontendHandler

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

ProxiedFrontendHandler creates an HTTP handler that proxies to a target URL.

func NewProxiedFrontend

func NewProxiedFrontend(ctx context.Context, targetURL string) (*ProxiedFrontendHandler, error)

NewProxiedFrontend creates an instance of ProxiedFrontendHandler. It will return an error if the proxy can not be created.

func (ProxiedFrontendHandler) ServeHTTP

func (p ProxiedFrontendHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP allows ProxiedFrontendHandler to satisfy the http.Handler interface.