api

Documentation

Index

• Variables
• type AllWatcher
  • func (watcher *AllWatcher) Next() ([]params.Delta, error)
  • func (watcher *AllWatcher) Stop() error
• type CharmInfo
• type Client
  • func (c *Client) AddRelation(endpoints ...string) (*params.AddRelationResults, error)
  • func (c *Client) AddServiceUnits(service string, numUnits int) ([]string, error)
  • func (c *Client) CharmInfo(charmURL string) (*CharmInfo, error)
  • func (c *Client) DestroyRelation(endpoints ...string) error
  • func (c *Client) DestroyServiceUnits(unitNames []string) error
  • func (c *Client) EnvironmentInfo() (*EnvironmentInfo, error)
  • func (c *Client) GetAnnotations(tag string) (map[string]string, error)
  • func (c *Client) GetServiceConstraints(service string) (constraints.Value, error)
  • func (c *Client) Resolved(unit string, retry bool) error
  • func (c *Client) ServiceDeploy(charmUrl string, serviceName string, numUnits int, configYAML string, ...) error
  • func (c *Client) ServiceDestroy(service string) error
  • func (c *Client) ServiceExpose(service string) error
  • func (c *Client) ServiceGet(service string) (*params.ServiceGetResults, error)
  • func (c *Client) ServiceSet(service string, options map[string]string) error
  • func (c *Client) ServiceSetCharm(serviceName string, charmUrl string, force bool) error
  • func (c *Client) ServiceSetYAML(service string, yaml string) error
  • func (c *Client) ServiceUnexpose(service string) error
  • func (c *Client) SetAnnotations(tag string, pairs map[string]string) error
  • func (c *Client) SetServiceConstraints(service string, constraints constraints.Value) error
  • func (c *Client) Status() (*Status, error)
  • func (c *Client) WatchAll() (*AllWatcher, error)
• type DialOpts
  • func DefaultDialOpts() DialOpts
• type EnvironmentInfo
• type Info
• type MachineInfo
• type NotifyWatcher
• type State
  • func Open(info *Info, opts DialOpts) (*State, error)
  • func (s *State) Broken() <-chan struct{}
  • func (s *State) Call(objType, id, request string, args, response interface{}) error
  • func (st *State) Client() *Client
  • func (s *State) Close() error
  • func (st *State) Login(tag, password string) error
  • func (st *State) MachineAgent() *machineagent.State
  • func (st *State) Machiner() *machiner.State
  • func (s *State) RPCClient() *rpc.Conn
  • func (st *State) Upgrader() (*upgrader.Upgrader, error)
• type Status
• type StringsWatcher
• type WatchAll

Variables

var PingPeriod = 1 * time.Minute

PingPeriod defines how often the internal connection health check will run. It's a variable so it can be changed in tests.

Types

type AllWatcher

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

AllWatcher holds information allowing us to get Deltas describing changes to the entire environment.

func (*AllWatcher) Next

func (watcher *AllWatcher) Next() ([]params.Delta, error)

func (*AllWatcher) Stop

func (watcher *AllWatcher) Stop() error

type CharmInfo

type CharmInfo struct {
	Revision int
	URL      string
	Config   *charm.Config
	Meta     *charm.Meta
}

CharmInfo holds information about a charm.

type Client

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

Client represents the client-accessible part of the state.

func (*Client) AddRelation

func (c *Client) AddRelation(endpoints ...string) (*params.AddRelationResults, error)

AddRelation adds a relation between the specified endpoints and returns the relation info.

func (*Client) AddServiceUnits

func (c *Client) AddServiceUnits(service string, numUnits int) ([]string, error)

AddServiceUnits adds a given number of units to a service.

func (*Client) CharmInfo

func (c *Client) CharmInfo(charmURL string) (*CharmInfo, error)

CharmInfo returns information about the requested charm.

func (*Client) DestroyRelation

func (c *Client) DestroyRelation(endpoints ...string) error

DestroyRelation removes the relation between the specified endpoints.

func (*Client) DestroyServiceUnits

func (c *Client) DestroyServiceUnits(unitNames []string) error

DestroyServiceUnits decreases the number of units dedicated to a service.

func (*Client) EnvironmentInfo

func (c *Client) EnvironmentInfo() (*EnvironmentInfo, error)

EnvironmentInfo returns details about the Juju environment.

func (*Client) GetAnnotations

func (c *Client) GetAnnotations(tag string) (map[string]string, error)

GetAnnotations returns annotations that have been set on the given entity.

func (*Client) GetServiceConstraints

func (c *Client) GetServiceConstraints(service string) (constraints.Value, error)

GetServiceConstraints returns the constraints for the given service.

func (*Client) Resolved

func (c *Client) Resolved(unit string, retry bool) error

Resolved clears errors on a unit.

func (*Client) ServiceDeploy

func (c *Client) ServiceDeploy(charmUrl string, serviceName string, numUnits int, configYAML string, cons constraints.Value) error

ServiceDeploy obtains the charm, either locally or from the charm store, and deploys it.

func (*Client) ServiceDestroy

func (c *Client) ServiceDestroy(service string) error

ServiceDestroy destroys a given service.

func (*Client) ServiceExpose

