4.8 KiB

Raw Blame History

volume create

Create a volume

Options

Name	Type	Default	Description
`--availability`	`string`	`active`	Cluster Volume availability (`active`, `pause`, `drain`)
`-d`, `--driver`	`string`	`local`	Specify volume driver name
`--group`	`string`		Cluster Volume group (cluster volumes)
`--label`	`list`		Set metadata for a volume
`--limit-bytes`	`bytes`	`0`	Minimum size of the Cluster Volume in bytes
`-o`, `--opt`	`map`	`map[]`	Set driver specific options
`--required-bytes`	`bytes`	`0`	Maximum size of the Cluster Volume in bytes
`--scope`	`string`	`single`	Cluster Volume access scope (`single`, `multi`)
`--secret`	`map`	`map[]`	Cluster Volume secrets
`--sharing`	`string`	`none`	Cluster Volume access sharing (`none`, `readonly`, `onewriter`, `all`)
`--topology-preferred`	`list`		A topology that the Cluster Volume would be preferred in
`--topology-required`	`list`		A topology that the Cluster Volume must be accessible from
`--type`	`string`	`block`	Cluster Volume access type (`mount`, `block`)

Description

Creates a new volume that containers can consume and store data in. If a name is not specified, Docker generates a random name.

Examples

Create a volume and then configure the container to use it:

$ docker volume create hello

hello

$ docker run -d -v hello:/world busybox ls /world

The mount is created inside the container's /world directory. Docker does not support relative paths for mount points inside the container.

Multiple containers can use the same volume in the same time period. This is useful if two containers need access to shared data. For example, if one container writes and the other reads the data.

Volume names must be unique among drivers. This means you cannot use the same volume name with two different drivers. If you attempt this docker returns an error:

A volume named  "hello"  already exists with the "some-other" driver. Choose a different volume name.

If you specify a volume name already in use on the current driver, Docker assumes you want to re-use the existing volume and does not return an error.

Driver-specific options (-o, --opt)

Some volume drivers may take options to customize the volume creation. Use the -o or --opt flags to pass driver options:

$ docker volume create --driver fake \
    --opt tardis=blue \
    --opt timey=wimey \
    foo

These options are passed directly to the volume driver. Options for different volume drivers may do different things (or nothing at all).

The built-in local driver on Windows does not support any options.

The built-in local driver on Linux accepts options similar to the linux mount command. You can provide multiple options by passing the --opt flag multiple times. Some mount options (such as the o option) can take a comma-separated list of options. Complete list of available mount options can be found here.

For example, the following creates a tmpfs volume called foo with a size of 100 megabyte and uid of 1000.

$ docker volume create --driver local \
    --opt type=tmpfs \
    --opt device=tmpfs \
    --opt o=size=100m,uid=1000 \
    foo

Another example that uses btrfs:

$ docker volume create --driver local \
    --opt type=btrfs \
    --opt device=/dev/sda2 \
    foo

Another example that uses nfs to mount the /path/to/dir in rw mode from 192.168.1.1:

$ docker volume create --driver local \
    --opt type=nfs \
    --opt o=addr=192.168.1.1,rw \
    --opt device=:/path/to/dir \
    foo

4.8 KiB Raw Blame History