Documentation
¶
Index ¶
- Variables
- func DescribeFacades() []params.FacadeVersions
- func IsMethodAllowedDuringUpgrade(rootName, methodName string) bool
- func NewAllWatcher(st *state.State, resources *common.Resources, auth common.Authorizer, ...) (interface{}, error)
- type EntitiesWatcher
- type LoginValidator
- type Pinger
- type Server
- type ServerConfig
- type SrvAllWatcher
Constants ¶
This section is empty.
Variables ¶
View Source
var AboutToRestoreError = errors.New("restore preparation in progress")
View Source
var MaintenanceNoLoginError = errors.New("login failed - maintenance in progress")
View Source
var RestoreInProgressError = errors.New("restore in progress")
Functions ¶
func DescribeFacades ¶
func DescribeFacades() []params.FacadeVersions
DescribeFacades returns the list of available Facades and their Versions
func NewAllWatcher ¶
func NewAllWatcher(st *state.State, resources *common.Resources, auth common.Authorizer, id string) (interface{}, error)
NewAllWatcher returns a new API server endpoint for interacting with a watcher created by the WatchAll and WatchAllModels API calls.
Types ¶
type EntitiesWatcher ¶
type EntitiesWatcher interface {
state.StringsWatcher
// MapChanges maps the received strings to their according tag strings.
// The EntityFinder interface representing state or a mock has to be
// upcasted into the needed sub-interface of state for the real mapping.
MapChanges(in []string) ([]string, error)
}
EntitiesWatcher defines an interface based on the StringsWatcher but also providing a method for the mapping of the received strings to the tags of the according entities.
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 Pinger ¶
type Pinger interface {
Ping()
Stop() error
}
pinger describes a resource that can be pinged and stopped.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server holds the server side of the API.
func NewServer ¶
NewServer serves the given state by accepting requests on the given listener, using the given certificate and key (in PEM format) for authentication.
The Server will close the listener when it exits, even if returns an error.
func (*Server) Dead ¶
func (srv *Server) Dead() <-chan struct{}
Dead returns a channel that signals when the server has exited.
type ServerConfig ¶
type ServerConfig struct {
Cert []byte
Key []byte
Tag names.Tag
DataDir string
LogDir string
Validator LoginValidator
CertChanged chan params.StateServingInfo
// This field only exists to support testing.
StatePool *state.StatePool
}
ServerConfig holds parameters required to set up an API server.
type SrvAllWatcher ¶
type SrvAllWatcher struct {
// contains filtered or unexported fields
}
SrvAllWatcher defines the API methods on a state.Multiwatcher. which watches any changes to the state. Each client has its own current set of watchers, stored in resources. It is used by both the AllWatcher and AllModelWatcher facades.
func (*SrvAllWatcher) Next ¶
func (aw *SrvAllWatcher) Next() (params.AllWatcherNextResults, error)
func (*SrvAllWatcher) Stop ¶
func (w *SrvAllWatcher) Stop() error
Source Files
¶
- admin.go
- adminv3.go
- allfacades.go
- apiserver.go
- authcontext.go
- backup.go
- charms.go
- client_auth_root.go
- debuglog.go
- debuglog_db.go
- gui.go
- httpcontext.go
- images.go
- logsink.go
- network.go
- pinger.go
- read_only_calls.go
- registration.go
- restoring_root.go
- restricted_root.go
- root.go
- tools.go
- upgrading_root.go
- utils.go
- watcher.go
Directories
¶
| Path | Synopsis |
|---|---|
|
storagecommon
Package storagecommon provides common storage-related services for API server facades.
|
Package storagecommon provides common storage-related services for API server facades. |
|
The controller package defines an API end point for functions dealing with controllers as a whole.
|
The controller package defines an API end point for functions dealing with controllers as a whole. |
|
Package hostkeyreporter implements the API facade used by the hostkeyreporter worker.
|
Package hostkeyreporter implements the API facade used by the hostkeyreporter worker. |
|
Package httpattachment provides facilities for attaching a streaming blob of data and associated metadata to an HTTP API request, and for reading that blob on the server side.
|
Package httpattachment provides facilities for attaching a streaming blob of data and associated metadata to an HTTP API request, and for reading that blob on the server side. |
|
The machiner package implements the API interface used by the machiner worker.
|
The machiner package implements the API interface used by the machiner worker. |
|
machineactions implements the the apiserver side of running actions on machines
|
machineactions implements the the apiserver side of running actions on machines |
|
Package meterstatus provides the meter status API facade.
|
Package meterstatus provides the meter status API facade. |
|
Package metricsdebug contains the implementation of an api endpoint for metrics debug functionality.
|
Package metricsdebug contains the implementation of an api endpoint for metrics debug functionality. |
|
Package metricsender contains functions for sending metrics from a controller to a remote metric collector.
|
Package metricsender contains functions for sending metrics from a controller to a remote metric collector. |
|
Package metricsmanager contains the implementation of an api endpoint for calling metrics functions in state.
|
Package metricsmanager contains the implementation of an api endpoint for calling metrics functions in state. |
|
This package defines the API facade for use by the migration master worker when communicating to it's own controller.
|
This package defines the API facade for use by the migration master worker when communicating to it's own controller. |
|
Package migrationminion defines the API facade for use by the migration minion worker to monitor the progress of, and interact with, model migrations.
|
Package migrationminion defines the API facade for use by the migration minion worker to monitor the progress of, and interact with, model migrations. |
|
This package defines the API facade for use by the migration master worker when interacting with the target controller during a migration.
|
This package defines the API facade for use by the migration master worker when interacting with the target controller during a migration. |
|
Package modelmanager defines an API end point for functions dealing with models.
|
Package modelmanager defines an API end point for functions dealing with models. |
|
The resumer package implements the API interface used by the resumer worker.
|
The resumer package implements the API interface used by the resumer worker. |
|
Package service contains api calls for functionality related to deploying and managing services and their related charms.
|
Package service contains api calls for functionality related to deploying and managing services and their related charms. |
|
Package storage provides an API server facade for managing storage entities.
|
Package storage provides an API server facade for managing storage entities. |
Click to show internal directories.
Click to hide internal directories.