Skip to content

Commit fb893cf

Browse files
committed
docs: add note to volume-plugins
The /var/lib/docker directory is reserved for docker, and should not be touched by plugins. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent db738dd commit fb893cf

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/extend/plugins_volume.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ storage systems, such as Amazon EBS, and enable data volumes to persist beyond
1515
the lifetime of a single Docker host. See the [plugin documentation](plugins.md)
1616
for more information.
1717

18-
# Command-line changes
18+
## Command-line changes
1919

2020
A volume plugin makes use of the `-v`and `--volume-driver` flag on the `docker run` command. The `-v` flag accepts a volume name and the `--volume-driver` flag a driver type, for example:
2121

@@ -32,13 +32,13 @@ server to another.
3232
By specifying a `volumedriver` in conjunction with a `volumename`, users can use plugins such as [Flocker](https://clusterhq.com/docker-plugin/) to manage volumes external to a single host, such as those on EBS.
3333

3434

35-
# Create a VolumeDriver
35+
## Create a VolumeDriver
3636

3737
The container creation endpoint (`/containers/create`) accepts a `VolumeDriver`
3838
field of type `string` allowing to specify the name of the driver. It's default
3939
value of `"local"` (the default driver for local volumes).
4040

41-
# Volume plugin protocol
41+
## Volume plugin protocol
4242

4343
If a plugin registers itself as a `VolumeDriver` when activated, then it is
4444
expected to provide writeable paths on the host filesystem for the Docker
@@ -47,6 +47,10 @@ daemon to provide to containers to consume.
4747
The Docker daemon handles bind-mounting the provided paths into user
4848
containers.
4949

50+
> **Note**: Volume plugins should *not* write data to the `/var/lib/docker/`
51+
> directory, including `/var/lib/docker/volumes`. The `/var/lib/docker/`
52+
> directory is reserved for Docker.
53+
5054
### /VolumeDriver.Create
5155

5256
**Request**:

0 commit comments

Comments
 (0)