扩展元数据

metadata.json文件

metadata.json文件是扩展的入口点。它包含扩展的元数据，例如名称、版本和描述。它还包含构建和运行扩展所需的信息。Docker扩展的镜像必须在其文件系统的根目录中包含一个metadata.json文件。

metadata.json文件的格式必须为：

{
    "icon": "extension-icon.svg",
    "ui": ...
    "vm": ...
    "host": ...
}

ui、vm和host部分是可选的，取决于给定扩展提供的功能。它们描述了要安装的扩展内容。

UI部分

ui部分定义一个添加到Docker Desktop仪表盘中的新选项卡。其格式如下：

"ui":{
    "dashboard-tab":
    {
        "title":"MyTitle",
        "root":"/ui",
        "src":"index.html"
    }
}

root指定UI代码在扩展镜像文件系统中的文件夹。src指定应在扩展选项卡中加载的入口点。

将来还将提供其他UI扩展点。

VM部分

vm部分定义一个在Desktop VM中运行的后端服务。它必须定义一个image或一个docker-compose.yaml文件，该文件指定要在Desktop VM中运行的服务。

"vm": {
    "image":"${DESKTOP_PLUGIN_IMAGE}"
},

当使用image时，会为扩展生成一个默认的compose文件。

${DESKTOP_PLUGIN_IMAGE}是一个特殊的关键字，它允许轻松引用打包扩展的镜像。也可以在此处指定任何其他完整的镜像名称。但是，在许多情况下，使用相同的镜像可以简化扩展开发。

"vm": {
    "composefile": "docker-compose.yaml"
},

例如，包含卷定义的Compose文件如下所示：

services:
  myExtension:
    image: ${DESKTOP_PLUGIN_IMAGE}
    volumes:
      - /host/path:/container/path

主机部分

host部分定义Docker Desktop复制到主机的可执行文件。

  "host": {
    "binaries": [
      {
        "darwin": [
          {
            "path": "/darwin/myBinary"
          },
        ],
        "windows": [
          {
            "path": "/windows/myBinary.exe"
          },
        ],
        "linux": [
          {
            "path": "/linux/myBinary"
          },
        ]
      }
    ]
  }

binaries定义Docker Desktop从扩展镜像复制到主机的二进制文件列表。

path指定镜像文件系统中的二进制文件路径。Docker Desktop负责将其文件复制到其自己的位置，并且JavaScript API允许调用这些二进制文件。

了解如何调用可执行文件。