kubernetes: k8s.io/kubernetes/pkg/util/mount Index | Files

package mount

import "k8s.io/kubernetes/pkg/util/mount"

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

Package Files

doc.go exec.go fake.go mount.go mount_helper_common.go mount_helper_unix.go mount_linux.go

Constants

const FakeActionMount = "mount"

Values for FakeAction.Action

const FakeActionUnmount = "unmount"

func AddSystemdScope Uses

func AddSystemdScope(systemdRunPath, mountName, command string, args []string) (string, []string)

AddSystemdScope adds "system-run --scope" to given command line implementation is shared with NsEnterMounter

func CleanupMountPoint Uses

func CleanupMountPoint(mountPath string, mounter Interface, extensiveMountPointCheck bool) error

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 DoMakeRShared Uses

func DoMakeRShared(path string, mountInfoFilename string) error

DoMakeRShared is common implementation of MakeRShared on Linux. It checks if path is shared and bind-mounts it as rshared if needed. mountCmd and mountArgs are expected to contain mount-like command, DoMakeRShared will add '--bind <path> <path>' and '--make-rshared <path>' to mountArgs.

func ExclusiveOpenFailsOnDevice Uses

func ExclusiveOpenFailsOnDevice(pathname string) (bool, error)

ExclusiveOpenFailsOnDevice is shared with NsEnterMounter

func GetDeviceNameFromMount Uses

func GetDeviceNameFromMount(mounter Interface, mountPath string) (string, int, error)

GetDeviceNameFromMount: given a mnt point, find the device from /proc/mounts returns the device name, reference count, and error code

func GetDeviceNameFromMountLinux Uses

func GetDeviceNameFromMountLinux(mounter Interface, mountPath, pluginMountDir string) (string, error)

GetDeviceNameFromMountLinux find the device name from /proc/mounts in which the mount path reference should match the given plugin mount directory. In case no mount path reference matches, returns the volume name taken from its given mountPath This implementation is shared with NsEnterMounter

func GetFSGroupLinux Uses

func GetFSGroupLinux(pathname string) (int64, error)

GetFSGroupLinux is shared between Linux and NsEnterMounter pathname must already be evaluated for symlinks

func GetModeLinux Uses

func GetModeLinux(pathname string) (os.FileMode, error)

GetModeLinux is shared between Linux and NsEnterMounter

func GetSELinux Uses

func GetSELinux(path string, mountInfoFilename string) (bool, error)

GetSELinux is common implementation of GetSELinuxSupport on Linux.

func HasMountRefs Uses

func HasMountRefs(mountPath string, mountRefs []string) bool

func IsBind Uses

func IsBind(options []string) (bool, []string, []string)

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 Uses

func IsCorruptedMnt(err error) bool

IsCorruptedMnt return true if err is about corrupted mount point

func IsNotMountPoint Uses

func IsNotMountPoint(mounter Interface, file string) (bool, error)

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 MakeMountArgs Uses

func MakeMountArgs(source, target, fstype string, options []string) []string

MakeMountArgs makes the arguments to the mount(8) command. Implementation is shared with NsEnterMounter

func PathExists Uses

func PathExists(path string) (bool, error)

TODO: clean this up to use pkg/util/file/FileExists PathExists returns true if the specified path exists.

func PathWithinBase Uses

func PathWithinBase(fullPath, basePath string) bool

PathWithinBase checks if give path is within given base directory.

func SearchMountPoints Uses

func SearchMountPoints(hostSource, mountInfoPath string) ([]string, error)

SearchMountPoints finds all mount references to the source, returns a list of mountpoints. This function assumes source cannot be device. Some filesystems may share a source name, e.g. tmpfs. And for bind mounting, it's possible to mount a non-root path of a filesystem, so we need to use root path and major:minor to represent mount source uniquely. This implementation is shared between Linux and NsEnterMounter

func StartsWithBackstep Uses

func StartsWithBackstep(rel string) bool

StartsWithBackstep checks if the given path starts with a backstep segment

type Exec Uses

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.

func NewOsExec Uses

func NewOsExec() Exec

type FakeAction Uses

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 Uses

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

Fake for testing.

func NewFakeExec Uses

func NewFakeExec(run runHook) *FakeExec

func (*FakeExec) Run Uses

func (f *FakeExec) Run(cmd string, args ...string) ([]byte, error)

type FakeHostUtil Uses

type FakeHostUtil struct {
    MountPoints []MountPoint
    Filesystem  map[string]FileType
    // contains filtered or unexported fields
}

func (*FakeHostUtil) DeviceOpened Uses

