web

Documentation

Index

• type Server
  • func NewServer(port int32, tlsCertFile, tlsKeyFile string, shutdownGracePeriod time.Duration, ...) *Server
  • func (s *Server) RegisterService(service osprey.Osprey)
  • func (s *Server) Start() error

Types

type Server

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

Server contains the configuration for the HTTP server

func NewServer

func NewServer(port int32, tlsCertFile, tlsKeyFile string, shutdownGracePeriod time.Duration, serveClusterInfo bool, authenticationEnabled bool) *Server

NewServer creates a new Server definition with an empty ServeMux

func (*Server) RegisterService

func (s *Server) RegisterService(service osprey.Osprey)

RegisterService binds the http endpoints to the Osprey services "/access-token" -> Osprey.RetrieveClusterDetailsAndAuthTokens()

func (*Server) Start

func (s *Server) Start() error

Start starts a new HTTP server listening at the specified port. If the server configuration contains tls data, it will start the server with TLS enabled. Start is a blocking method that listens for SIGINT or SIGTERM to start a graceful shutdown, with a timeout specified in the server configuration.