卷插件(引擎) | Volume plugins (Engine)
卷插件
编写卷插件
Docker Engine卷插件使引擎部署能够与Amazon EBS等外部存储系统集成,并使数据卷在单个Docker主机的生命周期之后持续存在。有关更多信息,请参阅插件文档。
更新日志
1.13.0
- 如果用作v2插件体系结构的一部分,则作为插件返回路径一部分的挂载点必须安装在
PropagatedMount
插件配置(#26398)指定的目录下1.12.0
- 将
Status
字段添加到VolumeDriver.Get
响应(#21006)
- 添加
VolumeDriver.Capabilities
以获得卷驱动程序的功能(#22077)
1.10.0
- 添加
VolumeDriver.Get
获取有关卷的详细信息(#16534)
- 添加
VolumeDriver.List
列出驱动程序拥有的所有卷(#16534)
1.8.0
- 对卷驱动程序插件的初始支持(#14659)
- 卷名称是卷的可读的名称,不能以
/
性格。它被称为volume_name
在本主题的其余部分。
Mountpoint
是主机(v1)或插件(v2)中卷的可用路径。
volumedriver
通过volumedriver
与volumename
联合指定,您可以使用插件(如Flocker)来管理单个主机(例如EBS上的那些主机)的外部卷。
创建一个VolumeDriver
容器创建endpoint(/containers/create
)接受允许指定驱动程序名称的VolumeDriver
类型字段string
。如果未指定,则默认为"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
: { "Mountpoin": "/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
Request
:
{}
获取插件注册的卷列表。
响应:
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主机上创建卷。未来可能会增加更多功能。