api

Documentation

Index

• type Server
  • func New(loadedClusters *clusters.Clusters, pluginsRouter chi.Router, ...) (*Server, error)
  • func (s *Server) Start()
  • func (s *Server) Stop()

Types

type Server

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

Server implements the api server. The api server is used to serve the rest api for kobs.

func New

func New(loadedClusters *clusters.Clusters, pluginsRouter chi.Router, isDevelopment bool) (*Server, error)

New return a new api server. It creates the underlying http server, with the defined address from the api.address flag. When the development flag is set we also set some cors option, so we do not have to care about cors for development. We exclude the health check from all middlewares, because the health check just returns 200. Therefore we do not need our defined middlewares like request id, metrics, auth or loggin. This also makes it easier to analyze the logs in a Kubernetes cluster where the health check is called every x seconds, because we generate less logs.

func (*Server) Start

func (s *Server) Start()

Start starts serving the api server.

func (*Server) Stop

func (s *Server) Stop()

Stop terminates the api server gracefully.