扩展镜像标签

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

这些信息将作为扩展的概述显示,以便用户选择安装它。

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://example.com/assets/image.svg
com.docker.extension.screenshots一个 JSON 数组,包含图像 URL 和显示给用户的替代文本(按它们在元数据中出现的顺序)在您的扩展详情页面中。注意:建议的屏幕截图大小为 2400x1600 像素。[{"alt":"图像 1 的替代文本", "url":"https://example.com/image1.png"}, {"alt":"图像 2 的替代文本", "url":"https://example.com/image2.jpg"}]
com.docker.extension.detailed-description有关扩展的额外信息,以纯文本或 HTML 格式显示在详细信息对话框中。我的详细描述<h1>我的详细描述</h1>
com.docker.extension.publisher-url要在详细信息对话框中显示的发布者网站 URL。https://example.com
com.docker.extension.additional-urls一个 JSON 数组,包含标题和显示给用户的额外 URL(按它们在元数据中出现的顺序)在您的扩展详情页面中。Docker 建议您显示以下链接(如果适用):文档、支持、服务条款和隐私政策链接。[{"title":"文档","url":"https://example.com/docs"}, {"title":"支持","url":"https://example.com/bar/support"}, {"title":"服务条款","url":"https://example.com/tos"}, {"title":"隐私政策","url":"https://example.com/privacy"}]
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-cdcontainer-orchestrationcloud-deploymentcloud-developmentdatabasekubernetesnetworkingimage-registrysecuritytesting-toolsutility-toolsvolumes。如果您未指定此标签,用户在按类别筛选时将无法在扩展 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
© . This site is unofficial and not affiliated with Kubernetes or Docker Inc.