storage

Documentation

Index

• Constants
• func DoVolumeActivate(volume model.Volume, storagePool model.StoragePool, ...) error
• func DoVolumeRemove(volume model.Volume, storagePool model.StoragePool, ...) error
• func IsRancher(volume model.Volume) (bool, error)
• func IsRancherVolume(volume model.Volume) (bool, error)
• func IsVolumeActive(volume model.Volume, storagePool model.StoragePool, ...) (bool, error)
• func IsVolumeRemoved(volume model.Volume, storagePool model.StoragePool, client *engineCli.Client) (bool, error)
• func VolumeActivateDocker(volume model.Volume, storagePool model.StoragePool, ...) error
• func VolumeActivateFlex(volume model.Volume) error
• func VolumeRemoveDocker(volume model.Volume, storagePool model.StoragePool, ...) error
• func VolumeRemoveFlex(volume model.Volume) error
• type Capability
• type Response
  • func CallRancherStorageVolumePlugin(volume model.Volume, action string, payload interface{}) (Response, error)
• type Volume

Constants

const (
	Create       = "Create"
	Remove       = "Remove"
	Attach       = "Attach"
	Mount        = "Mount"
	Path         = "Path"
	Unmount      = "Unmount"
	Get          = "Get"
	List         = "List"
	Capabilities = "Capabilities"
)

Functions

func DoVolumeActivate

func DoVolumeActivate(volume model.Volume, storagePool model.StoragePool, progress *progress.Progress, client *engineCli.Client) error

func DoVolumeRemove

func DoVolumeRemove(volume model.Volume, storagePool model.StoragePool, progress *progress.Progress, dockerClient *engineCli.Client, ca *cache.Cache, resourceID string) error

func IsRancher

func IsRancher(volume model.Volume) (bool, error)

IsRancher checks if volume driver is rancher managed driver

func IsRancherVolume

func IsRancherVolume(volume model.Volume) (bool, error)

IsRancherVolume checks if a volume to be considered as a flex volume if it is in rancherDrivers and the capability is flex raise an error if its rancher-managed driver but the socket file is not available

func IsVolumeActive

func IsVolumeActive(volume model.Volume, storagePool model.StoragePool, dockerClient *engineCli.Client) (bool, error)

func IsVolumeRemoved

func IsVolumeRemoved(volume model.Volume, storagePool model.StoragePool, client *engineCli.Client) (bool, error)

func VolumeActivateDocker

func VolumeActivateDocker(volume model.Volume, storagePool model.StoragePool, progress *progress.Progress, client *engineCli.Client) error

func VolumeActivateFlex

func VolumeActivateFlex(volume model.Volume) error

func VolumeRemoveDocker

func VolumeRemoveDocker(volume model.Volume, storagePool model.StoragePool, progress *progress.Progress, dockerClient *engineCli.Client, ca *cache.Cache, resourceID string) error

func VolumeRemoveFlex

func VolumeRemoveFlex(volume model.Volume) error

Types

type Capability

type Capability struct {
	Scope string
}

Capability represents the list of capabilities a volume driver can return

type Response

type Response struct {
	Mountpoint   string
	Err          string
	Volumes      []*Volume
	Volume       *Volume
	Capabilities Capability
}

Response is the strucutre that the plugin's responses are serialized to.

func CallRancherStorageVolumePlugin

func CallRancherStorageVolumePlugin(volume model.Volume, action string, payload interface{}) (Response, error)

type Volume

type Volume struct {
	Name       string
	Mountpoint string
	Status     map[string]interface{}
}

Volume represents a volume object for use with `Get` and `List` requests