扩展镜像标签

扩展使用镜像标签来提供其他信息,例如标题、描述、屏幕截图等等。

然后,此信息将显示为扩展的概述,以便用户可以选择安装它。

An extension overview, generated from labels

您可以在扩展的Dockerfile中定义镜像标签

重要

如果Dockerfile中缺少任何必需标签,Docker Desktop 会将扩展视为无效,并且不会将其列在市场中。

以下是构建扩展时可以或需要指定的标签列表

标签必需描述示例
org.opencontainers.image.title镜像的人类可读标题(字符串)。这显示在 Docker Desktop 的 UI 中。my-extension
org.opencontainers.image.description镜像中打包的软件的人类可读描述(字符串)此扩展很酷。
org.opencontainers.image.vendor分发实体、组织或个人的名称。Acme, Inc.
com.docker.desktop.extension.api.version扩展兼容的 Docker Extension 管理器的版本。它必须遵循语义版本控制具体的版本,例如0.1.0,或者约束表达式:>= 0.1.0>= 1.4.7, < 2.0。对于您的第一个扩展,您可以使用docker extension version来了解 SDK API 版本并指定>= <SDK_API_VERSION>
com.docker.desktop.extension.icon扩展图标(格式:.svg .png .jpg)https://docs.docker.top/assets/images/engine.svg
com.docker.extension.screenshots图像 URL 的 JSON 数组和在扩展的详细信息页面中显示给用户的替代文本(按它们在元数据中出现的顺序)。注意:建议的屏幕截图大小为 2400x1600 像素。[{"alt":"图像 1 的替代文本", "url":"https://foo.bar/image1.png"}, {"alt":"图像 2 的替代文本", "url":"https://foo.bar/image2.jpg"}]
com.docker.extension.detailed-description关于扩展的附加信息,以纯文本或 HTML 格式显示在详细信息对话框中。我的详细描述<h1>我的详细描述</h1>
com.docker.extension.publisher-url在详细信息对话框中显示的发布者网站 URL。https://foo.bar
com.docker.extension.additional-urls在扩展的详细信息页面中显示给用户的标题和附加 URL 的 JSON 数组(按它们在元数据中出现的顺序)。Docker 建议您显示以下链接(如果适用):文档、支持、服务条款和隐私策略链接。[{"title":"文档","url":"https://foo.bar/docs"}, {"title":"支持","url":"https://foo.bar/support"}, {"title":"服务条款","url":"https://foo.bar/tos"}, {"title":"隐私策略","url":"https://foo.bar/privacy-policy"}]
com.docker.extension.changelog以纯文本或 HTML 格式显示的更改日志,仅包含当前版本的更改。扩展更改日志<p>扩展更改日志<ul> <li>新功能 A</li> <li>修复功能 B 的错误</li></ul></p>
com.docker.extension.account-info用户是否需要注册到 SaaS 平台才能使用扩展的某些功能。如果需要,则为required,否则留空。
com.docker.extension.categories您的扩展程序所属的 Marketplace 类别列表:ci-cd容器编排云部署云开发数据库Kubernetes网络镜像注册表安全测试工具实用工具。如果您未指定此标签,则用户在按类别筛选时将无法在扩展程序 Marketplace 中找到您的扩展程序。在 2022 年 9 月 22 日之前发布到 Marketplace 的扩展程序已由 Docker 自动分类。如果有多个类别,则指定为逗号分隔的值,例如:kubernetes,security 或单个值,例如:kubernetes

提示

Docker Desktop 会将 CSS 样式应用于提供的 HTML 内容。您可以确保它在Marketplace 中正确渲染。建议您遵循样式指南

在市场上预览扩展

您可以验证镜像标签是否按预期渲染。

创建和安装未发布的扩展程序后,您可以在 Marketplace 的已管理选项卡中预览扩展程序。您可以查看扩展程序列表和扩展程序详细信息页面中扩展程序标签的渲染方式。

预览已列在 Marketplace 中的扩展程序

当您安装已发布到 Marketplace 的扩展程序的本地镜像(例如带有标签latest)时,您的本地镜像不会被检测为“未发布”。

您可以重新标记您的镜像,以获得不同的镜像名称,该名称未列为已发布的扩展程序。使用docker tag org/published-extension unpublished-extension,然后docker extension install unpublished-extension

List preview