diff options
author | Sebastiaan van Stijn <github@gone.nl> | 2016-09-15 15:43:26 +0200 |
---|---|---|
committer | Sebastiaan van Stijn <github@gone.nl> | 2016-09-20 17:41:59 +0200 |
commit | 708892c4037e9eef6f6c25b5a3551f7779fb8868 (patch) | |
tree | 32b112d9e5c959523be4efc6a13eb3c9a3ef1641 | |
parent | beea098b97a160f027bd33f1afeaed30724b98af (diff) | |
download | docker-708892c4037e9eef6f6c25b5a3551f7779fb8868.tar.gz |
Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.18.md | 11 | ||||
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.19.md | 11 | ||||
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.20.md | 11 | ||||
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.21.md | 16 | ||||
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.22.md | 15 | ||||
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.23.md | 15 | ||||
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.24.md | 15 | ||||
-rw-r--r-- | docs/reference/api/docker_remote_api_v1.25.md | 15 |
8 files changed, 76 insertions, 33 deletions
diff --git a/docs/reference/api/docker_remote_api_v1.18.md b/docs/reference/api/docker_remote_api_v1.18.md index ed801b49c5..7eb188c619 100644 --- a/docs/reference/api/docker_remote_api_v1.18.md +++ b/docs/reference/api/docker_remote_api_v1.18.md @@ -230,10 +230,13 @@ Create a container - **ExposedPorts** - An object mapping ports to an empty object in the form of: `"ExposedPorts": { "<port>/<tcp|udp>: {}" }` - **HostConfig** - - **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms: - + `container_path` to create a new volume for the container - + `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. + - **Binds** – A list of bind-mounts for this container. Each item is a string in one of these forms: + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. - **Links** - A list of links for the container. Each link entry should be in the form of `container_name:alias`. - **LxcConf** - LXC specific configurations. These configurations only diff --git a/docs/reference/api/docker_remote_api_v1.19.md b/docs/reference/api/docker_remote_api_v1.19.md index 5e35fb1a65..adaaf09aef 100644 --- a/docs/reference/api/docker_remote_api_v1.19.md +++ b/docs/reference/api/docker_remote_api_v1.19.md @@ -235,10 +235,13 @@ Create a container - **ExposedPorts** - An object mapping ports to an empty object in the form of: `"ExposedPorts": { "<port>/<tcp|udp>: {}" }` - **HostConfig** - - **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms: - + `container_path` to create a new volume for the container - + `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. + - **Binds** – A list of bind-mounts for this container. Each item is a string in one of these forms: + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. - **Links** - A list of links for the container. Each link entry should be in the form of `container_name:alias`. - **LxcConf** - LXC specific configurations. These configurations only diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md index 664fe1eca6..d87aeadeb8 100644 --- a/docs/reference/api/docker_remote_api_v1.20.md +++ b/docs/reference/api/docker_remote_api_v1.20.md @@ -237,10 +237,13 @@ Create a container - **ExposedPorts** - An object mapping ports to an empty object in the form of: `"ExposedPorts": { "<port>/<tcp|udp>: {}" }` - **HostConfig** - - **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms: - + `container_path` to create a new volume for the container - + `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. + - **Binds** – A list of bind-mounts for this container. Each item is a string in one of these forms: + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. - **Links** - A list of links for the container. Each link entry should be in the form of `container_name:alias`. - **LxcConf** - LXC specific configurations. These configurations only diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index e5c566354b..f7cafed5b1 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -248,11 +248,17 @@ Create a container - **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: - + `container_path` to create a new volume for the container - + `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. + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. + + `volume-name:container-dest` to bind-mount a volume managed by a + volume driver into the container. `container-dest` must be an + _absolute_ path. + + `volume-name:container-dest:ro` to mount the volume read-only + inside the container. `container-dest` must be an _absolute_ path. - **Links** - A list of links for the container. Each link entry should be in the form of `container_name:alias`. - **LxcConf** - LXC specific configurations. These configurations only diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md index aede0104ed..60f325b1b6 100644 --- a/docs/reference/api/docker_remote_api_v1.22.md +++ b/docs/reference/api/docker_remote_api_v1.22.md @@ -351,10 +351,17 @@ Create a container - **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. + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. + + `volume-name:container-dest` to bind-mount a volume managed by a + volume driver into the container. `container-dest` must be an + _absolute_ path. + + `volume-name:container-dest:ro` to mount the volume read-only + inside the container. `container-dest` must be an _absolute_ path. - **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. diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md index c1d7a76f84..5d29e2fd85 100644 --- a/docs/reference/api/docker_remote_api_v1.23.md +++ b/docs/reference/api/docker_remote_api_v1.23.md @@ -374,10 +374,17 @@ Create a container - **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. + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. + + `volume-name:container-dest` to bind-mount a volume managed by a + volume driver into the container. `container-dest` must be an + _absolute_ path. + + `volume-name:container-dest:ro` to mount the volume read-only + inside the container. `container-dest` must be an _absolute_ path. - **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. diff --git a/docs/reference/api/docker_remote_api_v1.24.md b/docs/reference/api/docker_remote_api_v1.24.md index aa47a8fb21..ec7f93eee6 100644 --- a/docs/reference/api/docker_remote_api_v1.24.md +++ b/docs/reference/api/docker_remote_api_v1.24.md @@ -391,10 +391,17 @@ Create a container - **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. + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. + + `volume-name:container-dest` to bind-mount a volume managed by a + volume driver into the container. `container-dest` must be an + _absolute_ path. + + `volume-name:container-dest:ro` to mount the volume read-only + inside the container. `container-dest` must be an _absolute_ path. - **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. diff --git a/docs/reference/api/docker_remote_api_v1.25.md b/docs/reference/api/docker_remote_api_v1.25.md index 1cfd2d24f9..41eff1a29b 100644 --- a/docs/reference/api/docker_remote_api_v1.25.md +++ b/docs/reference/api/docker_remote_api_v1.25.md @@ -395,10 +395,17 @@ Create a container - **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. + + `host-src:container-dest` to bind-mount a host path into the + container. Both `host-src`, and `container-dest` must be an + _absolute_ path. + + `host-src:container-dest:ro` to make the bind-mount read-only + inside the container. Both `host-src`, and `container-dest` must be + an _absolute_ path. + + `volume-name:container-dest` to bind-mount a volume managed by a + volume driver into the container. `container-dest` must be an + _absolute_ path. + + `volume-name:container-dest:ro` to mount the volume read-only + inside the container. `container-dest` must be an _absolute_ path. - **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. |