擴充套件映象標籤

目錄

擴充套件使用映象標籤來提供額外的資訊，例如標題、描述、螢幕截圖等等。

這些資訊會在擴充套件概述中顯示，以便使用者選擇安裝它。

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.tw/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