migrationminion

Documentation

Index

• func Manifold(config ManifoldConfig) dependency.Manifold
• func New(config Config) (worker.Worker, error)
• func NewWorker(config Config) (worker.Worker, error)
• type Config
  • func (config Config) Validate() error
• type Facade
  • func NewFacade(apiCaller base.APICaller) (Facade, error)
• type ManifoldConfig
• type Worker
  • func (w *Worker) Kill()
  • func (w *Worker) Wait() error

Functions

func Manifold

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a dependency manifold that runs the migration worker.

func New

func New(config Config) (worker.Worker, error)

New returns a Worker backed by config, or an error.

func NewWorker

func NewWorker(config Config) (worker.Worker, error)

Types

type Config

type Config struct {
	Agent  agent.Agent
	Facade Facade
	Guard  fortress.Guard
}

Config defines the operation of a Worker.

func (Config) Validate

func (config Config) Validate() error

Validate returns an error if config cannot drive a Worker.

type Facade

type Facade interface {

	// Watch returns a watcher which reports when the status changes
	// for the migration for the model associated with the API
	// connection.
	Watch() (watcher.MigrationStatusWatcher, error)
}

Facade exposes controller functionality to a Worker.

func NewFacade

func NewFacade(apiCaller base.APICaller) (Facade, error)

type ManifoldConfig

type ManifoldConfig struct {
	AgentName     string
	APICallerName string
	FortressName  string

	NewFacade func(base.APICaller) (Facade, error)
	NewWorker func(Config) (worker.Worker, error)
}

ManifoldConfig defines the names of the manifolds on which a Worker manifold will depend.

type Worker

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

Worker waits for a model migration to be active, then locks down the configured fortress and implements the migration.

func (*Worker) Kill

func (w *Worker) Kill()

Kill implements worker.Worker.

func (*Worker) Wait

func (w *Worker) Wait() error

Wait implements worker.Worker.