satellite

Documentation

Index

• type Server
  • func New(debugUsername, debugPassword, satelliteAddress, satelliteToken string, ...) (Server, error)

Types

type Server

type Server interface {
	Start()
	Stop()
}

Server is the interface of a satellite service, which provides the options to start and stop the underlying http server.

func New

func New(debugUsername, debugPassword, satelliteAddress, satelliteToken string, apiConfig api.Config, clustersClient clusters.Client, pluginsClient plugins.Client) (Server, error)

New return a new satellite server. It creates the underlying http server, with the given name, address and token.

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.