admin

Documentation

Overview

Package admin implements administrative endpoints for satellite.

Index

• Variables
• type Config
• type DB
• type Server
  • func NewServer(log *zap.Logger, listener net.Listener, db DB, config Config) *Server
  • func (server *Server) Close() error
  • func (server *Server) Run(ctx context.Context) error

Variables

var Error = errs.Class("admin")

Error is default error class for admin package.

Types

type Config

type Config struct {
	Address string `help:"admin peer http listening address" releaseDefault:"" devDefault:""`

	AuthorizationToken string `internal:"true"`
}

Config defines configuration for debug server.

type DB

type DB interface {
	// ProjectAccounting returns database for storing information about project data use
	ProjectAccounting() accounting.ProjectAccounting
	// Console returns database for satellite console
	Console() console.DB
}

DB is databases needed for the admin server.

type Server

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

Server provides endpoints for debugging.

func NewServer

func NewServer(log *zap.Logger, listener net.Listener, db DB, config Config) *Server

NewServer returns a new debug.Server.

func (*Server) Close

func (server *Server) Close() error

Close closes server and underlying listener.

func (*Server) Run

func (server *Server) Run(ctx context.Context) error

Run starts the debug endpoint.