mount

Documentation

Index

• Constants
• Variables
• func All(mounts []Mount, target string) error
• func CleanupTempMounts(flags int) ([]error, error)
• func SetTempMountLocation(root string) error
• func Unmount(mount string, flags int) error
• func UnmountAll(mount string, flags int) error
• func WithTempMount(ctx context.Context, mounts []Mount, f func(root string) error) (err error)
• type Info
  • func Lookup(dir string) (Info, error)
  • func PID(pid int) ([]Info, error)
  • func Self() ([]Info, error)
• type Mount
  • func (m *Mount) GetParentPaths() ([]string, error)
  • func (m *Mount) Mount(target string) error

Constants

const ParentLayerPathsFlag = "parentLayerPaths="

ParentLayerPathsFlag is the options flag used to represent the JSON encoded list of parent layers required to use the layer

Variables

var (
	// ErrNotImplementOnWindows is returned when an action is not implemented for windows
	ErrNotImplementOnWindows = errors.New("not implemented under windows")
)

Functions

func All

func All(mounts []Mount, target string) error

All mounts all the provided mounts to the provided target

func CleanupTempMounts

func CleanupTempMounts(flags int) ([]error, error)

CleanupTempMounts all temp mounts and remove the directories

func SetTempMountLocation

func SetTempMountLocation(root string) error

SetTempMountLocation sets the temporary mount location

func Unmount

func Unmount(mount string, flags int) error

Unmount the mount at the provided path

func UnmountAll

func UnmountAll(mount string, flags int) error

UnmountAll unmounts from the provided path

func WithTempMount

func WithTempMount(ctx context.Context, mounts []Mount, f func(root string) error) (err error)

WithTempMount mounts the provided mounts to a temp dir, and pass the temp dir to f. The mounts are valid during the call to the f. Finally we will unmount and remove the temp dir regardless of the result of f.

Types

type Info

type Info struct {
	// ID is a unique identifier of the mount (may be reused after umount).
	ID int

	// Parent indicates the ID of the mount parent (or of self for the top of the
	// mount tree).
	Parent int

	// Major indicates one half of the device ID which identifies the device class.
	Major int

	// Minor indicates one half of the device ID which identifies a specific
	// instance of device.
	Minor int

	// Root of the mount within the filesystem.
	Root string

	// Mountpoint indicates the mount point relative to the process's root.
	Mountpoint string

	// Options represents mount-specific options.
	Options string

	// Optional represents optional fields.
	Optional string

	// FSType indicates the type of filesystem, such as EXT3.
	FSType string

	// Source indicates filesystem specific information or "none".
	Source string

	// VFSOptions represents per super block options.
	VFSOptions string
}

Info reveals information about a particular mounted filesystem. This struct is populated from the content in the /proc/<pid>/mountinfo file.

func Lookup

func Lookup(dir string) (Info, error)

Lookup returns the mount info corresponds to the path.

func PID

func PID(pid int) ([]Info, error)

PID collects the mounts for a specific process ID.

func Self

func Self() ([]Info, error)

Self retrieves a list of mounts for the current running process.

type Mount

type Mount struct {
	// Type specifies the host-specific of the mount.
	Type string
	// Source specifies where to mount from. Depending on the host system, this
	// can be a source path or device.
	Source string
	// Options contains zero or more fstab-style mount options. Typically,
	// these are platform specific.
	Options []string
}

Mount is the lingua franca of containerd. A mount represents a serialized mount syscall. Components either emit or consume mounts.

func (*Mount) GetParentPaths

func (m *Mount) GetParentPaths() ([]string, error)

GetParentPaths of the mount

func (*Mount) Mount

func (m *Mount) Mount(target string) error

Mount to the provided target