migrationmaster

Documentation

Overview

This package defines the API facade for use by the migration master worker when communicating to it's own controller.

Index

• type API
  • func NewAPI(st *state.State, resources *common.Resources, authorizer common.Authorizer) (*API, error)
  • func (api *API) Export() (params.SerializedModel, error)
  • func (api *API) GetMigrationStatus() (params.FullMigrationStatus, error)
  • func (api *API) SetPhase(args params.SetMigrationPhaseArgs) error
  • func (api *API) Watch() (params.NotifyWatchResult, error)
• type Backend

Types

type API

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

API implements the API required for the model migration master worker.

func NewAPI

func NewAPI(
	st *state.State,
	resources *common.Resources,
	authorizer common.Authorizer,
) (*API, error)

NewAPI creates a new API server endpoint for the model migration master worker.

func (*API) Export

func (api *API) Export() (params.SerializedModel, error)

Export serializes the model associated with the API connection.

func (*API) GetMigrationStatus

func (api *API) GetMigrationStatus() (params.FullMigrationStatus, error)

GetMigrationStatus returns the details and progress of the latest model migration.

func (*API) SetPhase

func (api *API) SetPhase(args params.SetMigrationPhaseArgs) error

SetPhase sets the phase of the active model migration. The provided phase must be a valid phase value, for example QUIESCE" or "ABORT". See the core/migration package for the complete list.

func (*API) Watch

func (api *API) Watch() (params.NotifyWatchResult, error)

Watch starts watching for an active migration for the model associated with the API connection. The returned id should be used with the NotifyWatcher facade to receive events.

type Backend

type Backend interface {
	migration.StateExporter

	WatchForModelMigration() (state.NotifyWatcher, error)
	GetModelMigration() (state.ModelMigration, error)
}

Backend defines the state functionality required by the migrationmaster facade.