volume

Documentation

Index

• Constants
• func GetPropagation(mode string) string
• func HasPropagation(mode string) bool
• func IsVolumeNameValid(name string) (bool, error)
• func ParseVolumeSource(spec string) (string, string)
• func ParseVolumesFrom(spec string) (string, string, error)
• func ReadWrite(mode string) bool
• func SplitN(raw string, n int) []string
• func ValidMountMode(mode string) bool
• type Driver
• type MountPoint
  • func ParseMountSpec(spec, volumeDriver string) (*MountPoint, error)
  • func (m *MountPoint) BackwardsCompatible() bool
  • func (m *MountPoint) HasResource(absolutePath string) bool
  • func (m *MountPoint) Path() string
  • func (m *MountPoint) Setup() (string, error)
• type Volume

Constants

const DefaultDriverName string = "local"

DefaultDriverName is the driver name used for the driver implemented in the local package.

const DefaultPropagationMode string = "rprivate"

DefaultPropagationMode defines what propagation mode should be used by default if user has not specified one explicitly.

Functions

func GetPropagation

func GetPropagation(mode string) string

GetPropagation extracts and returns the mount propagation mode. If there are no specifications, then by default it is "private".

func HasPropagation

func HasPropagation(mode string) bool

HasPropagation checks if there is a valid propagation mode present in passed string. Returns true if a valid propagatio mode specifier is present, false otherwise.

func IsVolumeNameValid

func IsVolumeNameValid(name string) (bool, error)

IsVolumeNameValid checks a volume name in a platform specific manner.

func ParseVolumeSource

func ParseVolumeSource(spec string) (string, string)

ParseVolumeSource parses the origin sources that's mounted into the container. It returns a name and a source. It looks to see if the spec passed in is an absolute file. If it is, it assumes the spec is a source. If not, it assumes the spec is a name.

func ParseVolumesFrom

func ParseVolumesFrom(spec string) (string, string, error)

ParseVolumesFrom ensure that the supplied volumes-from is valid.

func ReadWrite

func ReadWrite(mode string) bool

ReadWrite tells you if a mode string is a valid read-write mode or not. If there are no specifications w.r.t read write mode, then by default it returs true.

func SplitN

func SplitN(raw string, n int) []string

SplitN splits raw into a maximum of n parts, separated by a separator colon. A separator colon is the last `:` character in the regex `[/:\\]?[a-zA-Z]:` (note `\\` is `\` escaped). This allows to correctly split strings such as `C:\foo:D:\:rw`.

func ValidMountMode

func ValidMountMode(mode string) bool

ValidMountMode will make sure the mount mode is valid. returns if it's a valid mount mode or not.

Types

type Driver

type Driver interface {
	// Name returns the name of the volume driver.
	Name() string
	// Create makes a new volume with the given id.
	Create(name string, opts map[string]string) (Volume, error)
	// Remove deletes the volume.
	Remove(Volume) error
}

Driver is for creating and removing volumes.

type MountPoint

type MountPoint struct {
	Source      string // Container host directory
	Destination string // Inside the container
	RW          bool   // True if writable
	Name        string // Name set by user
	Driver      string // Volume driver to use
	Volume      Volume `json:"-"`

	// Note Mode is not used on Windows
	Mode string `json:"Relabel"` // Originally field was `Relabel`"

	// Note Propagation is not used on Windows
	Propagation string // Mount propagation string
}

MountPoint is the intersection point between a volume and a container. It specifies which volume is to be used and where inside a container it should be mounted.

func ParseMountSpec

func ParseMountSpec(spec, volumeDriver string) (*MountPoint, error)

ParseMountSpec validates the configuration of mount information is valid.

func (*MountPoint) BackwardsCompatible

func (m *MountPoint) BackwardsCompatible() bool

BackwardsCompatible decides whether this mount point can be used in old versions of Docker or not. Only bind mounts and local volumes can be used in old versions of Docker.

func (*MountPoint) HasResource

func (m *MountPoint) HasResource(absolutePath string) bool

HasResource checks whether the given absolute path for a container is in this mount point. If the relative path starts with `../` then the resource is outside of this mount point, but we can't simply check for this prefix because it misses `..` which is also outside of the mount, so check both.

func (*MountPoint) Path

func (m *MountPoint) Path() string

Path returns the path of a volume in a mount point.

func (*MountPoint) Setup

func (m *MountPoint) Setup() (string, error)

Setup sets up a mount point by either mounting the volume if it is configured, or creating the source directory if supplied.

type Volume

type Volume interface {
	// Name returns the name of the volume
	Name() string
	// DriverName returns the name of the driver which owns this volume.
	DriverName() string
	// Path returns the absolute path to the volume.
	Path() string
	// Mount mounts the volume and returns the absolute path to
	// where it can be consumed.
	Mount() (string, error)
	// Unmount unmounts the volume when it is no longer in use.
	Unmount() error
}

Volume is a place to store data. It is backed by a specific driver, and can be mounted.