package mount
import "k8s.io/kubernetes/pkg/util/mount"
Package mount defines an interface to mounting filesystems.
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 IsBind(options []string) (bool, []string, []string)
- func IsCorruptedMnt(err error) bool
- func IsNotMountPoint(mounter Interface, file string) (bool, error)
- func PathExists(path string) (bool, error)
- func PathWithinBase(fullPath, basePath string) bool
- func StartsWithBackstep(rel string) bool
- type Exec
- type FakeAction
- type FakeExec
- func NewFakeExec(run runHook) *FakeExec
- func (f *FakeExec) Run(cmd string, args ...string) ([]byte, error)
- type FakeHostUtil
- func (hu *FakeHostUtil) DeviceOpened(pathname string) (bool, error)
- func (hu *FakeHostUtil) EvalHostSymlinks(pathname string) (string, error)
- func (hu *FakeHostUtil) GetDeviceNameFromMount(mounter Interface, mountPath, pluginMountDir string) (string, error)
- func (hu *FakeHostUtil) GetFileType(pathname string) (FileType, error)
- func (hu *FakeHostUtil) GetMode(pathname string) (os.FileMode, error)
- func (hu *FakeHostUtil) GetOwner(pathname string) (int64, int64, error)
- func (hu *FakeHostUtil) GetSELinuxSupport(pathname string) (bool, error)
- func (hu *FakeHostUtil) MakeDir(pathname string) error
- func (hu *FakeHostUtil) MakeFile(pathname string) error
- func (hu *FakeHostUtil) MakeRShared(path string) error
- func (hu *FakeHostUtil) PathExists(pathname string) (bool, error)
- func (hu *FakeHostUtil) PathIsDevice(pathname string) (bool, error)
- type FakeMounter
- func (f *FakeMounter) GetMountRefs(pathname string) ([]string, error)
- func (f *FakeMounter) IsLikelyNotMountPoint(file string) (bool, error)
- func (f *FakeMounter) IsMountPointMatch(mp MountPoint, dir string) bool
- func (f *FakeMounter) List() ([]MountPoint, error)
- func (f *FakeMounter) Mount(source string, target string, fstype string, options []string) error
- func (f *FakeMounter) ResetLog()
- func (f *FakeMounter) Unmount(target string) error
- type FileType
- type HostUtils
- type Interface
- type MountPoint
- type Mounter
- func (mounter *Mounter) GetMountRefs(pathname string) ([]string, error)
- func (mounter *Mounter) IsLikelyNotMountPoint(file string) (bool, error)
- func (mounter *Mounter) IsMountPointMatch(mp MountPoint, dir string) bool
- func (mounter *Mounter) List() ([]MountPoint, error)
- func (mounter *Mounter) Mount(source string, target string, fstype string, options []string) error
- func (mounter *Mounter) Unmount(target string) error
- type SafeFormatAndMount
Constants ¶
const ( // FakeActionMount is the string for specifying mount as FakeAction.Action FakeActionMount = "mount" // FakeActionUnmount is the string for specifying unmount as FakeAction.Action FakeActionUnmount = "unmount" )
Functions ¶
func CleanupMountPoint ¶
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 ¶
GetDeviceNameFromMount given a mnt point, find the device from /proc/mounts returns the device name, reference count, and error code.
func HasMountRefs ¶
HasMountRefs checks if the given mountPath has mountRefs. TODO: this is a workaround for the unmount device issue caused by gci mounter. In GCI cluster, if gci mounter is used for mounting, the container started by mounter script will cause additional mounts created in the container. Since these mounts are irrelevant to the original mounts, they should be not considered when checking the mount references. Current solution is to filter out those mount paths that contain the string of original mount path. Plan to work on better approach to solve this issue.
func IsBind ¶
IsBind detects whether a bind mount is being requested and makes the remount options to use in case of bind mount, due to the fact that bind mount doesn't respect mount options. The list equals:
options - 'bind' + 'remount' (no duplicate)
func IsCorruptedMnt ¶
IsCorruptedMnt return true if err is about corrupted mount point
func IsNotMountPoint ¶
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.
func PathExists ¶
PathExists returns true if the specified path exists. TODO: clean this up to use pkg/util/file/FileExists
func PathWithinBase ¶
PathWithinBase checks if give path is within given base directory.
func StartsWithBackstep ¶
StartsWithBackstep checks if the given path starts with a backstep segment.
Types ¶
type Exec ¶
type Exec interface { // Run executes a command and returns its stdout + stderr combined in one // stream. Run(cmd string, args ...string) ([]byte, error) }
Exec is an interface for executing commands on systems.
func NewOSExec ¶
func NewOSExec() Exec
NewOSExec returns a new Exec interface implementation based on exec()
type FakeAction ¶
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 ¶
type FakeExec struct {
// contains filtered or unexported fields
}
FakeExec for testing.
func NewFakeExec ¶
func NewFakeExec(run runHook) *FakeExec
NewFakeExec returns a new FakeExec
func (*FakeExec) Run ¶
Run executes the command using the optional runhook, if given
type FakeHostUtil ¶
type FakeHostUtil struct { MountPoints []MountPoint Filesystem map[string]FileType // contains filtered or unexported fields }
FakeHostUtil is a fake mount.HostUtils implementation for testing
func (*FakeHostUtil) DeviceOpened ¶
func (hu *FakeHostUtil) DeviceOpened(pathname string) (bool, error)
DeviceOpened checks if block device referenced by pathname is in use by checking if is listed as a device in the in-memory mountpoint table.
func (*FakeHostUtil) EvalHostSymlinks ¶
func (hu *FakeHostUtil) EvalHostSymlinks(pathname string) (string, error)
EvalHostSymlinks returns the path name after evaluating symlinks. No-op for testing
func (*FakeHostUtil) GetDeviceNameFromMount ¶
func (hu *FakeHostUtil) GetDeviceNameFromMount(mounter Interface, mountPath, pluginMountDir string) (string, error)
GetDeviceNameFromMount given a mount point, find the volume id
func (*FakeHostUtil) GetFileType ¶
func (hu *FakeHostUtil) GetFileType(pathname string) (FileType, error)
GetFileType checks for file/directory/socket/block/character devices. Defaults to Directory if otherwise unspecified.
func (*FakeHostUtil) GetMode ¶
func (hu *FakeHostUtil) GetMode(pathname string) (os.FileMode, error)
GetMode returns permissions of pathname. Not implemented for testing
func (*FakeHostUtil) GetOwner ¶
func (hu *FakeHostUtil) GetOwner(pathname string) (int64, int64, error)
GetOwner returns the integer ID for the user and group of the given path Not implemented for testing
func (*FakeHostUtil) GetSELinuxSupport ¶
func (hu *FakeHostUtil) GetSELinuxSupport(pathname string) (bool, error)
GetSELinuxSupport tests if pathname is on a mount that supports SELinux. Not implemented for testing
func (*FakeHostUtil) MakeDir ¶
func (hu *FakeHostUtil) MakeDir(pathname string) error
MakeDir creates a new directory. No-op for testing
func (*FakeHostUtil) MakeFile ¶
func (hu *FakeHostUtil) MakeFile(pathname string) error
MakeFile creates a new file. No-op for testing
func (*FakeHostUtil) MakeRShared ¶
func (hu *FakeHostUtil) MakeRShared(path string) error
MakeRShared checks if path is shared and bind-mounts it as rshared if needed. No-op for testing
func (*FakeHostUtil) PathExists ¶
func (hu *FakeHostUtil) PathExists(pathname string) (bool, error)
PathExists checks if pathname exists.
func (*FakeHostUtil) PathIsDevice ¶
func (hu *FakeHostUtil) PathIsDevice(pathname string) (bool, error)
PathIsDevice always returns true
type FakeMounter ¶
type FakeMounter struct { MountPoints []MountPoint Log []FakeAction // 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) GetMountRefs ¶
func (f *FakeMounter) GetMountRefs(pathname string) ([]string, error)
GetMountRefs finds all mount references to the path, returns a list of paths.
func (*FakeMounter) IsLikelyNotMountPoint ¶
func (f *FakeMounter) IsLikelyNotMountPoint(file string) (bool, error)
IsLikelyNotMountPoint determines whether a path is a mountpoint by checking if the absolute path to file is in the in-memory mountpoints
func (*FakeMounter) IsMountPointMatch ¶
func (f *FakeMounter) IsMountPointMatch(mp MountPoint, dir string) bool
IsMountPointMatch tests if dir and mp are the same path
func (*FakeMounter) List ¶
func (f *FakeMounter) List() ([]MountPoint, error)
List returns all the in-memory mountpoints for FakeMounter
func (*FakeMounter) Mount ¶
Mount records the mount event and updates the in-memory mount points for FakeMounter
func (*FakeMounter) ResetLog ¶
func (f *FakeMounter) ResetLog()
ResetLog clears all the log entries in FakeMounter
func (*FakeMounter) Unmount ¶
func (f *FakeMounter) Unmount(target string) error
Unmount records the unmount event and updates the in-memory mount points for FakeMounter
type FileType ¶
type FileType string
FileType enumerates the known set of possible file types.
const ( // FileTypeBlockDev defines a constant for the block device FileType. FileTypeBlockDev FileType = "BlockDevice" // FileTypeCharDev defines a constant for the character device FileType. FileTypeCharDev FileType = "CharDevice" // FileTypeDirectory defines a constant for the directory FileType. FileTypeDirectory FileType = "Directory" // FileTypeFile defines a constant for the file FileType. FileTypeFile FileType = "File" // FileTypeSocket defines a constant for the socket FileType. FileTypeSocket FileType = "Socket" // FileTypeUnknown defines a constant for an unknown FileType. FileTypeUnknown FileType = "" )
type HostUtils ¶
type HostUtils interface { // DeviceOpened determines if the device (e.g. /dev/sdc) 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 within its plugin directory. GetDeviceNameFromMount(mounter Interface, mountPath, pluginMountDir string) (string, error) // MakeRShared checks that given path is on a mount with 'rshared' mount // propagation. If not, it bind-mounts the path as rshared. (path string) error // GetFileType checks for file/directory/socket/block/character devices. GetFileType(pathname string) (FileType, error) // MakeFile creates an empty file. MakeFile(pathname string) error // MakeDir creates a new directory. MakeDir(pathname string) error // PathExists tests if the given path already exists // Error is returned on any other error than "file not found". PathExists(pathname string) (bool, error) // EvalHostSymlinks returns the path name after evaluating symlinks. EvalHostSymlinks(pathname string) (string, error) // GetOwner returns the integer ID for the user and group of the given path GetOwner(pathname string) (int64, 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) }
HostUtils defines the set of methods for interacting with paths on a host.
func NewHostUtil ¶
func NewHostUtil() HostUtils
NewHostUtil returns a struct that implements the HostUtils interface on unsupported platforms
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 directly from the OS 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 // IsLikelyNotMountPoint uses heuristics to determine if a directory // is not 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 and symbolic link. IsLikelyNotMountPoint(file string) (bool, 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) }
Interface defines the set of methods to allow for mount operations on a system.
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.
type MountPoint ¶
MountPoint represents a single line in /proc/mounts or /etc/fstab.
type Mounter ¶
type Mounter struct {
// contains filtered or unexported fields
}
Mounter implements mount.Interface for unsupported platforms
func (*Mounter) GetMountRefs ¶
GetMountRefs always returns an error on unsupported platforms
func (*Mounter) IsLikelyNotMountPoint ¶
IsLikelyNotMountPoint always returns an error on unsupported platforms
func (*Mounter) IsMountPointMatch ¶
func (mounter *Mounter) IsMountPointMatch(mp MountPoint, dir string) bool
IsMountPointMatch returns true if the path in mp is the same as dir
func (*Mounter) List ¶
func (mounter *Mounter) List() ([]MountPoint, error)
List always returns an error on unsupported platforms
func (*Mounter) Mount ¶
Mount always returns an error on unsupported platforms
func (*Mounter) Unmount ¶
Unmount always returns an error on unsupported platforms
type SafeFormatAndMount ¶
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 ¶
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.
Source Files ¶
doc.go exec.go fake.go mount.go mount_helper_common.go mount_helper_unix.go mount_unsupported.go
- Version
- v1.16.0-beta.1
- Published
- Aug 20, 2019
- Platform
- js/wasm
- Imports
- 9 packages
- Last checked
- 54 minutes ago –
Tools for package owners.