API serves methods required by the machine agent upgrade-machine worker.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "UpgradeSeries"
VERSION: number = 3
_transport: Transport
NAME: string = "UpgradeSeries"
VERSION: number = 3

Methods

  • CurrentSeries returns what Juju thinks the current series of the machine is. Note that a machine could have been upgraded out-of-band by running do-release-upgrade outside of the upgrade-machine workflow, making this value incorrect.

    Parameters

    Returns Promise<StringResults>

  • FinishUpgradeSeries is the last action in the upgrade workflow and is called after all machine and unit statuses are "completed". It updates the machine series to reflect the completed upgrade, then removes the upgrade-machine lock.

    Parameters

    Returns Promise<ErrorResults>

  • PinMachineApplications pins leadership for applications represented by units running on the auth'd machine.

    Parameters

    • params: any

    Returns Promise<PinApplicationsResults>

  • PinnedLeadership returns all pinned applications and the entities that require their pinned behaviour, for leadership in the current model.

    Parameters

    • params: any

    Returns Promise<PinnedLeadershipResult>

  • SetInstanceStatus sets the status of the machine.

    Parameters

    Returns Promise<ErrorResults>

  • TargetSeries returns the series that a machine has been locked for upgrading to.

    Parameters

    Returns Promise<StringResults>

  • UnitsCompleted returns the units running on this machine that have completed the upgrade-machine workflow and are in their normal running state.

    Parameters

    Returns Promise<EntitiesResults>

  • UnitsPrepared returns the units running on this machine that have completed their upgrade-machine preparation, and are ready to be stopped and have their unit agent services converted for the target series.

    Parameters

    Returns Promise<EntitiesResults>

  • UnpinMachineApplications unpins leadership for applications represented by units running on the auth'd machine.

    Parameters

    • params: any

    Returns Promise<PinApplicationsResults>

  • UpgradeSeriesUnitStatus returns the current preparation status of an upgrading unit. If no series upgrade is in progress an error is returned instead.

    Parameters

    Returns Promise<UpgradeSeriesStatusResults>

  • WatchUpgradeSeriesNotifications returns a NotifyWatcher for observing changes to upgrade series locks.

    Parameters

    Returns Promise<NotifyWatchResults>

Generated using TypeDoc