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 ¶

• Constants
• func GetDeviceNameFromMount(mounter Interface, mountPath string) (string, int, error)
• func GetMountRefs(mounter Interface, mountPath string) ([]string, error)
• func IsNotMountPoint(mounter Interface, file string) (bool, error)
• type FakeAction
• type FakeMounter
• func (f *FakeMounter) DeviceOpened(pathname string) (bool, error)
• func (f *FakeMounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, 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) 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 Interface
• func New(mounterPath string) Interface
• type MountPoint
• type Mounter
• func (mounter *Mounter) DeviceOpened(pathname string) (bool, error)
• func (mounter *Mounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, 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 *Mounter) List() ([]MountPoint, 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 NsenterMounter
• func NewNsenterMounter() *NsenterMounter
• func (*NsenterMounter) DeviceOpened(pathname string) (bool, error)
• func (*NsenterMounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, error)
• func (*NsenterMounter) IsLikelyNotMountPoint(file string) (bool, error)
• func (*NsenterMounter) IsMountPointMatch(mp MountPoint, dir string) bool
• func (m *NsenterMounter) IsNotMountPoint(dir string) (bool, error)
• func (*NsenterMounter) List() ([]MountPoint, error)
• func (*NsenterMounter) Mount(source string, target string, fstype string, options []string) error
• func (*NsenterMounter) PathIsDevice(pathname string) (bool, error)
• func (*NsenterMounter) Unmount(target string) error
• type SafeFormatAndMount
• func (mounter *SafeFormatAndMount) FormatAndMount(source string, target string, fstype string, options []string) error

Constants ¶

const FakeActionMount = "mount"

Values for FakeAction.Action

const FakeActionUnmount = "unmount"

const (
	MountsInGlobalPDPath = "mounts"
)

Functions ¶

func GetDeviceNameFromMount ¶

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 GetMountRefs ¶

func GetMountRefs(mounter Interface, mountPath string) ([]string, error)

GetMountRefs finds all other references to the device referenced by mountPath; returns a list of paths.

func IsNotMountPoint ¶

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. This method uses the List() of all mountpoints It is more extensive than IsLikelyNotMountPoint and it detects bind mounts in linux

Types ¶

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 FakeMounter ¶

type FakeMounter struct {
	MountPoints []MountPoint
	Log         []FakeAction
	// contains filtered or unexported fields
}

FakeMounter implements mount.Interface for tests.

func (*FakeMounter) DeviceOpened ¶

func (f *FakeMounter) DeviceOpened(pathname string) (bool, error)

func (*FakeMounter) GetDeviceNameFromMount ¶

func (f *FakeMounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, error)

func (*FakeMounter) IsLikelyNotMountPoint ¶

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

func (*FakeMounter) IsMountPointMatch ¶

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

func (*FakeMounter) IsNotMountPoint ¶

func (f *FakeMounter) IsNotMountPoint(dir string) (bool, error)

func (*FakeMounter) List ¶

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

func (*FakeMounter) Mount ¶

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

func (*FakeMounter) PathIsDevice ¶

func (f *FakeMounter) PathIsDevice(pathname string) (bool, error)

func (*FakeMounter) ResetLog ¶

func (f *FakeMounter) ResetLog()

func (*FakeMounter) Unmount ¶

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

func New ¶

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 ¶

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.

type Mounter ¶

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

func (*Mounter) DeviceOpened ¶

func (mounter *Mounter) DeviceOpened(pathname string) (bool, error)

func (*Mounter) GetDeviceNameFromMount ¶

func (mounter *Mounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, error)

func (*Mounter) IsLikelyNotMountPoint ¶

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

func (*Mounter) IsMountPointMatch ¶

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

func (*Mounter) IsNotMountPoint ¶

func (mounter *Mounter) IsNotMountPoint(dir string) (bool, error)

func (*Mounter) List ¶

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

func (*Mounter) Mount ¶

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

func (*Mounter) PathIsDevice ¶

func (mounter *Mounter) PathIsDevice(pathname string) (bool, error)

func (*Mounter) Unmount ¶

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

type NsenterMounter ¶

type NsenterMounter struct{}

func NewNsenterMounter ¶

func NewNsenterMounter() *NsenterMounter

func (*NsenterMounter) DeviceOpened ¶

func (*NsenterMounter) DeviceOpened(pathname string) (bool, error)

func (*NsenterMounter) GetDeviceNameFromMount ¶

func (*NsenterMounter) GetDeviceNameFromMount(mountPath, pluginDir string) (string, error)

func (*NsenterMounter) IsLikelyNotMountPoint ¶

func (*NsenterMounter) IsLikelyNotMountPoint(file string) (bool, error)

func (*NsenterMounter) IsMountPointMatch ¶

func (*NsenterMounter) IsMountPointMatch(mp MountPoint, dir string) bool

func (*NsenterMounter) IsNotMountPoint ¶

func (m *NsenterMounter) IsNotMountPoint(dir string) (bool, error)

func (*NsenterMounter) List ¶

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

func (*NsenterMounter) Mount ¶

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

func (*NsenterMounter) PathIsDevice ¶

func (*NsenterMounter) PathIsDevice(pathname string) (bool, error)

func (*NsenterMounter) Unmount ¶

func (*NsenterMounter) Unmount(target string) error

type SafeFormatAndMount ¶

type SafeFormatAndMount struct {
	Interface
	Runner exec.Interface
}

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 fake.go mount.go mount_unsupported.go nsenter_mount_unsupported.go