apiserver

Documentation

Index

• Variables
• func DescribeFacades() []params.FacadeVersions
• func IsMethodAllowedDuringUpgrade(rootName, methodName string) bool
• func NewPinger(st *state.State, resources *common.Resources, authorizer common.Authorizer) (pinger, error)
• type LoginValidator
• type Server
  • func NewServer(s *state.State, lis net.Listener, cfg ServerConfig) (*Server, error)
  • func (srv *Server) Addr() string
  • func (srv *Server) Dead() <-chan struct{}
  • func (srv *Server) Kill()
  • func (srv *Server) Stop() error
  • func (srv *Server) Wait() error
• type ServerConfig

Variables

var AboutToRestoreError = errors.New("restore preparation in progress")

var MaintenanceNoLoginError = errors.New("login failed - maintenance in progress")

var RestoreInProgressError = errors.New("restore in progress")

var UpgradeInProgressError = errors.New("upgrade in progress")

Functions

func DescribeFacades

func DescribeFacades() []params.FacadeVersions

DescribeFacades returns the list of available Facades and their Versions

func IsMethodAllowedDuringUpgrade

func IsMethodAllowedDuringUpgrade(rootName, methodName string) bool

func NewPinger

func NewPinger(
	st *state.State, resources *common.Resources, authorizer common.Authorizer,
) (
	pinger, error,
)

NewPinger returns an object that can be pinged by calling its Ping method. If this method is not called frequently enough, the connection will be dropped.

Types

type LoginValidator

type LoginValidator func(params.LoginRequest) error

LoginValidator functions are used to decide whether login requests are to be allowed. The validator is called before credentials are checked.

type Server

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

Server holds the server side of the API.

func NewServer

func NewServer(s *state.State, lis net.Listener, cfg ServerConfig) (*Server, error)

NewServer serves the given state by accepting requests on the given listener, using the given certificate and key (in PEM format) for authentication.

func (*Server) Addr

func (srv *Server) Addr() string

Addr returns the address that the server is listening on.

func (*Server) Dead

func (srv *Server) Dead() <-chan struct{}

Dead returns a channel that signals when the server has exited.

func (*Server) Kill

func (srv *Server) Kill()

Kill implements worker.Worker.Kill.

func (*Server) Stop

func (srv *Server) Stop() error

Stop stops the server and returns when all running requests have completed.

func (*Server) Wait

func (srv *Server) Wait() error

Wait implements worker.Worker.Wait.

type ServerConfig

type ServerConfig struct {
	Cert        []byte
	Key         []byte
	Tag         names.Tag
	DataDir     string
	LogDir      string
	Validator   LoginValidator
	CertChanged chan params.StateServingInfo
}

ServerConfig holds parameters required to set up an API server.