server

Documentation

Index

• Constants
• Variables
• func WriteToken(token string, fifoFile string) error
• type Healthz
  • func (hz Healthz) JSON() ([]byte, error)
• type Server
  • func New(ctx context.Context, config *lepconfig.Config, endpoint string, cliUID string, ...) (_ *Server, retErr error)
  • func (s *Server) Stop()

Constants

const (
	URLPathSwagger     = "/swagger/*any"
	URLPathSwaggerDesc = "Swagger endpoint for docs"
)

const (
	URLPathHealthz     = "/healthz"
	URLPathHealthzDesc = "Get the health status of the gpud instance"
)

const (
	URLPathConfig     = "/config"
	URLPathConfigDesc = "Get the configuration of the gpud instance"
)

const (
	URLPathPackages     = "/packages"
	URLPathPackagesDesc = "Get the status of gpud managed packages"
)

const (
	RequestHeaderContentType = "Content-Type"
	RequestHeaderJSON        = "application/json"
	RequestHeaderYAML        = "application/yaml"
	RequestHeaderJSONIndent  = "json-indent"

	RequestHeaderAcceptEncoding = "Accept-Encoding"
	RequestHeaderEncodingGzip   = "gzip"
)

const (
	URLPathComponents     = "/components"
	URLPathComponentsDesc = "Get the list of all components"
)

const (
	URLPathStates     = "/states"
	URLPathStatesDesc = "Get the states of all gpud components"
)

const (
	URLPathEvents     = "/events"
	URLPathEventsDesc = "Get the events of all gpud components"
)

const (
	URLPathInfo     = "/info"
	URLPathInfoDesc = "Get the information of all gpud components"
)

const (
	URLPathMetrics     = "/metrics"
	URLPathMetricsDesc = "Get the metrics of all gpud components"
)

const DefaultQuerySince = 30 * time.Minute

Variables

var DefaultHealthz = Healthz{
	Status:  "ok",
	Version: "v1",
}

Functions

func WriteToken

func WriteToken(token string, fifoFile string) error

Types

type Healthz

type Healthz struct {
	Status  string `json:"status"`
	Version string `json:"version"`
}

func (Healthz) JSON

func (hz Healthz) JSON() ([]byte, error)

type Server

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

Server is the gpud main daemon

func New

func New(ctx context.Context, config *lepconfig.Config, endpoint string, cliUID string, packageManager *manager.Manager, opts ...gpud_config.OpOption) (_ *Server, retErr error)

func (*Server) Stop

func (s *Server) Stop()