Mark volume drivers and plugins as experimental in the documentation.

Signed-off-by: David Calavera <david.calavera@gmail.com>
This commit is contained in:
David Calavera 2015-05-21 14:46:54 -07:00
parent 3bf0ca31cf
commit a867c1b70a
5 changed files with 25 additions and 20 deletions

View file

@ -73,11 +73,11 @@ are now returned as boolean instead of as an int.
In addition, the end point now returns the new boolean fields
`CpuCfsPeriod`, `CpuCfsQuota`, and `OomKillDisable`.
**New!**
**New in the Experimental channel!**
You can now specify a volume plugin in `/v1.19/containers/create`, for example
`"HostConfig": {"Binds": ["flocker/name:/data"]}` where `flocker` is the name
of the plugin, `name` is the user-facing name of the volume (passed to the
`"VolumeDriver": "flocker", "HostConfig": {"Binds": ["vol-1:/data"]}` where `flocker` is the name
of the plugin, `vol-1` is the user-facing name of the volume (passed to the
volume plugin) and `/data` is the mountpoint inside the container.
## v1.18

View file

@ -15,6 +15,8 @@ page_keywords: API, Docker, rcli, REST, documentation
`STDIN` and `STDERR`.
- When the client API version is newer than the daemon's an HTTP
`400 Bad Request` error message is returned.
- Options marked as *Experimental* are only available using Docker
from the Experimental channel.
# 2. Endpoints
@ -223,7 +225,7 @@ Json Parameters:
container
- **ExposedPorts** - An object mapping ports to an empty object in the form of:
`"ExposedPorts": { "<port>/<tcp|udp>: {}" }`
- **VolumeDriver** - A string value containing the volume driver to use, `local` by default.
- **VolumeDriver** - *(Experimental)* A string value containing the volume driver to use, `local` by default.
- **HostConfig**
- **Binds** A list of volume bindings for this container. Each volume
binding is a string of the form `container_path` (to create a new

View file

@ -1001,7 +1001,7 @@ Creates a new container.
-t, --tty=false Allocate a pseudo-TTY
-u, --user="" Username or UID
-v, --volume=[] Bind mount a volume, or specify name for volume plugin
--volume-driver= Optional volume driver (plugin name) for the container
--volume-driver= Optional volume driver (plugin name) for the container (Experimental)
--volumes-from=[] Mount volumes from the specified container(s)
-w, --workdir="" Working directory inside the container
@ -1972,7 +1972,7 @@ To remove an image using its digest:
-t, --tty=false Allocate a pseudo-TTY
-u, --user="" Username or UID (format: <name|uid>[:<group|gid>])
-v, --volume=[] Bind mount a volume, or specify name for volume plugin
--volume-driver= Optional volume driver (plugin name) for the container
--volume-driver= Optional volume driver (plugin name) for the container (Experimental)
--volumes-from=[] Mount volumes from the specified container(s)
-w, --workdir="" Working directory inside the container
@ -2068,18 +2068,6 @@ binary (such as that provided by [https://get.docker.com](
https://get.docker.com)), you give the container the full access to create and
manipulate the host's Docker daemon.
$ docker run -ti -v volumename:/data --volume-driver=flocker busybox sh
By specifying a volume name in conjunction with a volume driver, volume plugins
such as [Flocker](https://clusterhq.com/docker-plugin/), once installed, can be
used to manage volumes external to a single host, such as those on EBS. In this
example, "volumename" is passed through to the volume plugin as a user-given
name for the volume which allows the plugin to associate it with an external
volume beyond the lifetime of a single container or container host. This can be
used, for example, to move a stateful container from one server to another.
The `volumename` must not begin with a `/`.
$ docker run -p 127.0.0.1:80:8080 ubuntu bash
This binds port `8080` of the container to port `80` on `127.0.0.1` of
@ -2285,6 +2273,21 @@ application change:
`--rm` option means that when the container exits, the container's layer is
removed.
*Experimental*:
$ docker run -ti -v volumename:/data --volume-driver=flocker busybox sh
By specifying a volume name in conjunction with a volume driver, volume plugins
such as [Flocker](https://clusterhq.com/docker-plugin/), once installed, can be
used to manage volumes external to a single host, such as those on EBS. In this
example, "volumename" is passed through to the volume plugin as a user-given
name for the volume which allows the plugin to associate it with an external
volume beyond the lifetime of a single container or container host. This can be
used, for example, to move a stateful container from one server to another.
The `volumename` must not begin with a `/`.
#### Restart policies
Use Docker's `--restart` to specify a container's *restart policy*. A restart

View file

@ -210,7 +210,7 @@ Then un-tar the backup file in the new container's data volume.
You can use the techniques above to automate backup, migration and
restore testing using your preferred tools.
## Integrating Docker with external storage systems
## (Experimental) Integrating Docker with external storage systems
Docker volume plugins such as [Flocker](https://clusterhq.com/docker-plugin/)
enable Docker deployments to be integrated with external storage systems, such

View file

@ -105,7 +105,7 @@ works with Docker can now transparently scale up to multiple hosts.
Go to [Docker Swarm user guide](/swarm/).
## Docker Plugins
## (Experimental) Docker Plugins
Docker plugins allow you to extend the capabilities of the Docker Engine.