Documentation
¶
Overview ¶
Package mount defines an interface to mounting filesystems.
TODO(thockin): This whole pkg is pretty linux-centric. As soon as we have an alternate platform, we will need to abstract further.
Index ¶
- Constants
- func CleanupMountPoint(mountPath string, mounter Interface, extensiveMountPointCheck bool) error
- func GetDeviceNameFromMount(mounter Interface, mountPath string) (string, int, error)
- func HasMountRefs(mountPath string, mountRefs []string) bool
- func IsCorruptedMnt(err error) bool
- func PathExists(path string) (bool, error)
- func PathWithinBase(fullPath, basePath string) bool
- func StartsWithBackstep(rel string) bool
- type Exec
- type FakeAction
- type FakeExec
- type FakeMounter
- func (f *FakeMounter) DeviceOpened(pathname string) (bool, error)
- func (f *FakeMounter) EvalHostSymlinks(pathname string) (string, error)
- func (f *FakeMounter) ExistsPath(pathname string) (bool, error)
- func (f *FakeMounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, error)
- func (f *FakeMounter) GetFSGroup(pathname string) (int64, error)
- func (f *FakeMounter) GetFileType(pathname string) (FileType, error)
- func (f *FakeMounter) GetMode(pathname string) (os.FileMode, error)
- func (f *FakeMounter) GetMountRefs(pathname string) ([]string, error)
- func (f *FakeMounter) GetSELinuxSupport(pathname string) (bool, error)
- func (f *FakeMounter) IsLikelyNotMountPoint(file string) (bool, error)
- func (f *FakeMounter) IsMountPointMatch(mp MountPoint, dir string) bool
- func (f *FakeMounter) IsNotMountPoint(dir string) (bool, error)
- func (f *FakeMounter) List() ([]MountPoint, error)
- func (f *FakeMounter) MakeDir(pathname string) error
- func (f *FakeMounter) MakeFile(pathname string) error
- func (f *FakeMounter) MakeRShared(path string) error
- func (f *FakeMounter) Mount(source string, target string, fstype string, options []string) error
- func (f *FakeMounter) PathIsDevice(pathname string) (bool, error)
- func (f *FakeMounter) ResetLog()
- func (f *FakeMounter) Unmount(target string) error
- type FileType
- type Interface
- type MountPoint
- type Mounter
- func (mounter *Mounter) DeviceOpened(pathname string) (bool, error)
- func (mounter *Mounter) EvalHostSymlinks(pathname string) (string, error)
- func (mounter *Mounter) ExistsPath(pathname string) (bool, error)
- func (mounter *Mounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, error)
- func (mounter *Mounter) GetFSGroup(pathname string) (int64, error)
- func (mounter *Mounter) GetFileType(pathname string) (FileType, error)
- func (mounter *Mounter) GetMode(pathname string) (os.FileMode, error)
- func (mounter *Mounter) GetMountRefs(pathname string) ([]string, error)
- func (mounter *Mounter) GetSELinuxSupport(pathname string) (bool, error)
- func (mounter *Mounter) IsLikelyNotMountPoint(file string) (bool, error)
- func (mounter *Mounter) IsMountPointMatch(mp MountPoint, dir string) bool
- func (mounter *Mounter) IsNotMountPoint(dir string) (bool, error)
- func (*Mounter) List() ([]MountPoint, error)
- func (mounter *Mounter) MakeDir(pathname string) error
- func (mounter *Mounter) MakeFile(pathname string) error
- func (mounter *Mounter) MakeRShared(path string) error
- func (mounter *Mounter) Mount(source string, target string, fstype string, options []string) error
- func (mounter *Mounter) PathIsDevice(pathname string) (bool, error)
- func (mounter *Mounter) Unmount(target string) error
- type SafeFormatAndMount
- type Subpath
Constants ¶
const FakeActionMount = "mount"
Values for FakeAction.Action
const FakeActionUnmount = "unmount"
Variables ¶
This section is empty.
Functions ¶
func CleanupMountPoint ¶ added in v1.11.7
CleanupMountPoint 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 within the same fs.
func GetDeviceNameFromMount ¶ added in v0.15.0
GetDeviceNameFromMount: given a mnt point, find the device from /proc/mounts returns the device name, reference count, and error code
func HasMountRefs ¶ added in v1.10.0
func IsCorruptedMnt ¶ added in v1.11.7
IsCorruptedMnt return true if err is about corrupted mount point
func PathExists ¶ added in v1.11.7
TODO: clean this up to use pkg/util/file/FileExists PathExists returns true if the specified path exists.
func PathWithinBase ¶ added in v1.12.0
PathWithinBase checks if give path is within given base directory.
func StartsWithBackstep ¶ added in v1.14.0
StartsWithBackstep checks if the given path starts with a backstep segment
Types ¶
type Exec ¶ added in v1.8.0
type Exec interface { // Run executes a command and returns its stdout + stderr combined in one // stream. Run(cmd string, args ...string) ([]byte, error) }
Exec executes command where mount utilities are. This can be either the host, container where kubelet runs or even a remote pod with mount utilities. Usual k8s.io/utils/exec interface is not used because kubelet.RunInContainer does not provide stdin/stdout/stderr streams.
type FakeAction ¶ added in v0.13.1
type FakeAction struct { Action string // "mount" or "unmount" Target string // applies to both mount and unmount actions Source string // applies only to "mount" actions FSType string // applies only to "mount" actions }
FakeAction objects are logged every time a fake mount or unmount is called.
type FakeExec ¶ added in v1.8.0
type FakeExec struct {
// contains filtered or unexported fields
}
Fake for testing.
func NewFakeExec ¶ added in v1.8.0
func NewFakeExec(run runHook) *FakeExec
type FakeMounter ¶ added in v0.13.0
type FakeMounter struct { MountPoints []MountPoint Log []FakeAction Filesystem map[string]FileType // Error to return for a path when calling IsLikelyNotMountPoint MountCheckErrors map[string]error // contains filtered or unexported fields }
FakeMounter implements mount.Interface for tests.
func (*FakeMounter) DeviceOpened ¶ added in v1.4.0
func (f *FakeMounter) DeviceOpened(pathname string) (bool, error)
func (*FakeMounter) EvalHostSymlinks ¶ added in v1.12.0
func (f *FakeMounter) EvalHostSymlinks(pathname string) (string, error)
func (*FakeMounter) ExistsPath ¶ added in v1.9.0
func (f *FakeMounter) ExistsPath(pathname string) (bool, error)
func (*FakeMounter) GetDeviceNameFromMount ¶ added in v1.3.6
func (f *FakeMounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, error)
func (*FakeMounter) GetFSGroup ¶ added in v1.11.0
func (f *FakeMounter) GetFSGroup(pathname string) (int64, error)
func (*FakeMounter) GetFileType ¶ added in v1.9.0
func (f *FakeMounter) GetFileType(pathname string) (FileType, error)
func (*FakeMounter) GetMode ¶ added in v1.11.0
func (f *FakeMounter) GetMode(pathname string) (os.FileMode, error)
func (*FakeMounter) GetMountRefs ¶ added in v1.11.0
func (f *FakeMounter) GetMountRefs(pathname string) ([]string, error)
func (*FakeMounter) GetSELinuxSupport ¶ added in v1.10.4
func (f *FakeMounter) GetSELinuxSupport(pathname string) (bool, error)
func (*FakeMounter) IsLikelyNotMountPoint ¶ added in v1.1.0
func (f *FakeMounter) IsLikelyNotMountPoint(file string) (bool, error)
func (*FakeMounter) IsMountPointMatch ¶ added in v1.7.2
func (f *FakeMounter) IsMountPointMatch(mp MountPoint, dir string) bool
func (*FakeMounter) IsNotMountPoint ¶ added in v1.7.2
func (f *FakeMounter) IsNotMountPoint(dir string) (bool, error)
func (*FakeMounter) List ¶ added in v0.13.0
func (f *FakeMounter) List() ([]MountPoint, error)
func (*FakeMounter) MakeDir ¶ added in v1.9.0
func (f *FakeMounter) MakeDir(pathname string) error
func (*FakeMounter) MakeFile ¶ added in v1.9.0
func (f *FakeMounter) MakeFile(pathname string) error
func (*FakeMounter) MakeRShared ¶ added in v1.8.0
func (f *FakeMounter) MakeRShared(path string) error
func (*FakeMounter) PathIsDevice ¶ added in v1.4.0
func (f *FakeMounter) PathIsDevice(pathname string) (bool, error)
func (*FakeMounter) ResetLog ¶ added in v0.13.1
func (f *FakeMounter) ResetLog()
func (*FakeMounter) Unmount ¶ added in v0.13.0
func (f *FakeMounter) Unmount(target string) error
type Interface ¶
type Interface interface { // Mount mounts source to target as fstype with given options. Mount(source string, target string, fstype string, options []string) error // Unmount unmounts given target. Unmount(target string) error // List returns a list of all mounted filesystems. This can be large. // On some platforms, reading mounts is not guaranteed consistent (i.e. // it could change between chunked reads). This is guaranteed to be // consistent. List() ([]MountPoint, error) // IsMountPointMatch determines if the mountpoint matches the dir IsMountPointMatch(mp MountPoint, dir string) bool // IsNotMountPoint determines if a directory is a mountpoint. // It should return ErrNotExist when the directory does not exist. // IsNotMountPoint is more expensive than IsLikelyNotMountPoint. // IsNotMountPoint detects bind mounts in linux. // IsNotMountPoint enumerates all the mountpoints using List() and // the list of mountpoints may be large, then it uses // IsMountPointMatch to evaluate whether the directory is a mountpoint IsNotMountPoint(file string) (bool, error) // IsLikelyNotMountPoint uses heuristics to determine if a directory // is a mountpoint. // It should return ErrNotExist when the directory does not exist. // IsLikelyNotMountPoint does NOT properly detect all mountpoint types // most notably linux bind mounts. IsLikelyNotMountPoint(file string) (bool, error) // DeviceOpened determines if the device is in use elsewhere // on the system, i.e. still mounted. DeviceOpened(pathname string) (bool, error) // PathIsDevice determines if a path is a device. PathIsDevice(pathname string) (bool, error) // GetDeviceNameFromMount finds the device name by checking the mount path // to get the global mount path which matches its plugin directory GetDeviceNameFromMount(mountPath, pluginDir string) (string, error) // propagation. If not, it bind-mounts the path as rshared. MakeRShared(path string) error // GetFileType checks for file/directory/socket/block/character devices. // Will operate in the host mount namespace if kubelet is running in a container GetFileType(pathname string) (FileType, error) // MakeFile creates an empty file. // Will operate in the host mount namespace if kubelet is running in a container MakeFile(pathname string) error // MakeDir creates a new directory. // Will operate in the host mount namespace if kubelet is running in a container MakeDir(pathname string) error // Will operate in the host mount namespace if kubelet is running in a container. // Error is returned on any other error than "file not found". ExistsPath(pathname string) (bool, error) // EvalHostSymlinks returns the path name after evaluating symlinks. // Will operate in the host mount namespace if kubelet is running in a container. EvalHostSymlinks(pathname string) (string, error) // GetMountRefs finds all mount references to the path, returns a // list of paths. Path could be a mountpoint path, device or a normal // directory (for bind mount). GetMountRefs(pathname string) ([]string, error) // GetFSGroup returns FSGroup of the path. GetFSGroup(pathname string) (int64, error) // GetSELinuxSupport returns true if given path is on a mount that supports // SELinux. GetSELinuxSupport(pathname string) (bool, error) // GetMode returns permissions of the path. GetMode(pathname string) (os.FileMode, error) }
func New ¶
New returns a mount.Interface for the current system. It provides options to override the default mounter behavior. mounterPath allows using an alternative to `/bin/mount` for mounting.
func NewExecMounter ¶ added in v1.9.0
type MountPoint ¶
This represents a single line in /proc/mounts or /etc/fstab.
type Mounter ¶ added in v0.10.0
type Mounter struct {
// contains filtered or unexported fields
}
Mounter provides the default implementation of mount.Interface for the linux platform. This implementation assumes that the kubelet is running in the host's root mount namespace.
func (*Mounter) DeviceOpened ¶ added in v1.4.0
DeviceOpened checks if block device in use by calling Open with O_EXCL flag. If pathname is not a device, log and return false with nil error. If open returns errno EBUSY, return true with nil error. If open returns nil, return false with nil error. Otherwise, return false with error
func (*Mounter) EvalHostSymlinks ¶ added in v1.12.0
func (*Mounter) ExistsPath ¶ added in v1.9.0
func (*Mounter) GetDeviceNameFromMount ¶ added in v1.3.6
GetDeviceNameFromMount: given a mount point, find the device name from its global mount point
func (*Mounter) GetFSGroup ¶ added in v1.11.0
func (*Mounter) GetFileType ¶ added in v1.9.0
func (*Mounter) GetMountRefs ¶ added in v1.11.0
func (*Mounter) GetSELinuxSupport ¶ added in v1.10.4
func (*Mounter) IsLikelyNotMountPoint ¶ added in v1.1.0
IsLikelyNotMountPoint determines if a directory is not a mountpoint. It is fast but not necessarily ALWAYS correct. If the path is in fact a bind mount from one part of a mount to another it will not be detected. mkdir /tmp/a /tmp/b; mount --bin /tmp/a /tmp/b; IsLikelyNotMountPoint("/tmp/b") will return true. When in fact /tmp/b is a mount point. If this situation if of interest to you, don't use this function...
func (*Mounter) IsMountPointMatch ¶ added in v1.7.2
func (mounter *Mounter) IsMountPointMatch(mp MountPoint, dir string) bool
func (*Mounter) IsNotMountPoint ¶ added in v1.7.2
func (*Mounter) List ¶ added in v0.10.0
func (*Mounter) List() ([]MountPoint, error)
List returns a list of all mounted filesystems.
func (*Mounter) MakeRShared ¶ added in v1.8.0
func (*Mounter) Mount ¶ added in v0.10.0
Mount mounts source to target as fstype with given options. 'source' and 'fstype' must be an empty string in case it's not required, e.g. for remount, or for auto filesystem type, where kernel handles fstype for you. The mount 'options' is a list of options, currently come from mount(8), e.g. "ro", "remount", "bind", etc. If no more option is required, call Mount with an empty string list or nil.
func (*Mounter) PathIsDevice ¶ added in v1.4.0
PathIsDevice uses FileInfo returned from os.Stat to check if path refers to a device.
type SafeFormatAndMount ¶ added in v1.1.0
SafeFormatAndMount probes a device to see if it is formatted. Namely it checks to see if a file system is present. If so it mounts it otherwise the device is formatted first then mounted.
func (*SafeFormatAndMount) FormatAndMount ¶ added in v1.2.0
func (mounter *SafeFormatAndMount) FormatAndMount(source string, target string, fstype string, options []string) error
FormatAndMount formats the given disk, if needed, and mounts it. That is if the disk is not formatted and it is not being mounted as read-only it will format it first then mount it. Otherwise, if the disk is already formatted or it is being mounted as read-only, it will be mounted without formatting.
func (*SafeFormatAndMount) GetDiskFormat ¶ added in v1.9.0
func (mounter *SafeFormatAndMount) GetDiskFormat(disk string) (string, error)
GetDiskFormat uses 'blkid' to see if the given disk is unformated
type Subpath ¶ added in v1.7.14
type Subpath struct { // index of the VolumeMount for this container VolumeMountIndex int // Full path to the subpath directory on the host Path string // name of the volume that is a valid directory name. VolumeName string // Full path to the volume path VolumePath string // Path to the pod's directory, including pod UID PodDir string // Name of the container ContainerName string }