juju: github.com/juju/juju/worker/caasbroker Index | Files

package caasbroker

import "github.com/juju/juju/worker/caasbroker"

Index

Package Files

broker.go manifold.go

func Manifold Uses

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a Manifold that encapsulates a *Tracker and exposes it as an caas,Broker resource.

type Config Uses

type Config struct {
    ConfigAPI              ConfigAPI
    NewContainerBrokerFunc caas.NewContainerBrokerFunc
}

Config describes the dependencies of a Tracker.

It's arguable that it should be called TrackerConfig, because of the heavy use of model config in this package.

func (Config) Validate Uses

func (config Config) Validate() error

Validate returns an error if the config cannot be used to start a Tracker.

type ConfigAPI Uses

type ConfigAPI interface {
    CloudSpec() (environs.CloudSpec, error)
    ModelConfig() (*config.Config, error)
    ControllerConfig() (controller.Config, error)
    WatchForModelConfigChanges() (watcher.NotifyWatcher, error)
    WatchCloudSpecChanges() (watcher.NotifyWatcher, error)
}

ConfigAPI exposes a model configuration and a watch constructor that allows clients to be informed of changes to the configuration.

type ManifoldConfig Uses

type ManifoldConfig struct {
    APICallerName          string
    NewContainerBrokerFunc caas.NewContainerBrokerFunc
}

ManifoldConfig describes the resources used by a Tracker.

type Tracker Uses

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

Tracker loads a caas broker, makes it available to clients, and updates the broker in response to config changes until it is killed.

func NewTracker Uses

func NewTracker(config Config) (*Tracker, error)

NewTracker returns a new Tracker, or an error if anything goes wrong. If a tracker is returned, its Broker() method is immediately usable.

The caller is responsible for Kill()ing the returned Tracker and Wait()ing for any errors it might return.

func (*Tracker) Broker Uses

func (t *Tracker) Broker() caas.Broker

Broker returns the encapsulated Broker. It will continue to be updated in the background for as long as the Tracker continues to run.

func (*Tracker) Kill Uses

func (t *Tracker) Kill()

Kill is part of the worker.Worker interface.

func (*Tracker) Wait Uses

func (t *Tracker) Wait() error

Wait is part of the worker.Worker interface.

Package caasbroker imports 14 packages (graph) and is imported by 3 packages. Updated 2019-09-25. Refresh now. Tools for package owners.