插件 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
mountsPluginMount 数组
插件的挂载，由以下字段组成的结构。看 MOUNTS。
- name细绳
  坐骑的名称。
- description细绳
  安装说明。
- source细绳
  坐骑来源。
- destination细绳
  坐骑的目的地。
- type细绳
  安装类型。
- options字符串数组
  安装选项。
ipchost布尔值
访问主机 ipc 命名空间。
pidhost布尔值
访问主机 PID 命名空间。
propagatedMount细绳
要挂载为 rshared 的路径，以便 Docker 可以看到该路径下的挂载。这对于音量插件很有用。该路径将绑定安装在插件 rootfs 之外，因此其内容在升级时得以保留。
envPluginEnv 数组
插件的环境变量，结构体由以下字段组成：
- 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://docker.github.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": ""
}