apiserver

Documentation

Index

• Constants
• type APIServer
  • func NewAPIServer(o *Options) (*APIServer, error)
  • func (api *APIServer) GetNodeBootstrapData(w http.ResponseWriter, r *http.Request)
  • func (api *APIServer) ListenAndServe(ctx context.Context) error
  • func (api *APIServer) NewRouter(ctx context.Context) *mux.Router
• type Options
• type Result
• type Route
• type Routes

Constants

const (
	// RoutePathNodeBootstrapping the route path to get node bootstrapping data.
	RoutePathNodeBootstrapData string = "/getnodebootstrapdata"
)

Types

type APIServer

type APIServer struct {
	Options *Options
}

APIServer contains the connections details required to run the api

func NewAPIServer

func NewAPIServer(o *Options) (*APIServer, error)

NewAPIServer creates an APIServer object with defaults

func (*APIServer) GetNodeBootstrapData

func (api *APIServer) GetNodeBootstrapData(w http.ResponseWriter, r *http.Request)

GetNodeBootstrapConfig endpoint for getting node bootstrapping data.

func (*APIServer) ListenAndServe

func (api *APIServer) ListenAndServe(ctx context.Context) error

ListenAndServe wraps http.Server and provides context-based cancelation.

func (*APIServer) NewRouter

func (api *APIServer) NewRouter(ctx context.Context) *mux.Router

NewRouter returns a new router with defaults

type Options

type Options struct {
	Addr string
}

Options holds the options for the api server

type Result

type Result struct {
	Message string
	Error   error
}

type Route

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
}

Route the route specifics

type Routes

type Routes []Route

Routes list of routes to be added to the server