docker: github.com/docker/docker/api/types/mount Index | Files

package mount

import "github.com/docker/docker/api/types/mount"

Index

Package Files

mount.go

Variables

var Propagations = []Propagation{
    PropagationRPrivate,
    PropagationPrivate,
    PropagationRShared,
    PropagationShared,
    PropagationRSlave,
    PropagationSlave,
}

Propagations is the list of all valid mount propagations

type BindOptions Uses

type BindOptions struct {
    Propagation  Propagation `json:",omitempty"`
    NonRecursive bool        `json:",omitempty"`
}

BindOptions defines options specific to mounts of type "bind".

type Consistency Uses

type Consistency string

Consistency represents the consistency requirements of a mount.

const (
    // ConsistencyFull guarantees bind mount-like consistency
    ConsistencyFull Consistency = "consistent"
    // ConsistencyCached mounts can cache read data and FS structure
    ConsistencyCached Consistency = "cached"
    // ConsistencyDelegated mounts can cache read and written data and structure
    ConsistencyDelegated Consistency = "delegated"
    // ConsistencyDefault provides "consistent" behavior unless overridden
    ConsistencyDefault Consistency = "default"
)

type Driver Uses

type Driver struct {
    Name    string            `json:",omitempty"`
    Options map[string]string `json:",omitempty"`
}

Driver represents a volume driver.

type Mount Uses

type Mount struct {
    Type Type `json:",omitempty"`
    // Source specifies the name of the mount. Depending on mount type, this
    // may be a volume name or a host path, or even ignored.
    // Source is not supported for tmpfs (must be an empty value)
    Source      string      `json:",omitempty"`
    Target      string      `json:",omitempty"`
    ReadOnly    bool        `json:",omitempty"`
    Consistency Consistency `json:",omitempty"`

    BindOptions   *BindOptions   `json:",omitempty"`
    VolumeOptions *VolumeOptions `json:",omitempty"`
    TmpfsOptions  *TmpfsOptions  `json:",omitempty"`
}

Mount represents a mount (volume).

type Propagation Uses

type Propagation string

Propagation represents the propagation of a mount.

const (
    // PropagationRPrivate RPRIVATE
    PropagationRPrivate Propagation = "rprivate"
    // PropagationPrivate PRIVATE
    PropagationPrivate Propagation = "private"
    // PropagationRShared RSHARED
    PropagationRShared Propagation = "rshared"
    // PropagationShared SHARED
    PropagationShared Propagation = "shared"
    // PropagationRSlave RSLAVE
    PropagationRSlave Propagation = "rslave"
    // PropagationSlave SLAVE
    PropagationSlave Propagation = "slave"
)

type TmpfsOptions Uses

type TmpfsOptions struct {
    // Size sets the size of the tmpfs, in bytes.
    //
    // This will be converted to an operating system specific value
    // depending on the host. For example, on linux, it will be converted to
    // use a 'k', 'm' or 'g' syntax. BSD, though not widely supported with
    // docker, uses a straight byte value.
    //
    // Percentages are not supported.
    SizeBytes int64 `json:",omitempty"`
    // Mode of the tmpfs upon creation
    Mode os.FileMode `json:",omitempty"`
}

TmpfsOptions defines options specific to mounts of type "tmpfs".

type Type Uses

type Type string

Type represents the type of a mount.

const (
    // TypeBind is the type for mounting host dir
    TypeBind Type = "bind"
    // TypeVolume is the type for remote storage volumes
    TypeVolume Type = "volume"
    // TypeTmpfs is the type for mounting tmpfs
    TypeTmpfs Type = "tmpfs"
    // TypeNamedPipe is the type for mounting Windows named pipes
    TypeNamedPipe Type = "npipe"
)

Type constants

type VolumeOptions Uses

type VolumeOptions struct {
    NoCopy       bool              `json:",omitempty"`
    Labels       map[string]string `json:",omitempty"`
    DriverConfig *Driver           `json:",omitempty"`
}

VolumeOptions represents the options for a mount of type volume.

Package mount imports 1 packages (graph) and is imported by 1225 packages. Updated 2019-10-24. Refresh now. Tools for package owners.