util

Documentation

Overview

Contains utility code for use by volume plugins.

Index

• func AddVolumeAnnotations(pv *api.PersistentVolume, annotations map[string]string)
• func Du(path string) (*resource.Quantity, error)
• func FsInfo(path string) (int64, int64, int64, error)
• func GetClassForVolume(kubeClient clientset.Interface, pv *api.PersistentVolume) (*storage.StorageClass, error)
• func GetSecret(namespace, secretName string, kubeClient clientset.Interface) (map[string]string, error)
• func IsReady(dir string) bool
• func ParseVolumeAnnotations(pv *api.PersistentVolume, parseAnnotations []string) (map[string]string, error)
• func PathExists(path string) (bool, error)
• func SetReady(dir string)
• func UnmountPath(mountPath string, mounter mount.Interface) error
• type AtomicWriter
  • func NewAtomicWriter(targetDir string, logContext string) (*AtomicWriter, error)
  • func (w *AtomicWriter) Write(payload map[string]FileProjection) error
• type DeviceUtil
  • func NewDeviceHandler(io IoUtil) DeviceUtil
• type FileProjection
• type IoUtil
  • func NewIOHandler() IoUtil

Functions

func AddVolumeAnnotations

func AddVolumeAnnotations(pv *api.PersistentVolume, annotations map[string]string)

AddVolumeAnnotations adds a golang Map as annotation to a PersistentVolume

func Du

func Du(path string) (*resource.Quantity, error)

func FsInfo

func FsInfo(path string) (int64, int64, int64, error)

FSInfo linux returns (available bytes, byte capacity, byte usage, error) for the filesystem that path resides upon.

func GetClassForVolume

func GetClassForVolume(kubeClient clientset.Interface, pv *api.PersistentVolume) (*storage.StorageClass, error)

func GetSecret

func GetSecret(namespace, secretName string, kubeClient clientset.Interface) (map[string]string, error)

GetSecret locates secret by name and namespace and returns secret map

func IsReady

func IsReady(dir string) bool

IsReady checks for the existence of a regular file called 'ready' in the given directory and returns true if that file exists.

func ParseVolumeAnnotations

func ParseVolumeAnnotations(pv *api.PersistentVolume, parseAnnotations []string) (map[string]string, error)

ParseVolumeAnnotations reads the defined annoations from a PersistentVolume

func PathExists

func PathExists(path string) (bool, error)

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 UnmountPath

func UnmountPath(mountPath string, mounter mount.Interface) error

UnmountPath is a common unmount routine that unmounts the given path and deletes the remaining directory if successful.

Types

type AtomicWriter

type AtomicWriter struct {
	// contains filtered or unexported fields
}

AtomicWriter handles atomically projecting content for a set of files into a target directory.

Note:

1. AtomicWriter reserves the set of pathnames starting with `..`.
2. 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

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

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:

1. The payload is validated; if the payload is invalid, the function returns

2. 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

3. A check is made to determine whether data present in the payload has changed 4.  A new timestamped dir is created

5. 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

type DeviceUtil interface {
	FindMultipathDeviceForDevice(disk string) string
}

DeviceUtil is a util for common device methods

func NewDeviceHandler

func NewDeviceHandler(io IoUtil) DeviceUtil

NewDeviceHandler Create a new IoHandler implementation

type FileProjection

type FileProjection struct {
	Data []byte
	Mode int32
}

type IoUtil

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

func NewIOHandler() IoUtil

NewIOHandler Create a new IoHandler implementation