func (hu *FakeHostUtil) DeviceOpened(pathname string) (bool, error)
func (hu *FakeHostUtil) EvalHostSymlinks(pathname string) (string, error)

func (*FakeHostUtil) ExistsPath Uses

func (hu *FakeHostUtil) ExistsPath(pathname string) (bool, error)

func (*FakeHostUtil) GetDeviceNameFromMount Uses

func (hu *FakeHostUtil) GetDeviceNameFromMount(mounter Interface, mountPath, pluginMountDir string) (string, error)

func (*FakeHostUtil) GetFSGroup Uses

func (hu *FakeHostUtil) GetFSGroup(pathname string) (int64, error)

func (*FakeHostUtil) GetFileType Uses

func (hu *FakeHostUtil) GetFileType(pathname string) (FileType, error)

func (*FakeHostUtil) GetMode Uses

func (hu *FakeHostUtil) GetMode(pathname string) (os.FileMode, error)

func (*FakeHostUtil) GetSELinuxSupport Uses

func (hu *FakeHostUtil) GetSELinuxSupport(pathname string) (bool, error)

func (*FakeHostUtil) MakeDir Uses

func (hu *FakeHostUtil) MakeDir(pathname string) error

func (*FakeHostUtil) MakeFile Uses

func (hu *FakeHostUtil) MakeFile(pathname string) error

func (*FakeHostUtil) MakeRShared Uses

func (hu *FakeHostUtil) MakeRShared(path string) error

func (*FakeHostUtil) PathIsDevice Uses

func (hu *FakeHostUtil) PathIsDevice(pathname string) (bool, error)

type FakeMounter Uses

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 Uses

func (f *FakeMounter) GetMountRefs(pathname string) ([]string, error)

func (*FakeMounter) IsLikelyNotMountPoint Uses

func (f *FakeMounter) IsLikelyNotMountPoint(file string) (bool, error)

func (*FakeMounter) IsMountPointMatch Uses

func (f *FakeMounter) IsMountPointMatch(mp MountPoint, dir string) bool

func (*FakeMounter) List Uses

func (f *FakeMounter) List() ([]MountPoint, error)

func (*FakeMounter) Mount Uses

func (f *FakeMounter) Mount(source string, target string, fstype string, options []string) error

func (*FakeMounter) ResetLog Uses

func (f *FakeMounter) ResetLog()

func (*FakeMounter) Unmount Uses

func (f *FakeMounter) Unmount(target string) error

type FileType Uses

type FileType string
const (
    FileTypeDirectory FileType = "Directory"
    FileTypeFile      FileType = "File"
    FileTypeSocket    FileType = "Socket"
    FileTypeCharDev   FileType = "CharDevice"
    FileTypeBlockDev  FileType = "BlockDevice"
)

type HostUtils Uses

type HostUtils interface {
    // 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 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.
    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)
    // 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 NewHostUtil Uses

func NewHostUtil() HostUtils

type Interface Uses

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
    // 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 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)
}

func New Uses

func New(mounterPath string) Interface

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 Uses

type MountPoint struct {
    Device string
    Path   string
    Type   string
    Opts   []string
    Freq   int
    Pass   int
}

This represents a single line in /proc/mounts or /etc/fstab.

func ListProcMounts Uses

func ListProcMounts(mountFilePath string) ([]MountPoint, error)

ListProcMounts is shared with NsEnterMounter

type Mounter Uses

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) GetMountRefs Uses

func (mounter *Mounter) GetMountRefs(pathname string) ([]string, error)

func (*Mounter) IsLikelyNotMountPoint Uses

func (mounter *Mounter) IsLikelyNotMountPoint(file string) (bool, error)

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. It also can not distinguish between mountpoints and symbolic links. mkdir /tmp/a /tmp/b; mount --bind /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 Uses

func (mounter *Mounter) IsMountPointMatch(mp MountPoint, dir string) bool

func (*Mounter) List Uses

func (*Mounter) List() ([]MountPoint, error)

List returns a list of all mounted filesystems.

func (*Mounter) Mount Uses

func (mounter *Mounter) Mount(source string, target string, fstype string, options []string) error

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) Unmount Uses

func (mounter *Mounter) Unmount(target string) error

Unmount unmounts the target.

type SafeFormatAndMount Uses

type SafeFormatAndMount struct {
    Interface
    Exec
}

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 Uses

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 Uses

func (mounter *SafeFormatAndMount) GetDiskFormat(disk string) (string, error)

GetDiskFormat uses 'blkid' to see if the given disk is unformatted

type Subpath Uses

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
}

Package mount imports 15 packages (graph) and is imported by 2257 packages. Updated 2019-07-11. Refresh now. Tools for package owners.