machinemanager

Documentation

Index

• type Client
  • func ConstructClient(clientFacade base.ClientFacade, facadeCaller base.FacadeCaller) *Client
  • func NewClient(st base.APICallCloser) *Client
  • func (client *Client) AddMachines(machineParams []params.AddMachineParams) ([]params.AddMachinesResult, error)
  • func (client *Client) DestroyMachines(machines ...string) ([]params.DestroyMachineResult, error)
  • func (client *Client) DestroyMachinesWithParams(force, keep bool, machines ...string) ([]params.DestroyMachineResult, error)
  • func (client *Client) ForceDestroyMachines(machines ...string) ([]params.DestroyMachineResult, error)
  • func (client *Client) GetUpgradeSeriesMessages(machineName, watcherId string) ([]string, error)
  • func (client *Client) UpgradeSeriesComplete(machineName string) error
  • func (client *Client) UpgradeSeriesPrepare(machineName, series string, force bool) error
  • func (client *Client) UpgradeSeriesValidate(machineName, series string) ([]string, error)
  • func (client *Client) WatchUpgradeSeriesNotifications(machineName string) (watcher.NotifyWatcher, string, error)

Types

type Client

type Client struct {
	base.ClientFacade
	// contains filtered or unexported fields
}

Client provides access to the machinemanager, used to add machines to state.

func ConstructClient

func ConstructClient(clientFacade base.ClientFacade, facadeCaller base.FacadeCaller) *Client

ConstructClient is a constructor function for a machine manager client

func NewClient

func NewClient(st base.APICallCloser) *Client

NewClient returns a new machinemanager client.

func (*Client) AddMachines

func (client *Client) AddMachines(machineParams []params.AddMachineParams) ([]params.AddMachinesResult, error)

AddMachines adds new machines with the supplied parameters, creating any requested disks.

func (*Client) DestroyMachines

func (client *Client) DestroyMachines(machines ...string) ([]params.DestroyMachineResult, error)

DestroyMachines removes a given set of machines.

func (*Client) DestroyMachinesWithParams

func (client *Client) DestroyMachinesWithParams(force, keep bool, machines ...string) ([]params.DestroyMachineResult, error)

DestroyMachinesWithParams removes the given set of machines, the semantics of which is determined by the force and keep parameters. TODO(wallyworld) - for Juju 3.0, this should be the preferred api to use.

func (*Client) ForceDestroyMachines

func (client *Client) ForceDestroyMachines(machines ...string) ([]params.DestroyMachineResult, error)

ForceDestroyMachines removes a given set of machines and all associated units.

func (*Client) GetUpgradeSeriesMessages

func (client *Client) GetUpgradeSeriesMessages(machineName, watcherId string) ([]string, error)

GetUpgradeSeriesMessages returns a StringsWatcher for observing the state of a series upgrade.

func (*Client) UpgradeSeriesComplete

func (client *Client) UpgradeSeriesComplete(machineName string) error

UpgradeSeriesComplete notifies the controller that a given machine has successfully completed the managed series upgrade process.

func (*Client) UpgradeSeriesPrepare

func (client *Client) UpgradeSeriesPrepare(machineName, series string, force bool) error

UpgradeSeriesPrepare notifies the controller that a series upgrade is taking place for a given machine and as such the machine is guarded against operations that would impede, fail, or interfere with the upgrade process.

func (*Client) UpgradeSeriesValidate

func (client *Client) UpgradeSeriesValidate(machineName, series string) ([]string, error)

func (*Client) WatchUpgradeSeriesNotifications

func (client *Client) WatchUpgradeSeriesNotifications(machineName string) (watcher.NotifyWatcher, string, error)

WatchUpgradeSeriesNotifications returns a NotifyWatcher for observing the state of a series upgrade.