StorageProvisionerAPIv4 provides the StorageProvisioner API v4 facade.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "StorageProvisioner"
VERSION: number = 4
_transport: Transport
NAME: string = "StorageProvisioner"
VERSION: number = 4

Methods

  • AttachmentLife returns the lifecycle state of each specified machine storage attachment.

    Parameters

    Returns Promise<LifeResults>

  • EnsureDead calls EnsureDead on each given entity from state. It will fail if the entity is not present. If it's Alive, nothing will happen (see state/EnsureDead() for units or machines).

    Parameters

    Returns Promise<ErrorResults>

  • Filesystems returns details of filesystems with the specified tags.

    Parameters

    Returns Promise<FilesystemResults>

  • InstanceId returns the provider specific instance id for each given machine or an CodeNotProvisioned error, if not set.

    Parameters

    Returns Promise<StringResults>

  • Life returns the life status of every supplied entity, where available.

    Parameters

    Returns Promise<LifeResults>

  • Remove removes volumes and filesystems from state.

    Parameters

    Returns Promise<ErrorResults>

  • SetFilesystemInfo records the details of newly provisioned filesystems.

    Parameters

    Returns Promise<ErrorResults>

  • SetStatus sets the status of each given entity.

    Parameters

    Returns Promise<ErrorResults>

  • SetVolumeAttachmentInfo records the details of newly provisioned volume attachments.

    Parameters

    Returns Promise<ErrorResults>

  • SetVolumeInfo records the details of newly provisioned volumes.

    Parameters

    Returns Promise<ErrorResults>

  • VolumeParams returns the parameters for creating or destroying the volumes with the specified tags.

    Parameters

    Returns Promise<VolumeParamsResults>

  • Volumes returns details of volumes with the specified tags.

    Parameters

    Returns Promise<VolumeResults>

  • WatchApplications starts a StringsWatcher to watch CAAS applications deployed to this model.

    Parameters

    • params: any

    Returns Promise<StringsWatchResult>

  • WatchBlockDevices watches for changes to the specified machines' block devices.

    Parameters

    Returns Promise<NotifyWatchResults>

  • WatchFilesystems watches for changes to filesystems scoped to the entity with the tag passed to NewState.

    Parameters

    Returns Promise<StringsWatchResults>

  • WatchVolumeAttachmentPlans watches for changes to volume attachments for a machine for the purpose of allowing that machine to run any initialization needed, for that volume to actually appear as a block device (ie: iSCSI)

    Parameters

    Returns Promise<MachineStorageIdsWatchResults>

  • WatchVolumes watches for changes to volumes scoped to the entity with the tag passed to NewState.

    Parameters

    Returns Promise<StringsWatchResults>

Generated using TypeDoc