docs: use generic myplugin example for plugin documentation
- Removed EOL Flocker plugin reference from plugin documentations. - docs: use generic myplugin example instead of VolumeDriver Co-authored-by: Ludovic Temgoua Abanda <abandaludovic500@gmail.com> Signed-off-by: Ludovic Temgoua Abanda <abandaludovic500@gmail.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
1 parent
4c1e6d67a8
commit
29ed59fe0d
2 files changed
+17
-10
No files matched your search
@@ -21,7 +21,7 @@ which registers itself by placing a file on the daemon host in one of the plugin
|
||||
directories described in [Plugin discovery](#plugin-discovery).
|
||||
|
||||
Plugins have human-readable names, which are short, lowercase strings. For
|
||||
example, `flocker` or `weave`.
|
||||
example, `myplugin`.
|
||||
|
||||
Plugins can run inside or outside containers. Currently running them outside
|
||||
containers is recommended.
|
||||
@@ -45,12 +45,12 @@ spec files can be located either under `/etc/docker/plugins` or `/usr/lib/docker
|
||||
|
||||
The name of the file (excluding the extension) determines the plugin name.
|
||||
|
||||
For example, the `flocker` plugin might create a Unix socket at
|
||||
`/run/docker/plugins/flocker.sock`.
|
||||
For example, a plugin named `myplugin` might create a Unix socket at
|
||||
`/run/docker/plugins/myplugin.sock`.
|
||||
|
||||
You can define each plugin into a separated subdirectory if you want to isolate definitions from each other.
|
||||
For example, you can create the `flocker` socket under `/run/docker/plugins/flocker/flocker.sock` and only
|
||||
mount `/run/docker/plugins/flocker` inside the `flocker` container.
|
||||
For example, you can create the `myplugin` socket under `/run/docker/plugins/myplugin/myplugin.sock` and only
|
||||
mount `/run/docker/plugins/myplugin` inside the `myplugin` container.
|
||||
|
||||
Docker always searches for Unix sockets in `/run/docker/plugins` first. It checks for spec or json files under
|
||||
`/etc/docker/plugins` and `/usr/lib/docker/plugins` if the socket doesn't exist. The directory scan stops as
|
||||
|
||||
@@ -45,7 +45,7 @@ accepts a volume name and path on the host, and the `--volume-driver` flag
|
||||
accepts a driver type.
|
||||
|
||||
```console
|
||||
$ docker volume create --driver=flocker volumename
|
||||
$ docker volume create --driver=myplugin volumename
|
||||
|
||||
$ docker container run -it --volume volumename:/data busybox sh
|
||||
```
|
||||
@@ -61,11 +61,18 @@ separated by a colon (`:`) character.
|
||||
- The `Mountpoint` is the path on the host (v1) or in the plugin (v2) where the
|
||||
volume has been made available.
|
||||
|
||||
### `volumedriver`
|
||||
### `--volume-driver`
|
||||
|
||||
Specifying a `volumedriver` in conjunction with a `volumename` allows you to
|
||||
use plugins such as [Flocker](https://github.com/ScatterHQ/flocker) to manage
|
||||
volumes external to a single host, such as those on EBS.
|
||||
Specifying the `--volume-driver` flag together with a volume name (using
|
||||
`--volume`) allows you to use plugins to manage volumes for the container.
|
||||
|
||||
The `--volume-driver` flag is used as a default for all volumes created for
|
||||
the container, including anonymous volumes. Use the [`--mount`] flag with
|
||||
the [`volume-driver`] option to specify the driver to use for each volume
|
||||
individually.
|
||||
|
||||
[`--mount`]: https://docs.docker.com/reference/cli/docker/container/run/#mount
|
||||
[`volume-driver`]: https://docs.docker.com/engine/storage/volumes/#start-a-container-which-creates-a-volume-using-a-volume-driver
|
||||
|
||||
## Create a VolumeDriver
|
||||
|
||||
|
||||
Reference in new issue
Block a user