扩展镜像标签

目录

扩展使用镜像标签来提供额外的信息，例如标题、描述、屏幕截图等等。

这些信息会在扩展概述中显示，以便用户选择安装它。

An extension overview, generated from labels

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

重要

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

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

标签必需描述示例
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 扩展管理器版本。它必须遵循 语义化版本控制.特定版本，例如 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.net.cn/assets/images/engine.svg
com.docker.extension.screenshots是一个 JSON 数组，包含图像 URL 和显示给用户（按它们在您的元数据中出现的顺序）的备用文本，位于您的扩展详细信息页面中。**注意：**推荐的屏幕截图尺寸为 2400x1600 像素。[{"alt":"image 1 的备用文本", "url":"https://foo.bar/image1.png"}, {"alt":"image2 的备用文本", "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否一个 JSON 数组，包含显示给用户（按它们在您的元数据中出现的顺序）的标题和附加 URL，位于您的扩展详细信息页面中。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、container-orchestration、cloud-deployment、cloud-development、database、kubernetes、networking、image-registry、security、testing-tools、utility-tools、volumes。如果您没有指定此标签，用户在按类别筛选时将无法在扩展 Marketplace 中找到您的扩展。在 2022 年 9 月 22 日之前发布到 Marketplace 的扩展已由 Docker 自动分类。如果有多个类别，则以逗号分隔的值指定，例如：kubernetes,security 或单个值，例如：kubernetes。

提示

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

在 Marketplace 中预览扩展

您可以验证镜像标签是否按预期呈现。

当您创建并安装未发布的扩展时，您可以在 Marketplace 的“已管理”选项卡中预览扩展。您可以在扩展列表和扩展详细信息页面中查看扩展标签的呈现方式。

预览已在 Marketplace 中列出的扩展

当您安装已在 Marketplace 中发布的扩展的本地镜像（例如带有标签 latest 的镜像）时，您的本地镜像不会被检测为“未发布”。

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

List preview