Documentation
¶
Overview ¶
Contains utility code for use by volume plugins.
Index ¶
- Constants
- func AccessModesContainedInAll(indexedModes []v1.PersistentVolumeAccessMode, ...) bool
- func AccessModesContains(modes []v1.PersistentVolumeAccessMode, mode v1.PersistentVolumeAccessMode) bool
- func CalculateTimeoutForVolume(minimumTimeout, timeoutIncrement int, pv *v1.PersistentVolume) int64
- func CheckNodeAffinity(pv *v1.PersistentVolume, nodeLabels map[string]string) error
- func CheckVolumeModeFilesystem(volumeSpec *volume.Spec) (bool, error)
- func ChooseZoneForVolume(zones sets.String, pvcName string) string
- func ChooseZonesForVolume(zones sets.String, pvcName string, numZones uint32) sets.String
- func ClaimToClaimKey(claim *v1.PersistentVolumeClaim) string
- func GenerateVolumeName(clusterName, pvName string, maxLength int) string
- func GetClassForVolume(kubeClient clientset.Interface, pv *v1.PersistentVolume) (*storage.StorageClass, error)
- func GetPath(mounter volume.Mounter) (string, error)
- func GetPersistentVolumeClaimVolumeMode(claim *v1.PersistentVolumeClaim) (v1.PersistentVolumeMode, error)
- func GetSecretForPV(secretNamespace, secretName, volumePluginName string, ...) (map[string]string, error)
- func GetSecretForPod(pod *v1.Pod, secretName string, kubeClient clientset.Interface) (map[string]string, error)
- func GetUniquePodName(pod *v1.Pod) types.UniquePodName
- func GetUniqueVolumeName(pluginName, volumeName string) v1.UniqueVolumeName
- func GetUniqueVolumeNameForNonAttachableVolume(podName types.UniquePodName, volumePlugin volume.VolumePlugin, ...) v1.UniqueVolumeName
- func GetUniqueVolumeNameFromSpec(volumePlugin volume.VolumePlugin, volumeSpec *volume.Spec) (v1.UniqueVolumeName, error)
- func GetVolumeMode(volumeSpec *volume.Spec) (v1.PersistentVolumeMode, error)
- func GetWindowsPath(path string) string
- func IsPodTerminated(pod *v1.Pod, podStatus v1.PodStatus) bool
- func IsReady(dir string) bool
- func JoinMountOptions(userOptions []string, systemOptions []string) []string
- func LabelZonesToSet(labelZonesValue string) (sets.String, error)
- func LoadPodFromFile(filePath string) (*v1.Pod, error)
- func MakeAbsolutePath(goos, path string) string
- func MakeNestedMountpoints(name, baseDir string, pod v1.Pod) error
- func MarkFSResizeFinished(pvc *v1.PersistentVolumeClaim, capacity v1.ResourceList, ...) error
- func MergeResizeConditionOnPVC(pvc *v1.PersistentVolumeClaim, ...) *v1.PersistentVolumeClaim
- func MountOptionFromSpec(spec *volume.Spec, options ...string) []string
- func NewDanglingError(msg string, node k8stypes.NodeName, devicePath string) error
- func NewSafeFormatAndMountFromHost(pluginName string, host volume.VolumeHost) *mount.SafeFormatAndMount
- func OperationCompleteHook(plugin, operationName string) func(*error)
- func PatchPVCStatus(oldPVC *v1.PersistentVolumeClaim, newPVC *v1.PersistentVolumeClaim, ...) (*v1.PersistentVolumeClaim, error)
- func PathExists(path string) (bool, error)
- func RoundUpSize(volumeSizeBytes int64, allocationUnitBytes int64) int64
- func RoundUpToGB(size resource.Quantity) int64
- func RoundUpToGiB(size resource.Quantity) int64
- func SetReady(dir string)
- func SplitUniqueName(uniqueName v1.UniqueVolumeName) (string, string, error)
- func UnmountMountPoint(mountPath string, mounter mount.Interface, extensiveMountPointCheck bool) error
- func UnmountPath(mountPath string, mounter mount.Interface) error
- func UnmountViaEmptyDir(dir string, host volume.VolumeHost, volName string, volSpec volume.Spec, ...) error
- func ValidateZone(zone string) error
- func ZonesSetToLabelValue(strSet sets.String) string
- func ZonesToSet(zonesString string) (sets.String, error)
- type AtomicWriter
- type DanglingAttachError
- type DeviceUtil
- type FileProjection
- type IoUtil
Constants ¶
const ( // Name of finalizer on PVCs that have a running pod. PVCProtectionFinalizer = "kubernetes.io/pvc-protection" // Name of finalizer on PVs that are bound by PVCs PVProtectionFinalizer = "kubernetes.io/pv-protection" )
const ( // GB - GigaByte size GB = 1000 * 1000 * 1000 // GIB - GibiByte size GIB = 1024 * 1024 * 1024 // ControllerManagedAttachAnnotation 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 ControllerManagedAttachAnnotation string = "volumes.kubernetes.io/controller-managed-attach-detach" // KeepTerminatedPodVolumesAnnotation is the key of the annotation on Node // that decides if pod volumes are unmounted when pod is terminated KeepTerminatedPodVolumesAnnotation string = "volumes.kubernetes.io/keep-terminated-pod-volumes" // VolumeGidAnnotationKey is the of the annotation on the PersistentVolume // object that specifies a supplemental GID. VolumeGidAnnotationKey = "pv.beta.kubernetes.io/gid" // VolumeDynamicallyCreatedByKey is the key of the annotation on PersistentVolume // object created dynamically VolumeDynamicallyCreatedByKey = "kubernetes.io/createdby" )
Variables ¶
This section is empty.
Functions ¶
func AccessModesContainedInAll ¶ added in v1.10.8
func AccessModesContainedInAll(indexedModes []v1.PersistentVolumeAccessMode, requestedModes []v1.PersistentVolumeAccessMode) bool
AccessModesContainedInAll returns whether all of the requested modes are contained by modes
func AccessModesContains ¶ added in v1.10.8
func AccessModesContains(modes []v1.PersistentVolumeAccessMode, mode v1.PersistentVolumeAccessMode) bool
AccessModesContains returns whether the requested mode is contained by modes
func CalculateTimeoutForVolume ¶ added in v1.10.8
func CalculateTimeoutForVolume(minimumTimeout, timeoutIncrement int, pv *v1.PersistentVolume) int64
CalculateTimeoutForVolume calculates time for a Recycler pod to complete a recycle operation. The calculation and return value is either the minimumTimeout or the timeoutIncrement per Gi of storage size, whichever is greater.
func CheckNodeAffinity ¶ added in v1.7.0
func CheckNodeAffinity(pv *v1.PersistentVolume, nodeLabels map[string]string) error
CheckNodeAffinity looks at the PV node affinity, and checks if the node has the same corresponding labels This ensures that we don't mount a volume that doesn't belong to this node
func CheckVolumeModeFilesystem ¶ added in v1.10.8
CheckVolumeModeFilesystem checks VolumeMode. If the mode is Filesystem, return true otherwise return false.
func ChooseZoneForVolume ¶ added in v1.10.8
ChooseZoneForVolume implements our heuristics for choosing a zone for volume creation based on the volume name Volumes are generally round-robin-ed across all active zones, using the hash of the PVC Name. However, if the PVCName ends with `-<integer>`, we will hash the prefix, and then add the integer to the hash. This means that a StatefulSet's volumes (`claimname-statefulsetname-id`) will spread across available zones, assuming the id values are consecutive.
func ChooseZonesForVolume ¶ added in v1.10.8
ChooseZonesForVolume is identical to ChooseZoneForVolume, but selects a multiple zones, for multi-zone disks.
func ClaimToClaimKey ¶ added in v1.10.8
func ClaimToClaimKey(claim *v1.PersistentVolumeClaim) string
ClaimToClaimKey return namespace/name string for pvc
func GenerateVolumeName ¶ added in v1.10.8
GenerateVolumeName returns a PV name with clusterName prefix. The function should be used to generate a name of GCE PD or Cinder volume. It basically adds "<clusterName>-dynamic-" before the PV name, making sure the resulting string fits given length and cuts "dynamic" if not.
func GetClassForVolume ¶ added in v1.5.1
func GetClassForVolume(kubeClient clientset.Interface, pv *v1.PersistentVolume) (*storage.StorageClass, error)
func GetPersistentVolumeClaimVolumeMode ¶ added in v1.10.8
func GetPersistentVolumeClaimVolumeMode(claim *v1.PersistentVolumeClaim) (v1.PersistentVolumeMode, error)
GetPersistentVolumeClaimVolumeMode retrieves VolumeMode from pvc.
func GetSecretForPV ¶ added in v1.5.1
func GetSecretForPV(secretNamespace, secretName, volumePluginName string, kubeClient clientset.Interface) (map[string]string, error)
GetSecretForPV locates secret by name and namespace, verifies the secret type, and returns secret map
func GetSecretForPod ¶ added in v1.5.1
func GetSecretForPod(pod *v1.Pod, secretName string, kubeClient clientset.Interface) (map[string]string, error)
GetSecretForPod locates secret by name in the pod's namespace and returns secret map
func GetUniquePodName ¶ added in v1.10.8
func GetUniquePodName(pod *v1.Pod) types.UniquePodName
GetUniquePodName returns a unique identifier to reference a pod by
func GetUniqueVolumeName ¶ added in v1.10.8
func GetUniqueVolumeName(pluginName, volumeName string) v1.UniqueVolumeName
GetUniqueVolumeName returns a unique name representing the volume/plugin. Caller should ensure that volumeName is a name/ID uniquely identifying the actual backing device, directory, path, etc. for a particular volume. The returned name can be used to uniquely reference the volume, for example, to prevent operations (attach/detach or mount/unmount) from being triggered on the same volume.
func GetUniqueVolumeNameForNonAttachableVolume ¶ added in v1.10.8
func GetUniqueVolumeNameForNonAttachableVolume( podName types.UniquePodName, volumePlugin volume.VolumePlugin, volumeSpec *volume.Spec) v1.UniqueVolumeName
GetUniqueVolumeNameForNonAttachableVolume returns the unique volume name for a non-attachable volume.
func GetUniqueVolumeNameFromSpec ¶ added in v1.10.8
func GetUniqueVolumeNameFromSpec( volumePlugin volume.VolumePlugin, volumeSpec *volume.Spec) (v1.UniqueVolumeName, error)
GetUniqueVolumeNameFromSpec uses the given VolumePlugin to generate a unique name representing the volume defined in the specified volume spec. This returned name can be used to uniquely reference the actual backing device, directory, path, etc. referenced by the given volumeSpec. If the given plugin does not support the volume spec, this returns an error.
func GetVolumeMode ¶ added in v1.10.8
func GetVolumeMode(volumeSpec *volume.Spec) (v1.PersistentVolumeMode, error)
GetVolumeMode retrieves VolumeMode from pv. If the volume doesn't have PersistentVolume, it's an inline volume, should return volumeMode as filesystem to keep existing behavior.
func GetWindowsPath ¶ added in v1.10.8
GetWindowsPath get a windows path
func IsPodTerminated ¶ added in v1.10.8
IsPodTerminated checks if pod is terminated
func IsReady ¶
IsReady checks for the existence of a regular file called 'ready' in the given directory and returns true if that file exists.
func JoinMountOptions ¶ added in v1.10.8
JoinMountOptions joins mount options eliminating duplicates
func LabelZonesToSet ¶ added in v1.8.0
LabelZonesToSet converts a PV label value from string containing a delimited list of zones to set
func LoadPodFromFile ¶ added in v1.8.0
LoadPodFromFile will read, decode, and return a Pod from a file.
func MakeAbsolutePath ¶ added in v1.10.8
MakeAbsolutePath convert path to absolute path according to GOOS
func MakeNestedMountpoints ¶ added in v1.7.15
MakeNestedMountpoints creates mount points in baseDir for volumes mounted beneath name
func MarkFSResizeFinished ¶ added in v1.10.8
func MarkFSResizeFinished( pvc *v1.PersistentVolumeClaim, capacity v1.ResourceList, kubeClient clientset.Interface) error
MarkFSResizeFinished marks file system resizing as done
func MergeResizeConditionOnPVC ¶ added in v1.10.8
func MergeResizeConditionOnPVC( pvc *v1.PersistentVolumeClaim, resizeConditions []v1.PersistentVolumeClaimCondition) *v1.PersistentVolumeClaim
MergeResizeConditionOnPVC updates pvc with requested resize conditions leaving other conditions untouched.
func MountOptionFromSpec ¶ added in v1.10.8
MountOptionFromSpec extracts and joins mount options from volume spec with supplied options
func NewDanglingError ¶ added in v1.9.0
func NewSafeFormatAndMountFromHost ¶ added in v1.10.8
func NewSafeFormatAndMountFromHost(pluginName string, host volume.VolumeHost) *mount.SafeFormatAndMount
NewSafeFormatAndMountFromHost creates a new SafeFormatAndMount with Mounter and Exec taken from given VolumeHost.
func OperationCompleteHook ¶ added in v1.8.0
OperationCompleteHook returns a hook to call when an operation is completed
func PatchPVCStatus ¶ added in v1.10.8
func PatchPVCStatus( oldPVC *v1.PersistentVolumeClaim, newPVC *v1.PersistentVolumeClaim, kubeClient clientset.Interface) (*v1.PersistentVolumeClaim, error)
PatchPVCStatus updates PVC status using PATCH verb
func PathExists ¶ added in v1.3.10
PathExists returns true if the specified path exists.
func RoundUpSize ¶ added in v1.10.8
RoundUpSize calculates how many allocation units are needed to accommodate a volume of given size. E.g. when user wants 1500MiB volume, while AWS EBS allocates volumes in gibibyte-sized chunks, RoundUpSize(1500 * 1024*1024, 1024*1024*1024) returns '2' (2 GiB is the smallest allocatable volume that can hold 1500MiB)
func RoundUpToGB ¶ added in v1.10.8
RoundUpToGB rounds up given quantity to chunks of GB
func RoundUpToGiB ¶ added in v1.10.8
RoundUpToGiB rounds up given quantity upto chunks of GiB
func SetReady ¶
func SetReady(dir string)
SetReady creates a file called 'ready' in the given directory. It logs an error if the file cannot be created.
func SplitUniqueName ¶ added in v1.10.8
func SplitUniqueName(uniqueName v1.UniqueVolumeName) (string, string, error)
SplitUniqueName splits the unique name to plugin name and volume name strings. It expects the uniqueName to follow the fromat plugin_name/volume_name and the plugin name must be namespaced as described by the plugin interface, i.e. namespace/plugin containing exactly one '/'. This means the unique name will always be in the form of plugin_namespace/plugin/volume_name, see k8s.io/kubernetes/pkg/volume/plugins.go VolumePlugin interface description and pkg/volume/util/volumehelper/volumehelper.go GetUniqueVolumeNameFromSpec that constructs the unique volume names.
func UnmountMountPoint ¶ added in v1.7.8
func UnmountMountPoint(mountPath string, mounter mount.Interface, extensiveMountPointCheck bool) error
UnmountMountPoint is a common unmount routine that unmounts the given path and deletes the remaining directory if successful. if extensiveMountPointCheck is true IsNotMountPoint will be called instead of IsLikelyNotMountPoint. IsNotMountPoint is more expensive but properly handles bind mounts.
func UnmountPath ¶ added in v1.3.10
UnmountPath is a common unmount routine that unmounts the given path and deletes the remaining directory if successful.
func UnmountViaEmptyDir ¶ added in v1.10.8
func UnmountViaEmptyDir(dir string, host volume.VolumeHost, volName string, volSpec volume.Spec, podUID utypes.UID) error
UnmountViaEmptyDir delegates the tear down operation for secret, configmap, git_repo and downwardapi to empty_dir
func ValidateZone ¶ added in v1.10.8
ValidateZone returns: - an error in case zone is an empty string or contains only any combination of spaces and tab characters - nil otherwise
func ZonesSetToLabelValue ¶ added in v1.8.0
Types ¶
type AtomicWriter ¶ added in v1.2.3
type AtomicWriter struct {
// contains filtered or unexported fields
}
AtomicWriter handles atomically projecting content for a set of files into a target directory.
Note:
- AtomicWriter reserves the set of pathnames starting with `..`.
- AtomicWriter offers no concurrency guarantees and must be synchronized by the caller.
The visible files in this volume are symlinks to files in the writer's data directory. Actual files are stored in a hidden timestamped directory which is symlinked to by the data directory. The timestamped directory and data directory symlink are created in the writer's target dir. This scheme allows the files to be atomically updated by changing the target of the data directory symlink.
Consumers of the target directory can monitor the ..data symlink using inotify or fanotify to receive events when the content in the volume is updated.
func NewAtomicWriter ¶ added in v1.2.3
func NewAtomicWriter(targetDir string, logContext string) (*AtomicWriter, error)
NewAtomicWriter creates a new AtomicWriter configured to write to the given target directory, or returns an error if the target directory does not exist.
func (*AtomicWriter) Write ¶ added in v1.2.3
func (w *AtomicWriter) Write(payload map[string]FileProjection) error
Write does an atomic projection of the given payload into the writer's target directory. Input paths must not begin with '..'.
The Write algorithm is:
The payload is validated; if the payload is invalid, the function returns 2. The current timestamped directory is detected by reading the data directory symlink
The old version of the volume is walked to determine whether any portion of the payload was deleted and is still present on disk.
The data in the current timestamped directory is compared to the projected data to determine if an update is required. 5. A new timestamped dir is created
The payload is written to the new timestamped directory 7. Symlinks and directory for new user-visible files are created (if needed).
For example, consider the files: <target-dir>/podName <target-dir>/user/labels <target-dir>/k8s/annotations
The user visible files are symbolic links into the internal data directory: <target-dir>/podName -> ..data/podName <target-dir>/usr -> ..data/usr <target-dir>/k8s -> ..data/k8s
The data directory itself is a link to a timestamped directory with the real data: <target-dir>/..data -> ..2016_02_01_15_04_05.12345678/ 8. A symlink to the new timestamped directory ..data_tmp is created that will become the new data directory 9. The new data directory symlink is renamed to the data directory; rename is atomic
10. Old paths are removed from the user-visible portion of the target directory 11. The previous timestamped directory is removed, if it exists
type DanglingAttachError ¶ added in v1.9.0
type DanglingAttachError struct { CurrentNode k8stypes.NodeName DevicePath string // contains filtered or unexported fields }
This error on attach indicates volume is attached to a different node than we expected.
func (*DanglingAttachError) Error ¶ added in v1.9.0
func (err *DanglingAttachError) Error() string
type DeviceUtil ¶ added in v1.3.0
type DeviceUtil interface { FindMultipathDeviceForDevice(disk string) string FindSlaveDevicesOnMultipath(disk string) []string }
DeviceUtil is a util for common device methods
func NewDeviceHandler ¶ added in v1.3.0
func NewDeviceHandler(io IoUtil) DeviceUtil
NewDeviceHandler Create a new IoHandler implementation
type FileProjection ¶ added in v1.4.2
type IoUtil ¶ added in v1.3.0
type IoUtil interface { ReadDir(dirname string) ([]os.FileInfo, error) Lstat(name string) (os.FileInfo, error) EvalSymlinks(path string) (string, error) }
IoUtil is a mockable util for common IO operations
func NewIOHandler ¶ added in v1.3.0
func NewIOHandler() IoUtil
NewIOHandler Create a new IoHandler implementation
Source Files
¶
Directories
¶
Path | Synopsis |
---|---|
Package nestedpendingoperations is a modified implementation of pkg/util/goroutinemap.
|
Package nestedpendingoperations is a modified implementation of pkg/util/goroutinemap. |
Package operationexecutor implements interfaces that enable execution of attach, detach, mount, and unmount operations with a nestedpendingoperations so that more than one operation is never triggered on the same volume for the same pod.
|
Package operationexecutor implements interfaces that enable execution of attach, detach, mount, and unmount operations with a nestedpendingoperations so that more than one operation is never triggered on the same volume for the same pod. |
Package types defines types used only by volume components
|
Package types defines types used only by volume components |