summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Goff <cpuguy83@gmail.com>2017-02-10 10:30:11 -0500
committerGitHub <noreply@github.com>2017-02-10 10:30:11 -0500
commit301bfbdd21c7795c41611bf8a8c31a0136b91bde (patch)
tree4de76e9f21d9666beed27fd1d530127a0f6dc453
parentfc438e41713c49bd0be608d087d289769c84802a (diff)
parent5213a0a67ec635a45e640364e8aa9bf5f431625e (diff)
downloaddocker-docs.tar.gz
Merge pull request #27089 from dmandalidis/27029-docsdocs
Update volume options (fixes #27029)
-rw-r--r--docs/reference/api/docker_remote_api_v1.23.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md
index 099dad3e76..f7084a56d7 100644
--- a/docs/reference/api/docker_remote_api_v1.23.md
+++ b/docs/reference/api/docker_remote_api_v1.23.md
@@ -371,11 +371,17 @@ Json Parameters:
`"ExposedPorts": { "<port>/<tcp|udp>: {}" }`
- **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
- **HostConfig**
- - **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
- + `host_path:container_path` to bind-mount a host path into the container
- + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
- + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
- + `volume_name:container_path:ro` to make the bind mount read-only inside the container.
+ - **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
+ - `host_path:container_path[:options]` to bind-mount a host path into the container
+ - `volume_name:container_path[:options]` to bind-mount a volume managed by a volume driver into the container.
+
+ `options` is a comma-delimited list of:
+ - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write.
+ - `[z|Z]` specifies that multiple containers can read and write to the same volume.
+ - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing.
+ - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified.
+ - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`.
+ - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes.
- **Links** - A list of links for the container. Each link entry should be
in the form of `container_name:alias`.
- **Memory** - Memory limit in bytes.