在 Cloud Code for IntelliJ 中使用現有應用程式

如果您已經使用 Kubernetes 資訊清單、Dockerfile 或 Jib 設定了現有專案,以便建構映像檔,則可以開啟該專案並搭配外掛程式一起使用。您只需要額外設定 Skaffold YAML 檔案即可 (系統可以為您自動產生該檔案,您也可以利用系統提供的範本建立該檔案)。

設定 Skaffold YAML 後,請務必指定容器映像檔的儲存位置,也就是即將推送的專案映像檔。

專案的自動開機載入功能

您的專案必須有一或多個 Kubernetes 資訊清單。如果 Cloud Code 偵測到專案中存在「任何」Kubernetes 資訊清單,就會嘗試啟動。

如果 Cloud Code 未偵測到現有的 Skaffold 設定,系統會提示您設定。

事前準備

您的專案必須符合下列先決條件,才能收到建立 skaffold.yaml 檔案和執行任何必要設定的提示:

  • (選項 1) 專案含有 Dockerfile,且已針對 Jib 進行設定,或

  • (選項 2) 您的專案可使用 Buildpack 建構,且具有 Kubernetes 資源。

設定 Kubernetes 執行設定

如果符合前置條件,Cloud Code 會透過通知提示您建立 skaffold.yaml 檔案 (如果尚未建立) 和任何必要的執行設定:

通知,內含建立 Cloud Code Kubernetes 執行設定的連結

  1. 按一下通知。系統會視情況自動建立設定。

    如果系統偵測到多個映像檔或建構工具,無法自動建立 Skaffold 設定,Cloud Code 會顯示對話方塊,要求您提供偵測到的映像檔和建構工具之間的對應項目。

    指定在 Skaffold 設定中使用的建構設定

    您也可以依序前往「Tools」 >「Cloud Code」 >「Kubernetes」,然後選取「Add Kubernetes Support」,設定 Skaffold 設定。

    這個選項會分析專案的 Kubernetes 資源,並產生 skaffold.yaml 檔案 (如果尚未存在) 以及必要的執行設定。系統產生的兩個執行設定包括:一個用於在 Kubernetes 上執行專案,另一個則用於在 Kubernetes 叢集中進行開發。

  2. 新增支援後,您就可以使用新增的執行設定,開始在 Kubernetes 上執行專案及進行偵錯。

手動建立 Cloud Code Skaffold 設定

您可以選擇手動建立新的 skaffold.yaml 檔案,或將現有檔案新增至專案。

如要使用線上範本手動建立 skaffold.yaml 檔案,請按照下列步驟操作:

  1. 在專案的根目錄中建立名為 skaffold.yaml 的新檔案,方法如下:以滑鼠右鍵按一下專案,然後依序點選「New」>「File」

  2. 將游標放在新檔案中,按下 Ctrl+Space 即可顯示線上範本建議,然後選擇所需的 Skaffold 範本。

    使用 Skaffold YAML 範本

  3. 在「image」欄位中填入專案映像檔名稱,在「manifests」欄位中填入您要從 IDE 部署的 Kubernetes 資源清單。

  4. Cloud Code 判斷 skaffold.yaml 檔案有效後,請按一下提示訊息,建立 Kubernetes 執行設定。

    建立 Kubernetes 執行目標通知

Cloud Code Skaffold 設定範例

  • 以 Dockerfile 為基礎的建構項目:

    build:
      artifacts:
        - image: image_name
    deploy:
      kubectl:
        manifests:
          - k8s/web.yaml
          - k8s/backend.yaml
    
  • 使用 Jib 外掛程式的 Java Maven/Gradle 專案範例建構區段 (部署區段與上述範例相同):

    build:
    artifacts:
    - image: image_name
      jib: {}
    
  • 如果您想為不同情境定義建構、測試和部署設定,可以使用不同的設定檔。以下是 Cloud Build 設定檔範例,可設定 Cloud Code 使用 Cloud Build 建構映像檔:

    profiles:
    # use the cloudbuild profile to build images using Google Cloud Build
    - name: cloudbuild
      build:
        googleCloudBuild: {}
    
  • 如要透過 Helm 部署專案,請參閱 Helm 說明文件

指定容器映像檔的儲存位置

儲存容器映像檔

在部署應用程式之前,您必須定義要與專案搭配使用的預設圖片存放區。

根據預設,專案會設定為使用 Kubernetes 資訊清單中指定的映像檔名稱。您也可以自訂圖片規格。偏好的存放區 (Artifact RegistryDockerHub 或私人存放區) 設定完成後,請編輯執行設定,並在執行設定中將其指定為預設映像檔存放區。

設定方式如下:在頂端工作列的「Run/Debug configurations」對話方塊中,依序點選「Edit Configurations」 >「Develop on Kubernetes」 >「Image repository」

執行設定中的預設映像檔存放區會以「gcr.io/」格式設定,並根據目前的專案和有效叢集顯示自動完成選項

如要進一步瞭解如何指定容器映像檔偏好設定,請參閱設定容器映像檔指南

建構設定

設定容器映像檔後,您可以設定其建構設定。Cloud Code 支援 Docker、Jib 和 Buildpacks 構件類型。

您可以在「Run」設定的「Build / Deploy」分頁 (「Edit Configurations」 >「Develop on Kubernetes」) 中,為預設設定檔設定建構設定。

在「Build/Deploy」分頁中顯示的建構設定

如要進一步瞭解如何指定映像檔的建構設定,請參閱「設定容器映像檔建構偏好設定指南」。

後續步驟

取得支援

如要在 IntelliJ IDE 中提交意見回饋或回報問題,請依序前往「Tools」 >「Cloud Code」 >「Help / About」 >「Submit feedback or report an issue」,然後在 GitHub 上回報問題。