扩展镜像标签
目录
扩展使用镜像标签来提供其他信息,例如标题、描述、屏幕截图等。
然后,此信息将显示为扩展的概述,因此用户可以选择安装它。
重要
如果 中缺少任何必需的标签,则 Docker Desktop 会认为该扩展无效,并且不会在 Marketplace 中列出它。
Dockerfile
以下是您在构建扩展时可以或需要指定的标签列表:
标签 | 必填 | 描述 | 例 |
---|---|---|---|
org.opencontainers.image.title | 是的 | 镜像的人类可读标题 (字符串)。这将显示在 Docker Desktop 的 UI 中。 | my-extension |
org.opencontainers.image.description | 是的 | 镜像中打包的软件的可读描述 (string) | 这个扩展很酷。 |
org.opencontainers.image.vendor | 是的 | 分发实体、组织或个人的名称。 | Acme, Inc. |
com.docker.desktop.extension.api.version | 是的 | 与扩展兼容的 Docker 扩展管理器的版本。它必须遵循语义版本控制。 | 特定版本(如 or)、约束表达式:、 .对于您的第一个扩展,您可以使用 来了解 SDK API 版本并指定 .0.1.0 >= 0.1.0 >= 1.4.7, < 2.0 docker extension version >= <SDK_API_VERSION> |
com.docker.desktop.extension.icon | 是的 | 扩展图标(格式:.svg .png .jpg) | https://docs.docker.com/assets/images/engine.svg |
com.docker.extension.screenshots | 是的 | 在扩展的详细信息页面中向用户显示的镜像 URL 和替代文本的 JSON 数组(按它们在元数据中的显示顺序)。注意:建议的屏幕截图大小为 2400x1600 像素。 | [{"alt":"alternative text for image 1", "url":"https://foo.bar/image1.png"}, {"alt":"alternative text for image2", "url":"https://foo.bar/image2.jpg"}] |
com.docker.extension.detailed-description | 是的 | 有关要在详细信息对话框中显示的扩展的纯文本或 HTML 的其他信息。 | My detailed description 或<h1>My detailed description</h1> |
com.docker.extension.publisher-url | 是的 | 要在详细信息对话框中显示的发布者网站 URL。 | https://foo.bar |
com.docker.extension.additional-urls | 不 | 在扩展的详细信息页面中向用户显示的标题和其他 URL 的 JSON 数组(按它们在元数据中的显示顺序)。Docker 建议您显示以下链接(如果适用):文档、支持、服务条款和隐私策略链接。 | [{"title":"Documentation","url":"https://foo.bar/docs"}, {"title":"Support","url":"https://foo.bar/support"}, {"title":"Terms of Service","url":"https://foo.bar/tos"}, {"title":"Privacy policy","url":"https://foo.bar/privacy-policy"}] |
com.docker.extension.changelog | 是的 | 纯文本或 HTML 形式的更改日志,仅包含当前版本的更改。 | Extension changelog 或<p>Extension changelog<ul> <li>New feature A</li> <li>Bug fix on feature B</li></ul></p> |
com.docker.extension.account-info | 不 | 用户是否需要注册到 SaaS 平台才能使用扩展的某些功能。 | required 如果是这样,请将其留空。 |
com.docker.extension.categories | 不 | 扩展所属的 Marketplace 类别列表:、、、、。如果您未指定此标签,则在按类别筛选时,用户将无法在 Extensions Marketplace 中找到您的扩展。在 2022 年 9 月 22 日之前发布到 Marketplace 的扩展已由 Docker 自动分类。ci-cd container-orchestration cloud-deployment cloud-development database kubernetes networking image-registry security testing-tools utility-tools volumes | 在具有多个类别的情况下指定为逗号分隔值,例如 : 或单个值,例如 .kubernetes,security kubernetes |
提示
Docker Desktop 将 CSS 样式应用于提供的 HTML 内容。您可以确保它在 Marketplace 中正确呈现。建议您遵循样式指南。
在 Marketplace 中预览扩展
您可以验证镜像标签是否按预期呈现。
当您创建和安装未发布的扩展时,您可以在 Marketplace 的 Managed (托管) 选项卡中预览扩展。您可以在扩展的列表和详细信息页面中查看扩展标签的呈现方式。
市场中已列出的预览扩展
当您安装已在 Marketplace 中发布的扩展的本地镜像时(例如,使用标记),您的本地镜像不会被检测为“未发布”。
latest
您可以重新标记镜像,以便使用未列为已发布扩展的不同镜像名称。 使用 ,然后 .
docker tag org/published-extension unpublished-extension
docker extension install unpublished-extension