Documentation
¶
Index ¶
- Variables
- func IsNoAddressSetError(err error) bool
- func IsUnknownEnviromentError(err error) bool
- func NoAddressSetError(unitTag, addressName string) error
- func NotSupportedError(entity, operation string) error
- func ServerError(err error) *params.Error
- func UnknownEnvironmentError(uuid string) error
- type APIAddresser
- type AddressAndCertGetter
- type AgentEntityWatcher
- type AuthFunc
- type Authorizer
- type DeadEnsurer
- type EntityFinderEnvironConfigGetter
- type EnvironMachinesWatcher
- type EnvironWatcher
- type GetAuthFunc
- type InstanceIdGetter
- type LifeGetter
- type PasswordChanger
- type Remover
- type Resource
- type Resources
- type StateAddresser
- type StatusSetter
- type StringResource
- type ToolsGetter
- type ToolsSetter
- type UnitsWatcher
Constants ¶
This section is empty.
Variables ¶
var ( ErrBadId = stderrors.New("id not found") ErrBadCreds = stderrors.New("invalid entity name or password") ErrPerm = stderrors.New("permission denied") ErrNotLoggedIn = stderrors.New("not logged in") ErrUnknownWatcher = stderrors.New("unknown watcher id") ErrUnknownPinger = stderrors.New("unknown pinger id") ErrStoppedWatcher = stderrors.New("watcher has been stopped") ErrBadRequest = stderrors.New("invalid request") ErrTryAgain = stderrors.New("try again") )
Functions ¶
func IsNoAddressSetError ¶
func NoAddressSetError ¶
func NotSupportedError ¶
func ServerError ¶
ServerError returns an error suitable for returning to an API client, with an error code suitable for various kinds of errors generated in packages outside the API.
func UnknownEnvironmentError ¶
Types ¶
type APIAddresser ¶
type APIAddresser struct {
// contains filtered or unexported fields
}
APIAddresser implements the APIAddresses method
func NewAPIAddresser ¶
func NewAPIAddresser(getter AddressAndCertGetter, resources *Resources) *APIAddresser
NewAPIAddresser returns a new APIAddresser that uses the given getter to fetch its addresses.
func (*APIAddresser) APIAddresses ¶
func (api *APIAddresser) APIAddresses() (params.StringsResult, error)
APIAddresses returns the list of addresses used to connect to the API.
func (*APIAddresser) APIHostPorts ¶
func (api *APIAddresser) APIHostPorts() (params.APIHostPortsResult, error)
APIHostPorts returns the API server addresses.
func (*APIAddresser) CACert ¶
func (a *APIAddresser) CACert() params.BytesResult
CACert returns the certificate used to validate the state connection.
func (*APIAddresser) WatchAPIHostPorts ¶
func (api *APIAddresser) WatchAPIHostPorts() (params.NotifyWatchResult, error)
WatchAPIHostPorts watches the API server addresses.
type AddressAndCertGetter ¶
type AddressAndCertGetter interface {
Addresses() ([]string, error)
APIAddressesFromMachines() ([]string, error)
CACert() string
APIHostPorts() ([][]network.HostPort, error)
WatchAPIHostPorts() state.NotifyWatcher
}
AddressAndCertGetter can be used to find out state server addresses and the CA public certificate.
type AgentEntityWatcher ¶
type AgentEntityWatcher struct {
// contains filtered or unexported fields
}
AgentEntityWatcher implements a common Watch method for use by various facades.
func NewAgentEntityWatcher ¶
func NewAgentEntityWatcher(st state.EntityFinder, resources *Resources, getCanWatch GetAuthFunc) *AgentEntityWatcher
NewAgentEntityWatcher returns a new AgentEntityWatcher. The GetAuthFunc will be used on each invocation of Watch to determine current permissions.
func (*AgentEntityWatcher) Watch ¶
func (a *AgentEntityWatcher) Watch(args params.Entities) (params.NotifyWatchResults, error)
Watch starts an NotifyWatcher for each given entity.
type Authorizer ¶
type Authorizer interface {
// AuthMachineAgent returns whether the authenticated entity is a
// machine agent.
AuthMachineAgent() bool
// AuthUnitAgent returns whether the authenticated entity is a
// unit agent.
AuthUnitAgent() bool
// AuthOwner returns whether the authenticated entity is the same
// as the given entity.
AuthOwner(tag string) bool
// AuthEnvironManager returns whether the authenticated entity is
// a machine running the environment manager job.
AuthEnvironManager() bool
// AuthClient returns whether the authenticated entity
// is a client user.
AuthClient() bool
// GetAuthTag returns the tag of the authenticated entity.
GetAuthTag() string
// GetAuthEntity returns the authenticated entity.
GetAuthEntity() state.Entity
}
Authorizer represents a value that can be asked for authorization information on its associated authenticated entity. It is implemented by an API server to allow an API implementation to ask questions about the client that is currently connected.
type DeadEnsurer ¶
type DeadEnsurer struct {
// contains filtered or unexported fields
}
DeadEnsurer implements a common EnsureDead method for use by various facades.
func NewDeadEnsurer ¶
func NewDeadEnsurer(st state.EntityFinder, getCanModify GetAuthFunc) *DeadEnsurer
NewDeadEnsurer returns a new DeadEnsurer. The GetAuthFunc will be used on each invocation of EnsureDead to determine current permissions.
func (*DeadEnsurer) EnsureDead ¶
func (d *DeadEnsurer) EnsureDead(args params.Entities) (params.ErrorResults, error)
EnsureDead calls EnsureDead on each given entity from state. It will fail if the entity is not present. If it's Alive, nothing will happen (see state/EnsureDead() for units or machines).
type EntityFinderEnvironConfigGetter ¶
type EntityFinderEnvironConfigGetter interface {
state.EntityFinder
EnvironConfig() (*config.Config, error)
}
type EnvironMachinesWatcher ¶
type EnvironMachinesWatcher struct {
// contains filtered or unexported fields
}
EnvironMachinesWatcher implements a common WatchEnvironMachines method for use by various facades.
func NewEnvironMachinesWatcher ¶
func NewEnvironMachinesWatcher(st state.EnvironMachinesWatcher, resources *Resources, getCanWatch GetAuthFunc) *EnvironMachinesWatcher
NewEnvironMachinesWatcher returns a new EnvironMachinesWatcher. The GetAuthFunc will be used on each invocation of WatchUnits to determine current permissions.
func (*EnvironMachinesWatcher) WatchEnvironMachines ¶
func (e *EnvironMachinesWatcher) WatchEnvironMachines() (params.StringsWatchResult, error)
WatchEnvironMachines returns a StringsWatcher that notifies of changes to the life cycles of the top level machines in the current environment.
type EnvironWatcher ¶
type EnvironWatcher struct {
// contains filtered or unexported fields
}
EnvironWatcher implements two common methods for use by various facades - WatchForEnvironConfigChanges and EnvironConfig.
func NewEnvironWatcher ¶
func NewEnvironWatcher(st state.EnvironAccessor, resources *Resources, getCanWatch, getCanReadSecrets GetAuthFunc) *EnvironWatcher
NewEnvironWatcher returns a new EnvironWatcher. Active watchers will be stored in the provided Resources. The two GetAuthFunc callbacks will be used on each invocation of the methods to determine current permissions. Right now, environment tags are not used, so both created AuthFuncs are called with "" for tag, which means "the current environment".
func (*EnvironWatcher) EnvironConfig ¶
func (e *EnvironWatcher) EnvironConfig() (params.EnvironConfigResult, error)
EnvironConfig returns the current environment's configuration.
func (*EnvironWatcher) WatchForEnvironConfigChanges ¶
func (e *EnvironWatcher) WatchForEnvironConfigChanges() (params.NotifyWatchResult, error)
WatchForEnvironConfigChanges returns a NotifyWatcher that observes changes to the environment configuration. Note that although the NotifyWatchResult contains an Error field, it's not used because we are only returning a single watcher, so we use the regular error return.
type GetAuthFunc ¶
GetAuthFunc returns an AuthFunc.
func AuthAlways ¶
func AuthAlways(ok bool) GetAuthFunc
AuthAlways returns an authentication function that always returns the given permission.
func AuthEither ¶
func AuthEither(a, b GetAuthFunc) GetAuthFunc
AuthEither returns an AuthFunc generator that returns an AuthFunc that accepts any tag authorized by either of its arguments.
type InstanceIdGetter ¶
type InstanceIdGetter struct {
// contains filtered or unexported fields
}
InstanceIdGetter implements a common InstanceId method for use by various facades.
func NewInstanceIdGetter ¶
func NewInstanceIdGetter(st state.EntityFinder, getCanRead GetAuthFunc) *InstanceIdGetter
NewInstanceIdGetter returns a new InstanceIdGetter. The GetAuthFunc will be used on each invocation of InstanceId to determine current permissions.
func (*InstanceIdGetter) InstanceId ¶
func (ig *InstanceIdGetter) InstanceId(args params.Entities) (params.StringResults, error)
InstanceId returns the provider specific instance id for each given machine or an CodeNotProvisioned error, if not set.
type LifeGetter ¶
type LifeGetter struct {
// contains filtered or unexported fields
}
LifeGetter implements a common Life method for use by various facades.
func NewLifeGetter ¶
func NewLifeGetter(st state.EntityFinder, getCanRead GetAuthFunc) *LifeGetter
NewLifeGetter returns a new LifeGetter. The GetAuthFunc will be used on each invocation of Life to determine current permissions.
func (*LifeGetter) Life ¶
func (lg *LifeGetter) Life(args params.Entities) (params.LifeResults, error)
Life returns the life status of every supplied entity, where available.
type PasswordChanger ¶
type PasswordChanger struct {
// contains filtered or unexported fields
}
PasswordChanger implements a common SetPasswords method for use by various facades.
func NewPasswordChanger ¶
func NewPasswordChanger(st state.EntityFinder, getCanChange GetAuthFunc) *PasswordChanger
NewPasswordChanger returns a new PasswordChanger. The GetAuthFunc will be used on each invocation of SetPasswords to determine current permissions.
func (*PasswordChanger) SetPasswords ¶
func (pc *PasswordChanger) SetPasswords(args params.EntityPasswords) (params.ErrorResults, error)
SetPasswords sets the given password for each supplied entity, if possible.
type Remover ¶
type Remover struct {
// contains filtered or unexported fields
}
Remover implements a common Remove method for use by various facades.
func NewRemover ¶
func NewRemover(st state.EntityFinder, callEnsureDead bool, getCanModify GetAuthFunc) *Remover
NewRemover returns a new Remover. The callEnsureDead flag specifies whether EnsureDead should be called on an entity before removing. The GetAuthFunc will be used on each invocation of Remove to determine current permissions.
type Resource ¶
type Resource interface {
Stop() error
}
Resource represents any resource that should be cleaned up when an API connection terminates. The Stop method will be called when that happens.
type Resources ¶
type Resources struct {
// contains filtered or unexported fields
}
Resources holds all the resources for a connection. It allows the registration of resources that will be cleaned up when a connection terminates.
func NewResources ¶
func NewResources() *Resources
func (*Resources) Get ¶
Get returns the resource for the given id, or nil if there is no such resource.
func (*Resources) Register ¶
Register registers the given resource. It returns a unique identifier for the resource which can then be used in subsequent API requests to refer to the resource.
func (*Resources) RegisterNamed ¶
RegisterNamed registers the given resource. Callers must supply a unique name for the given resource. It is an error to try to register another resource with the same name as an already registered name. (This could be softened that you can overwrite an existing one and it will be Stopped and replaced, but we don't have a need for that yet.) It is also an error to supply a name that is an integer string, since that collides with the auto-naming from Register.
type StateAddresser ¶
type StateAddresser struct {
// contains filtered or unexported fields
}
StateAddresser implements a common set of methods for getting state server addresses, and the CA certificate used to authenticate them.
func NewStateAddresser ¶
func NewStateAddresser(getter AddressAndCertGetter) *StateAddresser
NewStateAddresser returns a new StateAddresser that uses the given st value to fetch its addresses.
func (*StateAddresser) StateAddresses ¶
func (a *StateAddresser) StateAddresses() (params.StringsResult, error)
StateAddresses returns the list of addresses used to connect to the state.
type StatusSetter ¶
type StatusSetter struct {
// contains filtered or unexported fields
}
StatusSetter implements a common SetStatus method for use by various facades.
func NewStatusSetter ¶
func NewStatusSetter(st state.EntityFinder, getCanModify GetAuthFunc) *StatusSetter
NewStatusSetter returns a new StatusSetter. The GetAuthFunc will be used on each invocation of SetStatus to determine current permissions.
func (*StatusSetter) SetStatus ¶
func (s *StatusSetter) SetStatus(args params.SetStatus) (params.ErrorResults, error)
SetStatus sets the status of each given entity.
func (*StatusSetter) UpdateStatus ¶
func (s *StatusSetter) UpdateStatus(args params.SetStatus) (params.ErrorResults, error)
UpdateStatus updates the status data of each given entity.
type StringResource ¶
type StringResource string
StringResource is just a regular 'string' that matches the Resource interface.
func (StringResource) Stop ¶
func (StringResource) Stop() error
func (StringResource) String ¶
func (s StringResource) String() string
type ToolsGetter ¶
type ToolsGetter struct {
// contains filtered or unexported fields
}
ToolsGetter implements a common Tools method for use by various facades.
func NewToolsGetter ¶
func NewToolsGetter(st EntityFinderEnvironConfigGetter, getCanRead GetAuthFunc) *ToolsGetter
NewToolsGetter returns a new ToolsGetter. The GetAuthFunc will be used on each invocation of Tools to determine current permissions.
func (*ToolsGetter) Tools ¶
func (t *ToolsGetter) Tools(args params.Entities) (params.ToolsResults, error)
Tools finds the tools necessary for the given agents.
type ToolsSetter ¶
type ToolsSetter struct {
// contains filtered or unexported fields
}
ToolsSetter implements a common Tools method for use by various facades.
func NewToolsSetter ¶
func NewToolsSetter(st state.EntityFinder, getCanWrite GetAuthFunc) *ToolsSetter
NewToolsSetter returns a new ToolsGetter. The GetAuthFunc will be used on each invocation of Tools to determine current permissions.
func (*ToolsSetter) SetTools ¶
func (t *ToolsSetter) SetTools(args params.EntitiesVersion) (params.ErrorResults, error)
SetTools updates the recorded tools version for the agents.
type UnitsWatcher ¶
type UnitsWatcher struct {
// contains filtered or unexported fields
}
UnitsWatcher implements a common WatchUnits method for use by various facades.
func NewUnitsWatcher ¶
func NewUnitsWatcher(st state.EntityFinder, resources *Resources, getCanWatch GetAuthFunc) *UnitsWatcher
NewUnitsWatcher returns a new UnitsWatcher. The GetAuthFunc will be used on each invocation of WatchUnits to determine current permissions.
func (*UnitsWatcher) WatchUnits ¶
func (u *UnitsWatcher) WatchUnits(args params.Entities) (params.StringsWatchResults, error)
WatchUnits starts a StringsWatcher to watch all units belonging to to any entity (machine or service) passed in args.
Source Files
Directories