Documentation
¶
Index ¶
- Variables
- type Client
- func (c *Client) Export(ctx context.Context) (migration.SerializedModel, error)
- func (c *Client) MigrationStatus(ctx context.Context) (migration.MigrationStatus, error)
- func (c *Client) MinionReportTimeout(ctx context.Context) (time.Duration, error)
- func (c *Client) MinionReports(ctx context.Context) (migration.MinionReports, error)
- func (c *Client) ModelInfo(ctx context.Context) (migration.ModelInfo, error)
- func (c *Client) OpenResource(ctx context.Context, application, name string) (io.ReadCloser, error)
- func (c *Client) Prechecks(ctx context.Context) error
- func (c *Client) ProcessRelations(ctx context.Context, controllerAlias string) error
- func (c *Client) Reap(ctx context.Context) error
- func (c *Client) SetPhase(ctx context.Context, phase migration.Phase) error
- func (c *Client) SetStatusMessage(ctx context.Context, message string) error
- func (c *Client) SourceControllerInfo(ctx context.Context) (migration.SourceControllerInfo, []string, error)
- func (c *Client) StreamModelLog(ctx context.Context, start time.Time) (<-chan common.LogMessage, error)
- func (c *Client) Watch(ctx context.Context) (watcher.NotifyWatcher, error)
- func (c *Client) WatchMinionReports(ctx context.Context) (watcher.NotifyWatcher, error)
- type NewWatcherFunc
- type Option
Constants ¶
This section is empty.
Variables ¶
var WithTracer = base.WithTracer
WithTracer returns an Option that configures the Client to use the supplied tracer.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client describes the client side API for the MigrationMaster facade (used by the migrationmaster worker).
func NewClient ¶
func NewClient(caller base.APICaller, newWatcher NewWatcherFunc, options ...Option) *Client
NewClient returns a new Client based on an existing API connection.
func (*Client) Export ¶
Export returns a serialized representation of the model associated with the API connection. The charms used by the model are also returned.
func (*Client) MigrationStatus ¶
MigrationStatus returns the details and progress of the latest model migration.
func (*Client) MinionReportTimeout ¶
MinionReportTimeout returns the maximum duration that the migration master worker should wait for minions to report on a migration phase.
func (*Client) MinionReports ¶
MinionReports returns details of the reports made by migration minions to the controller for the current migration phase.
func (*Client) OpenResource ¶
OpenResource downloads the named resource for an application.
func (*Client) Prechecks ¶
Prechecks verifies that the source controller and model are healthy and able to participate in a migration.
func (*Client) ProcessRelations ¶
ProcessRelations runs a series of processes to ensure that the relations of a given model are correct after a migrated model.
func (*Client) SetStatusMessage ¶
SetStatusMessage sets a human readable message regarding the progress of a migration.
func (*Client) SourceControllerInfo ¶
func (c *Client) SourceControllerInfo(ctx context.Context) (migration.SourceControllerInfo, []string, error)
SourceControllerInfo returns connection information about the source controller and uuids of any other hosted models involved in cross model relations.
func (*Client) StreamModelLog ¶
func (c *Client) StreamModelLog(ctx context.Context, start time.Time) (<-chan common.LogMessage, error)
StreamModelLog takes a starting time and returns a channel that will yield the logs on or after that time - these are the logs that need to be transferred to the target after the migration is successful.
func (*Client) Watch ¶
Watch returns a watcher which reports when a migration is active for the model associated with the API connection.
func (*Client) WatchMinionReports ¶
WatchMinionReports returns a watcher which reports when a migration minion has made a report for the current migration phase.
type NewWatcherFunc ¶
type NewWatcherFunc func(base.APICaller, params.NotifyWatchResult) watcher.NotifyWatcher
NewWatcherFunc exists to let us unit test Facade without patching.
Source Files