快速入門

按照本指南開始建立基本的 Docker 擴充套件。快速入門指南會自動為您生成樣板檔案。

先決條件

注意

只有在您按照快速入門指南建立擴充套件時才需要 NodeJS 和 Go。它使用 docker extension init 命令自動生成樣板檔案。該命令使用基於 ReactJS 和 Go 應用程式的模板。

在 Docker Desktop 設定中,確保您可以安裝您正在開發的擴充套件。您可能需要導航到 Docker Desktop 設定中的“擴充套件”選項卡,然後取消選中“僅允許透過 Docker Marketplace 分發的擴充套件”。

步驟一:設定您的目錄

要設定您的目錄,請使用 init 子命令併為您的擴充套件提供一個名稱。

$ docker extension init <my-extension>

該命令會詢問您有關您的擴充套件的一系列問題,例如它的名稱、描述和您的 Hub 程式碼庫的名稱。這有助於 CLI 為您生成一組樣板檔案以開始使用。它將樣板檔案儲存在 my-extension 目錄中。

自動生成的擴充套件包含

  • backend 資料夾中的 Go 後端服務,該服務偵聽套接字。它有一個端點 /hello,它返回一個 JSON 有效負載。
  • frontend 資料夾中的 React 前端,它可以呼叫後端並輸出後端的響應。

有關構建 UI 的更多資訊和指南,請參閱 設計和 UI 樣式部分

步驟二:構建擴充套件

要構建擴充套件,請移動到新建立的目錄並執行

$ docker build -t <name-of-your-extension> .

docker build 會構建擴充套件並生成一個與所選 Hub 程式碼庫同名的映象。例如,如果您將 john/my-extension 作為以下問題的答案鍵入

? Hub repository (eg. namespace/repository on hub): john/my-extension`

docker build 會生成一個名為 john/my-extension 的映象。

步驟三:安裝和預覽擴充套件

要在 Docker Desktop 中安裝擴充套件,請執行

$ docker extension install <name-of-your-extension>

要在 Docker Desktop 中預覽擴充套件,請在安裝完成後,您應該在“擴充套件”選單下看到一個“快速入門”專案。選擇該專案將開啟擴充套件的前端。

提示

在 UI 開發過程中,使用熱過載來測試您的更改而不重新構建整個擴充套件非常有用。有關更多資訊,請參閱 開發 UI 時的預覽

您可能還想檢查屬於擴充套件的容器。預設情況下,擴充套件容器會從 Docker 儀表板中隱藏。您可以在“設定”中更改此設定,有關更多資訊,請參閱 如何顯示擴充套件容器

步驟四:將您的擴充套件提交併釋出到 Marketplace

如果您希望讓所有 Docker Desktop 使用者可以使用您的擴充套件,您可以將其提交到 Marketplace 以供釋出。有關更多資訊,請參閱 釋出

清理

要刪除擴充套件,請執行

$ docker extension rm <name-of-your-extension>

下一步