From a84e11aaf8bc9c3873393db2da6b1edb7d526acb Mon Sep 17 00:00:00 2001 From: Brian Goff Date: Mon, 7 Mar 2016 15:44:43 -0500 Subject: [PATCH] Allow volume drivers to provide a `Status` field The `Status` field is a `map[string]interface{}` which allows the driver to pass back low-level details about the underlying volume. Signed-off-by: Brian Goff --- docs/extend/plugins_volume.md | 16 ++++++++++++++++ docs/reference/commandline/volume_inspect.md | 5 +++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/extend/plugins_volume.md b/docs/extend/plugins_volume.md index cb1bebf581..88798497c3 100644 --- a/docs/extend/plugins_volume.md +++ b/docs/extend/plugins_volume.md @@ -15,6 +15,21 @@ external storage systems, such as Amazon EBS, and enable data volumes to persist beyond the lifetime of a single Engine host. See the [plugin documentation](plugins.md) for more information. +## Changelog + +### 1.12.0 + +- Add `Status` field to `VolumeDriver.Get` response ([#21006](https://github.com/docker/docker/pull/21006#)) + +### 1.10.0 + +- Add `VolumeDriver.Get` which gets the details about the volume ([#16534](https://github.com/docker/docker/pull/16534)) +- Add `VolumeDriver.List` which lists all volumes owned by the driver ([#16534](https://github.com/docker/docker/pull/16534)) + +### 1.8.0 + +- Initial support for volume driver plugins ([#14659](https://github.com/docker/docker/pull/14659)) + ## Command-line changes A volume plugin makes use of the `-v`and `--volume-driver` flag on the `docker run` command. The `-v` flag accepts a volume name and the `--volume-driver` flag a driver type, for example: @@ -183,6 +198,7 @@ Get the volume info. "Volume": { "Name": "volume_name", "Mountpoint": "/path/to/directory/on/host", + "Status": {} }, "Err": "" } diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index 8fdd34d93b..7359c2b5a4 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -32,7 +32,8 @@ Example output: { "Name": "85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d", "Driver": "local", - "Mountpoint": "/var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data" + "Mountpoint": "/var/lib/docker/volumes/85bffb0677236974f93955d8ecc4df55ef5070117b0e53333cc1b443777be24d/_data", + "Status": null } ] @@ -44,4 +45,4 @@ Example output: * [volume create](volume_create.md) * [volume ls](volume_ls.md) * [volume rm](volume_rm.md) -* [Understand Data Volumes](../../userguide/containers/dockervolumes.md) \ No newline at end of file +* [Understand Data Volumes](../../userguide/containers/dockervolumes.md)