扩展元数据
目录
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 允许调用这些二进制文件。
了解如何 调用可执行文件。