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> 的值。值的两部分由冒号 (:) 字符分隔。

  • 卷名称是卷的人类可读名称，不能以 / 字符开头。在本主题的其余部分中，它称为 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 是请求挂载的调用方的唯一 ID。

响应

  • v1

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

  • v2

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

Mountpoint 是卷在主机 (v1) 或插件 (v2) 中可用的路径。

Err 为空或包含错误字符串。

/VolumeDriver.Path

请求

{
    "Name": "volume_name"
}

请求给定 volume_name 的卷路径。

响应

  • v1

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

  • v2

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

返回卷在主机 (v1) 或插件 (v2) 中可用的路径，并且/或者如果发生错误，则返回字符串错误。

Mountpoint 是可选的。但是，如果未提供，插件可能稍后会被再次查询。

/VolumeDriver.Unmount

请求

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

Docker 不再使用命名卷。每次容器停止时调用 Unmount。插件可以推断此时可以安全地解除卷的预配。

ID 是请求挂载的调用方的唯一 ID。

响应

{
    "Err": ""
}

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

/VolumeDriver.Get

请求

{
    "Name": "volume_name"
}

获取有关 volume_name 的信息。

响应

  • v1

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

  • v2

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

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

/VolumeDriver.List

请求

{}

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

响应

  • v1

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

  • v2

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

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

/VolumeDriver.Capabilities

请求

{}

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

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

响应

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

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

页面选项