Skip to content

Removed EOL Flocker plugin reference from plugin documentations.#6804

Open
icemc wants to merge 1 commit intodocker:masterfrom
icemc:update-docs-flocker-plugin
Open

Removed EOL Flocker plugin reference from plugin documentations.#6804
icemc wants to merge 1 commit intodocker:masterfrom
icemc:update-docs-flocker-plugin

Conversation

@icemc
Copy link

@icemc icemc commented Feb 16, 2026

Closes #6783

- What I did
I removed references of the Flocker plugin from the plugin documentations.

- How I did it
Manually check references of this plugin throughout the codebase.

- How to verify it

- Human readable description for the release notes

Removed references of the EOL Flocker plugin from the plugin documentations.

diff --git a/docs/extend/plugin_api.md b/docs/extend/plugin_api.md
index a0b0a7367..bc4b06ee5 100644
--- a/docs/extend/plugin_api.md
+++ b/docs/extend/plugin_api.md
@@ -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`.

 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.
+

 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


diff --git a/docs/extend/plugins_volume.md b/docs/extend/plugins_volume.md
index 8da7deb74..82df2a961 100644
--- a/docs/extend/plugins_volume.md
+++ b/docs/extend/plugins_volume.md
@@ -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`

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

 ### `--volume`
@@ -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`

-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
 

- A picture of a cute animal (not mandatory but encouraged)

Signed-off-by: Ludovic Temgoua Abanda <abandaludovic500@gmail.com>
Copilot AI review requested due to automatic review settings February 16, 2026 21:47
@icemc icemc requested review from a team and thaJeztah as code owners February 16, 2026 21:47
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes references to the deprecated Flocker plugin from Docker plugin documentation in response to issue #6783. The Flocker repository was archived in May 2018 and should no longer be used as an example in current documentation.

Changes:

  • Replaced Flocker-specific examples with generic VolumeDriver examples in plugin API documentation
  • Removed Flocker reference and link from volume plugin command-line examples
  • Updated example socket paths and plugin names throughout affected documentation

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

File Description
docs/extend/plugins_volume.md Replaced Flocker example commands with generic VolumeDriver examples and updated the volume driver section description
docs/extend/plugin_api.md Replaced Flocker socket path examples with generic VolumeDriver socket path examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +48 to +49
For example, a plugin named `VolumeDriver` might create a Unix socket at
`/run/docker/plugins/VolumeDriver.sock`.
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.
Comment on lines +52 to +53
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.
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.
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.

```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 volume create --driver=`VolumeDriver` `VolumeName`

$ 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
$ docker volume create --driver=`VolumeDriver` `VolumeName`

$ 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.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecated project ScatterHQ/Flocker given as example in docs/extend/plugins_volume.md

1 participant