package volume

import "github.com/docker/docker/volume"

Index

Constants 

const DefaultDriverName string = "local"

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

const DefaultPropagationMode string = ""

DefaultPropagationMode is used only in linux. In other cases it returns empty string.

Functions

func GetPropagation 

func GetPropagation(mode string) string

GetPropagation is not supported. Return empty string.

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 ParseVolumesFrom 

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

ParseVolumesFrom ensure that the supplied volumes-from is valid.

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(vol Volume) (err error)
	// List lists all the volumes the driver has
	List() ([]Volume, error)
	// Get retreives the volume with the requested name
	Get(name string) (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
	Named       bool   // specifies if the mountpoint was specified by name
}

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 (*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.

Source Files

volume.go volume_propagation_unsupported.go

Directories

PathSynopsis
volume/drivers
volume/localPackage local provides the default implementation for volumes.
volume/store
volume/testutils
Version
v1.10.3-rc1
Published
Mar 8, 2016
Platform
js/wasm
Imports
6 packages
Last checked
25 minutes ago –

Tools for package owners.