插件 V2 的插件配置版本 1

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

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

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

配置字段说明

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

description 字符串
插件描述
documentation 字符串
关于该插件的文档链接
interface 插件接口
插件实现的接口，由以下字段组成的结构体：
- 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 插件网络
插件的网络，结构体包含以下字段：
- type 字符串
  网络类型。
  支持的类型：
  - bridge
  - host
  - none
mounts 插件挂载数组
插件挂载的结构，包含以下字段。参见 MOUNTS。
- name 字符串
  挂载点的名称。
- description 字符串
  挂载点描述。
- source 字符串
  挂载源。
- destination 字符串
  挂载的目标位置。
- type 字符串
  挂载类型。
- options 字符串数组
  挂载的选项。
ipchost 布尔值
访问主机 IPC 命名空间。
pidhost 布尔值
访问主机 PID 命名空间。
propagatedMount 字符串
将被挂载为 rshared 的路径，以便 Docker 可以看到该路径下的挂载。这对卷插件非常有用。此路径将在插件 rootfs 之外进行绑定挂载，因此其内容在升级时会得以保留。
env PluginEnv 数组
插件的环境变量，由以下字段组成的结构体：
- name 字符串
  环境变量名称。
- description 字符串
  环境变量描述。
- value 字符串
  环境变量的值。
args 插件参数
插件的参数，由以下字段组成的结构体：
- name 字符串
  参数的名称。
- description 字符串
  参数说明。
- value 字符串数组
  参数的值。
linux 插件Linux
- capabilities 字符串数组
  插件的功能（仅限 Linux），请参见列表 here
- allowAllDevices 布尔值
  如果从主机绑定了 /dev，并且将 allowAllDevices 设置为 true，则该插件将拥有对主机上所有设备的rwm访问权限。
- devices 插件设备数组
  插件的设备（仅限 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.docker.com/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": ""
}