attacherdetacher

Documentation

Overview

Package attacherdetacher implements interfaces that enable triggering attach and detach operations on volumes.

Index

• type AttacherDetacher
  • func NewAttacherDetacher(volumePluginMgr *volume.VolumePluginMgr) AttacherDetacher

Types

type AttacherDetacher

type AttacherDetacher interface {
	// Spawns a new goroutine to execute volume-specific logic to attach the
	// volume to the node specified in the volumeToAttach.
	// Once attachment completes successfully, the actualStateOfWorld is updated
	// to indicate the volume is attached to the node.
	// If there is an error indicating the volume is already attached to the
	// specified node, attachment is assumed to be successful (plugins are
	// responsible for implmenting this behavior).
	// All other errors are logged and the goroutine terminates without updating
	// actualStateOfWorld (caller is responsible for retrying as needed).
	AttachVolume(volumeToAttach cache.VolumeToAttach, actualStateOfWorld cache.ActualStateOfWorld) error

	// Spawns a new goroutine to execute volume-specific logic to detach the
	// volume from the node specified in volumeToDetach.
	// Once detachment completes successfully, the actualStateOfWorld is updated
	// to remove the volume/node combo.
	// If there is an error indicating the volume is already detached from the
	// specified node, detachment is assumed to be successful (plugins are
	// responsible for implmenting this behavior).
	// All other errors are logged and the goroutine terminates without updating
	// actualStateOfWorld (caller is responsible for retrying as needed).
	DetachVolume(volumeToDetach cache.AttachedVolume, actualStateOfWorld cache.ActualStateOfWorld) error
}

AttacherDetacher defines a set of operations for attaching or detaching a volume from a node.

func NewAttacherDetacher

func NewAttacherDetacher(volumePluginMgr *volume.VolumePluginMgr) AttacherDetacher

NewAttacherDetacher returns a new instance of AttacherDetacher.