common

Documentation

Index

• Variables
• func Life(caller base.FacadeCaller, tag names.Tag) (params.Life, error)
• func Watch(facade base.FacadeCaller, tag names.Tag) (watcher.NotifyWatcher, error)
• type APIAddresser
  • func NewAPIAddresser(facade base.FacadeCaller) *APIAddresser
  • func (a *APIAddresser) APIAddresses() ([]string, error)
  • func (a *APIAddresser) APIHostPorts() ([][]network.HostPort, error)
  • func (a *APIAddresser) CACert() (string, error)
  • func (a *APIAddresser) ModelUUID() (string, error)
  • func (a *APIAddresser) WatchAPIHostPorts() (watcher.NotifyWatcher, error)
• type ControllerConfigAPI
  • func NewControllerConfig(facade base.FacadeCaller) *ControllerConfigAPI
  • func (e *ControllerConfigAPI) ControllerConfig() (controller.Config, error)
• type ModelWatcher
  • func NewModelWatcher(facade base.FacadeCaller) *ModelWatcher
  • func (e *ModelWatcher) LogForwardConfig() (*syslog.RawConfig, bool, error)
  • func (e *ModelWatcher) ModelConfig() (*config.Config, error)
  • func (e *ModelWatcher) WatchForLogForwardConfigChanges() (watcher.NotifyWatcher, error)
  • func (e *ModelWatcher) WatchForModelConfigChanges() (watcher.NotifyWatcher, error)

Variables

var (
	ErrPartialResults = errors.New("API call only returned partial results")
)

Functions

func Life

func Life(caller base.FacadeCaller, tag names.Tag) (params.Life, error)

Life requests the life cycle of the given entity from the given server-side API facade via the given caller.

func Watch

func Watch(facade base.FacadeCaller, tag names.Tag) (watcher.NotifyWatcher, error)

Watch starts a NotifyWatcher for the entity with the specified tag.

Types

type APIAddresser

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

APIAddresser provides common client-side API functions to call into apiserver.common.APIAddresser

func NewAPIAddresser

func NewAPIAddresser(facade base.FacadeCaller) *APIAddresser

NewAPIAddresser returns a new APIAddresser that makes API calls using caller and the specified facade name.

func (*APIAddresser) APIAddresses

func (a *APIAddresser) APIAddresses() ([]string, error)

APIAddresses returns the list of addresses used to connect to the API.

func (*APIAddresser) APIHostPorts

func (a *APIAddresser) APIHostPorts() ([][]network.HostPort, error)

APIHostPorts returns the host/port addresses of the API servers.

func (*APIAddresser) CACert

func (a *APIAddresser) CACert() (string, error)

CACert returns the certificate used to validate the API and state connections.

func (*APIAddresser) ModelUUID

func (a *APIAddresser) ModelUUID() (string, error)

ModelUUID returns the model UUID to connect to the model that the current connection is for.

func (*APIAddresser) WatchAPIHostPorts

func (a *APIAddresser) WatchAPIHostPorts() (watcher.NotifyWatcher, error)

WatchAPIHostPorts watches the host/port addresses of the API servers.

type ControllerConfigAPI

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

ControllerConfigAPI provides common client-side API functions to call into apiserver.common.ControllerConfig.

func NewControllerConfig

func NewControllerConfig(facade base.FacadeCaller) *ControllerConfigAPI

NewControllerConfig creates a ControllerConfig on the specified facade, and uses this name when calling through the caller.

func (*ControllerConfigAPI) ControllerConfig

func (e *ControllerConfigAPI) ControllerConfig() (controller.Config, error)

ControllerConfig returns the current controller configuration.

type ModelWatcher

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

ModelWatcher provides common client-side API functions to call into apiserver.common.ModelWatcher.

func NewModelWatcher

func NewModelWatcher(facade base.FacadeCaller) *ModelWatcher

NewModelWatcher creates a ModelWatcher on the specified facade, and uses this name when calling through the caller.

func (*ModelWatcher) LogForwardConfig

func (e *ModelWatcher) LogForwardConfig() (*syslog.RawConfig, bool, error)

LogForwardConfig returns the current log forward syslog configuration.

func (*ModelWatcher) ModelConfig

func (e *ModelWatcher) ModelConfig() (*config.Config, error)

ModelConfig returns the current model configuration.

func (*ModelWatcher) WatchForLogForwardConfigChanges

func (e *ModelWatcher) WatchForLogForwardConfigChanges() (watcher.NotifyWatcher, error)

WatchForLogForwardConfigChanges return a NotifyWatcher waiting for the log forward syslog configuration to change.

func (*ModelWatcher) WatchForModelConfigChanges

func (e *ModelWatcher) WatchForModelConfigChanges() (watcher.NotifyWatcher, error)

WatchForModelConfigChanges return a NotifyWatcher waiting for the model configuration to change.