apiserver

package

v0.0.0-...-6337964 Latest Latest Go to latest Published: Jun 13, 2014 License: AGPL-3.0 Imports: 62 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type LoginValidator func(params.Creds) error

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

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

Server holds the server side of the API.

func NewServer(s *state.State, 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 (srv *Server) Addr() string

Addr returns the address that the server is listening on.

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

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

func (srv *Server) Kill()

Kill implements worker.Worker.Kill.

func (srv *Server) Stop() error

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

func (srv *Server) Wait() error

Wait implements worker.Worker.Wait.

type ServerConfig struct {
	Addr      string
	Cert      []byte
	Key       []byte
	DataDir   string
	LogDir    string
	Validator LoginValidator
}

ServerConfig holds parameters required to set up an API server.

Path	Synopsis
agent The machine package implements the API interfaces used by the machine agent.	The machine package implements the API interfaces used by the machine agent.
charmrevisionupdater
testing
client
common
testing
deployer
environment
firewaller
keymanager
testing
keyupdater
logger
machine The machiner package implements the API interface used by the machiner worker.	The machiner package implements the API interface used by the machiner worker.
networker
provisioner
rsyslog
testing
uniter The uniter package implements the API interface used by the uniter worker.	The uniter package implements the API interface used by the uniter worker.
upgrader
usermanager