From 93d3cc3101b029041a90465d1d9690a6e0c4f86c Mon Sep 17 00:00:00 2001 From: David Calavera Date: Thu, 21 May 2015 14:46:54 -0700 Subject: [PATCH] Mark volume drivers and plugins as experimental in the documentation. Signed-off-by: David Calavera --- docs/sources/reference/commandline/cli.md | 31 +++++++++++++---------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index e1c9f56ad3..b5171b1b34 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -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: [:]) -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