插件 V2 的插件配置版本 1

本文档概述了 V0 插件配置的格式。

插件配置描述了 Docker 引擎插件的各种组成部分。插件配置可以使用以下媒体类型序列化为 JSON 格式

配置类型	媒体类型
配置	`application/vnd.docker.plugin.v1+json`

配置字段描述

配置提供了在注册表中处理 V0 插件格式的基本可访问字段。

description 字符串
插件的描述
documentation 字符串
指向插件文档的链接
interface PluginInterface
插件实现的接口，由以下字段组成的结构体
- types 字符串数组
  类型表示插件当前实现的接口。
  支持的类型
  - docker.volumedriver/1.0
  - docker.networkdriver/1.0
  - docker.ipamdriver/1.0
  - docker.authz/1.0
  - docker.logdriver/1.0
  - docker.metricscollector/1.0
- socket 字符串
  Socket 是引擎用于与插件通信的套接字名称。套接字将在 /run/docker/plugins 中创建。
entrypoint 字符串数组
插件的入口点，请参阅 ENTRYPOINT
workdir 字符串
插件的工作目录，请参阅 WORKDIR
network PluginNetwork
插件的网络，由以下字段组成的结构体
- type 字符串
  网络类型。
  支持的类型
  - bridge
  - host
  - none
mounts PluginMount 数组
插件的挂载，由以下字段组成的结构体。请参阅 MOUNTS。
- name 字符串
  挂载的名称。
- description 字符串
  挂载的描述。
- source 字符串
  挂载的源。
- destination 字符串
  挂载的目标。
- type 字符串
  挂载类型。
- options 字符串数组
  挂载的选项。
ipchost 布尔值
访问主机 IPC 命名空间。
pidhost 布尔值
访问主机 PID 命名空间。
propagatedMount 字符串
要作为 rshared 挂载的路径，以便该路径下的挂载对 Docker 可见。这对于卷插件很有用。此路径将绑定挂载到插件根文件系统之外，因此其内容在升级时将保留。
env PluginEnv 数组
插件的环境变量，由以下字段组成的结构体
- name 字符串
  环境变量的名称。
- description 字符串
  环境变量的描述。
- value 字符串
  环境变量的值。
args PluginArgs
插件的参数，由以下字段组成的结构体
- name 字符串
  参数的名称。
- description 字符串
  参数的描述。
- value 字符串数组
  参数的值。
linux PluginLinux
- capabilities 字符串数组
  插件的功能（仅限 Linux），请参阅此处的列表
- allowAllDevices 布尔值
  如果 /dev 从主机绑定挂载，并且 allowAllDevices 设置为 true，则插件将拥有对主机上所有设备的 rwm 访问权限。
- devices PluginDevice 数组
  插件的设备（仅限 Linux），由以下字段组成的结构体。请参阅 DEVICES。
  - name 字符串
    设备的名称。
  - description 字符串
    设备的描述。
  - path 字符串
    设备的路径。

配置示例

以下示例展示了“tiborvass/sample-volume-plugin”插件配置。

{
  "Args": {
    "Description": "",
    "Name": "",
    "Settable": null,
    "Value": null
  },
  "Description": "A sample volume plugin for Docker",
  "Documentation": "https://docs.container.net.cn/engine/extend/plugins/",
  "Entrypoint": [
    "/usr/bin/sample-volume-plugin",
    "/data"
  ],
  "Env": [
    {
      "Description": "",
      "Name": "DEBUG",
      "Settable": [
        "value"
      ],
      "Value": "0"
    }
  ],
  "Interface": {
    "Socket": "plugin.sock",
    "Types": [
      "docker.volumedriver/1.0"
    ]
  },
  "Linux": {
    "Capabilities": null,
    "AllowAllDevices": false,
    "Devices": null
  },
  "Mounts": null,
  "Network": {
    "Type": ""
  },
  "PropagatedMount": "/data",
  "User": {},
  "Workdir": ""
}