attachdetach

Documentation

Overview

Package attachdetach contains consts and helper methods used by various attach/detach components in controller and kubelet

Index

• Constants
• func GetUniqueDeviceName(pluginName, deviceName string) api.UniqueDeviceName
• func GetUniqueDeviceNameFromSpec(attachableVolumePlugin volume.AttachableVolumePlugin, volumeSpec *volume.Spec) (api.UniqueDeviceName, error)

Constants

const (
	// ControllerManagedAnnotation is the key of the annotation on Node objects
	// that indicates attach/detach operations for the node should be managed
	// by the attach/detach controller
	ControllerManagedAnnotation string = "volumes.kubernetes.io/controller-managed-attach-detach"
)

Functions

func GetUniqueDeviceName

func GetUniqueDeviceName(
	pluginName, deviceName string) api.UniqueDeviceName

GetUniqueDeviceName returns a unique name representing the device with the spcified deviceName of the pluginName volume type. The returned name can be used to uniquely reference the device. For example, to prevent operations (attach/detach) from being triggered on the same volume

func GetUniqueDeviceNameFromSpec

func GetUniqueDeviceNameFromSpec(
	attachableVolumePlugin volume.AttachableVolumePlugin,
	volumeSpec *volume.Spec) (api.UniqueDeviceName, error)

GetUniqueDeviceNameFromSpec uses the given AttachableVolumePlugin to generate a unique name representing the device defined in the specified volume spec. This returned name can be used to uniquely reference the device. For example, to prevent operations (attach/detach) from being triggered on the same volume. If the given plugin does not support the volume spec, this returns an error.