Skip to content

Commit bb0f763

Browse files
authored
Merge pull request #6804 from icemc/update-docs-flocker-plugin
Removed EOL Flocker plugin reference from plugin documentations.
2 parents 26d4525 + 33790e8 commit bb0f763

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

docs/extend/plugin_api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ which registers itself by placing a file on the daemon host in one of the plugin
2121
directories described in [Plugin discovery](#plugin-discovery).
2222

2323
Plugins have human-readable names, which are short, lowercase strings. For
24-
example, `flocker` or `weave`.
24+
example, `myplugin`.
2525

2626
Plugins can run inside or outside containers. Currently running them outside
2727
containers is recommended.
@@ -45,12 +45,12 @@ spec files can be located either under `/etc/docker/plugins` or `/usr/lib/docker
4545

4646
The name of the file (excluding the extension) determines the plugin name.
4747

48-
For example, the `flocker` plugin might create a Unix socket at
49-
`/run/docker/plugins/flocker.sock`.
48+
For example, a plugin named `myplugin` might create a Unix socket at
49+
`/run/docker/plugins/myplugin.sock`.
5050

5151
You can define each plugin into a separated subdirectory if you want to isolate definitions from each other.
52-
For example, you can create the `flocker` socket under `/run/docker/plugins/flocker/flocker.sock` and only
53-
mount `/run/docker/plugins/flocker` inside the `flocker` container.
52+
For example, you can create the `myplugin` socket under `/run/docker/plugins/myplugin/myplugin.sock` and only
53+
mount `/run/docker/plugins/myplugin` inside the `myplugin` container.
5454

5555
Docker always searches for Unix sockets in `/run/docker/plugins` first. It checks for spec or json files under
5656
`/etc/docker/plugins` and `/usr/lib/docker/plugins` if the socket doesn't exist. The directory scan stops as

docs/extend/plugins_volume.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ accepts a volume name and path on the host, and the `--volume-driver` flag
4545
accepts a driver type.
4646

4747
```console
48-
$ docker volume create --driver=flocker volumename
48+
$ docker volume create --driver=myplugin volumename
4949

5050
$ docker container run -it --volume volumename:/data busybox sh
5151
```
@@ -61,11 +61,18 @@ separated by a colon (`:`) character.
6161
- The `Mountpoint` is the path on the host (v1) or in the plugin (v2) where the
6262
volume has been made available.
6363

64-
### `volumedriver`
64+
### `--volume-driver`
6565

66-
Specifying a `volumedriver` in conjunction with a `volumename` allows you to
67-
use plugins such as [Flocker](https://github.com/ScatterHQ/flocker) to manage
68-
volumes external to a single host, such as those on EBS.
66+
Specifying the `--volume-driver` flag together with a volume name (using
67+
`--volume`) allows you to use plugins to manage volumes for the container.
68+
69+
The `--volume-driver` flag is used as a default for all volumes created for
70+
the container, including anonymous volumes. Use the [`--mount`] flag with
71+
the [`volume-driver`] option to specify the driver to use for each volume
72+
individually.
73+
74+
[`--mount`]: https://docs.docker.com/reference/cli/docker/container/run/#mount
75+
[`volume-driver`]: https://docs.docker.com/engine/storage/volumes/#start-a-container-which-creates-a-volume-using-a-volume-driver
6976

7077
## Create a VolumeDriver
7178

0 commit comments

Comments
 (0)