Docker 卷插件

Docker Engine 卷插件使 Engine 部署能够与外部存储系统（如 Amazon EBS）集成，并使数据卷能够在单个 Docker 主机的生命周期之外持久化。有关更多信息，请参阅插件文档。

更新日志

1.13.0

如果作为v2插件架构的一部分使用，插件返回的路径中的挂载点必须挂载在插件配置中由PropagatedMount指定的目录下 ( #26398)

1.12.0

向VolumeDriver.Get响应中添加Status字段 ( #21006)
添加 VolumeDriver.Capabilities 以获取卷驱动器的功能 ( #22077)

1.10.0

添加 VolumeDriver.Get 以获取卷的详细信息 ( #16534)
添加 VolumeDriver.List，用于列出驱动程序拥有的所有卷 ( #16534)

1.8.0

初始支持卷驱动插件 ( #14659)

命令行更改

为了让容器访问卷，请在docker container run命令中使用--volume和--volume-driver标志。--volume（或-v）标志接受主机上的卷名称和路径，而--volume-driver标志接受驱动程序类型。

$ docker volume create --driver=flocker volumename

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

`--volume`

--volume（或-v）标志接受一个格式为:的值。该值的两部分由冒号（:）字符分隔。

卷名称是卷的人类可读名称，不能以/字符开头。在本主题的其余部分中，它被称为volume_name。
Mountpoint 是主机（v1）或插件（v2）上卷可用的路径。

`volumedriver`

指定volumedriver与volumename结合使用，允许您使用插件如 Flocker来管理单个主机外部的卷，例如EBS上的卷。

创建一个VolumeDriver

容器创建端点（/containers/create）接受一个类型为string的VolumeDriver字段，允许指定驱动程序的名称。如果未指定，则默认为"local"（本地卷的默认驱动程序）。

卷插件协议

如果一个插件在激活时将自己注册为VolumeDriver，它必须向Docker守护进程提供主机文件系统上的可写路径。Docker守护进程将这些路径提供给容器使用。Docker守护进程通过将提供的路径绑定挂载到容器中，使卷可用。

注意
卷插件不应将数据写入/var/lib/docker/目录，包括/var/lib/docker/volumes。/var/lib/docker/目录是为Docker保留的。

`/VolumeDriver.Create`

请求：

{
    "Name": "volume_name",
    "Opts": {}
}

指示插件用户希望创建一个卷，给定用户指定的卷名。插件不需要立即在文件系统上实际创建卷（直到调用Mount）。Opts是从用户请求传递过来的驱动程序特定选项的映射。

响应：

{
    "Err": ""
}

如果发生错误，返回一个字符串错误。

`/VolumeDriver.Remove`

请求：

{
    "Name": "volume_name"
}

从磁盘中删除指定的卷。当用户调用 docker rm -v 来移除与容器关联的卷时，会发出此请求。

响应：

{
    "Err": ""
}

如果发生错误，返回一个字符串错误。

`/VolumeDriver.Mount`

请求：

{
    "Name": "volume_name",
    "ID": "b87d7442095999a92b65b3d9691e697b61713829cc0ffd1bb72e4ccd51aa4d6c"
}

Docker 要求插件在用户指定卷名的情况下提供一个卷。Mount 在每次容器启动时被调用一次。如果同一个 volume_name 被多次请求，插件可能需要跟踪每个新的挂载请求，并在第一次挂载请求时进行配置，并在最后一次相应的卸载请求时进行取消配置。

ID 是请求挂载的调用者的唯一标识符。

响应：

{
    "Mountpoint": "/path/to/directory/on/host",
    "Err": ""
}

{
    "Mountpoint": "/path/under/PropagatedMount",
    "Err": ""
}

Mountpoint 是主机（v1）或插件（v2）上卷可用的路径。

Err 要么为空，要么包含一个错误字符串。

`/VolumeDriver.Path`

请求：

{
    "Name": "volume_name"
}

请求具有给定volume_name的卷的路径。

响应：

{
    "Mountpoint": "/path/to/directory/on/host",
    "Err": ""
}

{
    "Mountpoint": "/path/under/PropagatedMount",
    "Err": ""
}

响应主机（v1）或插件内部（v2）上卷已可用的路径，和/或如果发生错误则返回错误字符串。

Mountpoint 是可选的。但是，如果没有提供，插件可能会在以后再次被查询。

`/VolumeDriver.Unmount`

请求：

{
    "Name": "volume_name",
    "ID": "b87d7442095999a92b65b3d9691e697b61713829cc0ffd1bb72e4ccd51aa4d6c"
}

Docker 不再使用命名卷。Unmount 在每次容器停止时调用一次。插件可以推断此时可以安全地取消配置该卷。

ID 是请求挂载的调用者的唯一标识符。

响应：

{
    "Err": ""
}

如果发生错误，返回一个字符串错误。

`/VolumeDriver.Get`

请求：

{
    "Name": "volume_name"
}

获取关于volume_name的信息。

响应：

{
  "Volume": {
    "Name": "volume_name",
    "Mountpoint": "/path/to/directory/on/host",
    "Status": {}
  },
  "Err": ""
}

{
  "Volume": {
    "Name": "volume_name",
    "Mountpoint": "/path/under/PropagatedMount",
    "Status": {}
  },
  "Err": ""
}

如果发生错误，请返回一个字符串错误。Mountpoint 和 Status 是可选的。

/VolumeDriver.List

请求：

{}

获取已注册到插件的卷列表。

响应：

{
  "Volumes": [
    {
      "Name": "volume_name",
      "Mountpoint": "/path/to/directory/on/host"
    }
  ],
  "Err": ""
}

{
  "Volumes": [
    {
      "Name": "volume_name",
      "Mountpoint": "/path/under/PropagatedMount"
    }
  ],
  "Err": ""
}

如果发生错误，返回一个字符串错误。Mountpoint 是可选的。

/VolumeDriver.Capabilities

请求：

{}

获取驱动程序支持的功能列表。

驱动程序不需要实现Capabilities。如果未实现，则使用默认值。

响应：

{
  "Capabilities": {
    "Scope": "global"
  }
}

支持的范围是global和local。Scope中的任何其他值将被忽略，并使用local。Scope允许集群管理器以不同的方式处理卷。例如，global的范围向集群管理器发出信号，表示它只需要创建一次卷，而不是在每个Docker主机上创建。未来可能会添加更多功能。