Documentation
¶
Overview ¶
Contains utility code for use by volume plugins.
Index ¶
- func CheckNodeAffinity(pv *v1.PersistentVolume, nodeLabels map[string]string) error
- func Du(path string) (*resource.Quantity, error)
- func Find(path string) (int64, error)
- func FsInfo(path string) (int64, int64, int64, int64, int64, int64, error)
- func GetClassForVolume(kubeClient clientset.Interface, pv *v1.PersistentVolume) (*storage.StorageClass, 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 IsReady(dir string) bool
- func LabelZonesToSet(labelZonesValue string) (sets.String, error)
- func LoadPodFromFile(filePath string) (*v1.Pod, error)
- func OperationCompleteHook(plugin, operationName string) func(error)
- func PathExists(path string) (bool, error)
- func SetReady(dir string)
- func UnmountMountPoint(mountPath string, mounter mount.Interface, extensiveMountPointCheck bool) error
- func UnmountPath(mountPath string, mounter mount.Interface) error
- func ZonesSetToLabelValue(strSet sets.String) string
- func ZonesToSet(zonesString string) (sets.String, error)
- type AtomicWriter
- type DeviceUtil
- type FileProjection
- type IoUtil
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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 Find ¶ added in v1.5.1
Find uses the equivalent of the command `find <path> -dev -printf '.' | wc -c` to count files and directories. While this is not an exact measure of inodes used, it is a very good approximation.
func FsInfo ¶ added in v1.2.3
FSInfo linux returns (available bytes, byte capacity, byte usage, total inodes, inodes free, inode usage, error) for the filesystem that path resides upon.
func GetClassForVolume ¶ added in v1.5.1
func GetClassForVolume(kubeClient clientset.Interface, pv *v1.PersistentVolume) (*storage.StorageClass, error)
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 IsReady ¶
IsReady checks for the existence of a regular file called 'ready' in the given directory and returns true if that file exists.
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 OperationCompleteHook ¶ added in v1.8.0
OperationCompleteHook returns a hook to call when an operation is completed
func PathExists ¶ added in v1.3.10
PathExists returns true if the specified path exists.
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 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 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
The user-visible portion of the volume is walked to determine whether any portion of the payload was deleted and is still present on disk. If the payload is already present on disk and there are no deleted files, the function returns
A check is made to determine whether data present in the payload has changed 4. A new timestamped dir is created
The payload is written to the new timestamped directory 6. 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/labels -> ../..data/usr/labels <target-dir>/k8s/annotations -> ../..data/k8s/annotations
Relative links are created into the data directory for files in subdirectories.
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/ 7. The current timestamped directory is detected by reading the data directory symlink 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 DeviceUtil ¶ added in v1.3.0
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 |
Package volumehelper contains consts and helper methods used by various volume components (attach/detach controller, kubelet, etc.).
|
Package volumehelper contains consts and helper methods used by various volume components (attach/detach controller, kubelet, etc.). |