func (c *Client) ServiceExpose(service string) error

ServiceExpose changes the juju-managed firewall to expose any ports that were also explicitly marked by units as open.

func (*Client) ServiceGet

func (c *Client) ServiceGet(service string) (*params.ServiceGetResults, error)

ServiceGet returns the configuration for the named service.

func (*Client) ServiceSet

func (c *Client) ServiceSet(service string, options map[string]string) error

ServiceSet sets configuration options on a service.

func (*Client) ServiceSetCharm

func (c *Client) ServiceSetCharm(serviceName string, charmUrl string, force bool) error

ServiceSetCharm sets the charm for a given service.

func (*Client) ServiceSetYAML

func (c *Client) ServiceSetYAML(service string, yaml string) error

ServiceSetYAML sets configuration options on a service given options in YAML format.

func (*Client) ServiceUnexpose

func (c *Client) ServiceUnexpose(service string) error

ServiceUnexpose changes the juju-managed firewall to unexpose any ports that were also explicitly marked by units as open.

func (*Client) SetAnnotations

func (c *Client) SetAnnotations(tag string, pairs map[string]string) error

SetAnnotations sets the annotation pairs on the given entity. Currently annotations are supported on machines, services, units and the environment itself.

func (*Client) SetServiceConstraints

func (c *Client) SetServiceConstraints(service string, constraints constraints.Value) error

SetServiceConstraints specifies the constraints for the given service.

func (*Client) Status

func (c *Client) Status() (*Status, error)

Status returns the status of the juju environment.

func (*Client) WatchAll

func (c *Client) WatchAll() (*AllWatcher, error)

WatchAll returns an AllWatcher, from which you can request the Next collection of Deltas.

type DialOpts

type DialOpts struct {
	// Timeout is the amount of time to wait contacting
	// a state server.
	Timeout time.Duration

	// RetryDelay is the amount of time to wait between
	// unsucssful connection attempts.
	RetryDelay time.Duration
}

DialOpts holds configuration parameters that control the Dialing behavior when connecting to a state server.

func DefaultDialOpts

func DefaultDialOpts() DialOpts

DefaultDialOpts returns a DialOpts representing the default parameters for contacting a state server.

type EnvironmentInfo

type EnvironmentInfo struct {
	DefaultSeries string
	ProviderType  string
	Name          string
	UUID          string
}

EnvironmentInfo holds information about the Juju environment.

type Info

type Info struct {
	// Addrs holds the addresses of the state servers.
	Addrs []string

	// CACert holds the CA certificate that will be used
	// to validate the state server's certificate, in PEM format.
	CACert []byte

	// Tag holds the name of the entity that is connecting.
	// If this and the password are empty, no login attempt will be made
	// (this is to allow tests to access the API to check that operations
	// fail when not logged in).
	Tag string

	// Password holds the password for the administrator or connecting entity.
	Password string
}

Info encapsulates information about a server holding juju state and can be used to make a connection to it.

type MachineInfo

type MachineInfo struct {
	InstanceId string // blank if not set.
}

MachineInfo holds information about a machine.

type NotifyWatcher

type NotifyWatcher interface {
	Changes() <-chan struct{}
	Stop() error
	Err() error
}

NotifyWatcher will send events when something changes. It does not send content for those changes.

type State

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

func Open

func Open(info *Info, opts DialOpts) (*State, error)

func (*State) Broken

func (s *State) Broken() <-chan struct{}

Broken returns a channel that's closed when the connection is broken.

func (*State) Call

func (s *State) Call(objType, id, request string, args, response interface{}) error

Call invokes a low-level RPC method of the given objType, id, and request, passing the given parameters and filling in the response results. This should not be used directly by clients. TODO (dimitern) Add tests for all client-facing objects to verify we return the correct error when invoking Call("Object", "non-empty-id",...)

func (*State) Client

func (st *State) Client() *Client

Client returns an object that can be used to access client-specific functionality.

func (*State) Close

func (s *State) Close() error

func (*State) Login

func (st *State) Login(tag, password string) error

Login authenticates as the entity with the given name and password. Subsequent requests on the state will act as that entity. This method is usually called automatically by Open.

func (*State) MachineAgent

func (st *State) MachineAgent() *machineagent.State

MachineAgent returns a version of the state that provides functionality required by the machine agent code.

func (*State) Machiner

func (st *State) Machiner() *machiner.State

Machiner returns a version of the state that provides functionality required by the machiner worker.

func (*State) RPCClient

func (s *State) RPCClient() *rpc.Conn

RPCClient returns the RPC client for the state, so that testing functions can tickle parts of the API that the conventional entry points don't reach. This is exported for testing purposes only.

func (*State) Upgrader

func (st *State) Upgrader() (*upgrader.Upgrader, error)

Upgrader returns access to the Upgrader API

type Status

type Status struct {
	Machines map[string]MachineInfo
}

Status holds information about the status of a juju environment.

type StringsWatcher

type StringsWatcher interface {
	Changes() <-chan []string
	Stop() error
	Err() error
}

StringsWatcher will send events when something changes. The content for the changes is a list of strings.

type WatchAll

type WatchAll struct {
	AllWatcherId string
}

WatchAll holds the id of the newly-created AllWatcher.