快速入門

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

先決條件

• Docker Desktop
• NodeJS
• Go

  **注意**

  僅當您按照快速入門指南建立擴充功能時，才需要 NodeJS 和 Go。它使用 `docker extension init` 命令自動產生樣板檔案。此命令使用基於 ReactJS 和 Go 應用程式的範本。

  在 Docker Desktop 設定中，請確認您可以安裝您正在開發的擴充功能。您可能需要瀏覽至 Docker Desktop 設定中的 **擴充功能** 索引標籤，並取消選取 **僅允許透過 Docker 市集發佈的擴充功能**。

  步驟一：設定您的目錄

  若要設定您的目錄，請使用 `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 儀表板中。您可以在 **設定** 中變更此設定，如需詳細資訊，請參閱如何顯示擴充功能容器。

  步驟四：提交您的擴充功能並將其發佈到市集

  如果您想讓所有 Docker Desktop 使用者都能使用您的擴充功能，您可以將其提交到市集中發佈。如需詳細資訊，請參閱發佈。

  清理

  若要移除擴充功能，請執行

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

  後續步驟

  • 為您的擴充功能建置更進階的前端。
  • 瞭解如何測試和除錯您的擴充功能。
  • 瞭解如何為您的擴充功能設定 CI。
  • 瞭解更多關於擴充功能架構的資訊。
  • 瞭解更多關於設計 UI的資訊。