擴充套件映象標籤
目錄
擴充套件使用映象標籤來提供額外資訊,如標題、描述、螢幕截圖等。
這些資訊將作為擴充套件的概述顯示,以便使用者選擇安裝它。

您可以在擴充套件的 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-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。
