Skip to content

Removed EOL Flocker plugin reference from plugin documentations. #6804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
icemc wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −10
Open

Removed EOL Flocker plugin reference from plugin documentations. #6804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/extend/plugin_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,13 @@ 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 `VolumeDriver` might create a Unix socket at
`/run/docker/plugins/VolumeDriver.sock`.
Comment on lines +48 to +49
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The replacement uses VolumeDriver as the plugin name in the example, but this is inconsistent with documentation conventions. Line 24 in this same file (not changed in this PR) states "Plugins have human-readable names, which are short, lowercase strings." The example should use a lowercase name like "myplugin" instead of "VolumeDriver" to match this convention and other examples in the codebase (e.g., "flocker", "weave", "rclone").

Copilot uses AI. Check for mistakes.

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 `VolumeDriver` socket under `/run/docker/plugins/VolumeDriver/VolumeDriver.sock` and only
mount `/run/docker/plugins/VolumeDriver` inside the `VolumeDriver` container.
Comment on lines +52 to +53
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The replacement uses VolumeDriver as the plugin name in the example, but this is inconsistent with documentation conventions. Line 24 in this same file (not changed in this PR) states "Plugins have human-readable names, which are short, lowercase strings." The example should use a lowercase name like "myplugin" instead of "VolumeDriver" to match this convention and other examples in the codebase (e.g., "flocker", "weave", "rclone").

Copilot uses AI. Check for mistakes.


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
Expand Down
10 changes: 4 additions & 6 deletions docs/extend/plugins_volume.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ 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=`VolumeDriver` `VolumeName`
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backticks should not be used inside console code blocks. The backticks around VolumeDriver and VolumeName will be rendered literally in the console output, which is incorrect. Console examples elsewhere in the documentation (e.g., docs/extend/_index.md, docs/extend/plugins_services.md, docs/extend/EBS_volume.md) show actual concrete values without backticks in console code blocks. Use a concrete example like "myplugin" for the driver name and "myvolume" for the volume name instead.

Copilot uses AI. Check for mistakes.

$ docker container run -it --volume volumename:/data busybox sh
$ docker container run -it --volume `VolumeName`:/data busybox sh
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backticks should not be used inside console code blocks. The backticks around VolumeName will be rendered literally in the console output, which is incorrect. Console examples elsewhere in the documentation show actual concrete values without backticks in console code blocks. Use a concrete example like "myvolume" instead.

Copilot uses AI. Check for mistakes.
Comment on lines +48 to +50
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The replacement examples use generic placeholder-style names (VolumeDriver, VolumeName) which are inconsistent with documentation conventions seen throughout the codebase. Other documentation examples (e.g., docs/extend/EBS_volume.md, docs/extend/_index.md, docs/extend/plugins_services.md) use concrete, realistic plugin names like "tiborvass/rexray-plugin", "rclone", "tiborvass/sample-volume-plugin", etc., with lowercase volume names like "my-ebs-volume", "rclonevolume", "samplevol", "pluginVol". Consider using a concrete example like "myplugin" for the driver and "myvolume" for the volume name to match these conventions.

Copilot uses AI. Check for mistakes.
```

### `--volume`
Expand All @@ -61,11 +61,9 @@ 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`
### `VolumeDriver`
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section heading was changed from volumedriver to VolumeDriver, but this is inconsistent with the sibling section heading ### --volume which uses the actual command-line parameter format. The original volumedriver appears to be referring to the --volume-driver flag mentioned in line 42. Consider using ### --volume-driver to maintain consistency with the ### --volume section heading format.

Suggested change
### `VolumeDriver`
### `--volume-driver`

Copilot uses AI. Check for mistakes.

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 a `VolumeDriver` in conjunction with a `VolumeName` allows you to use plugins to manage volumes.

## Create a VolumeDriver

Expand Down
Loading