在 Cloud Code for IntelliJ 中使用 Secret Manager 管理密鑰

透過 Cloud Code 的 Secret Manager 整合功能,您可以在 IDE 中建立、查看、更新及使用密鑰,不必將密鑰放在程式碼庫中。

本頁面說明如何在 IDE 中存取 Secret Manager,以及如何開始建立及管理密鑰。

啟用 Secret Manager

使用 Cloud Code 管理密鑰時,密鑰會安全地儲存在 Secret Manager 中,並可在需要時以程式輔助方式擷取。您只需要啟用 Secret Manager API,並具備管理密鑰的適當權限:

  1. 如要啟動 Secret Manager,請按一下右側 Cloud Code 側欄中的「Secret Manager」分頁標籤。

    右側邊欄中醒目顯示 Cloud Code 的 Secret Manager 分頁,且 Secret Manager 面板已開啟,列出三個密鑰,底部窗格中則列出密鑰「test」的版本詳細資料

  2. 如果您尚未啟用 Secret Manager API,Cloud Code 會提示您在 Secret Manager 面板中啟用,只要按一下「啟用 API」即可。

    密鑰也必須與應用程式程式碼位於同一個專案中;請確認您已選取正確的專案,或使用 Secret Manager 面板中的專案選取器切換專案。

    啟用 Secret Manager 面板中的 API 連結

建立及查看密鑰

建立密鑰

您可以使用下列任一方法建立密鑰:

使用 Secret Manager 面板

  1. 前往 Secret Manager 面板。

  2. 按一下「新增」圖示。

    系統會開啟「建立密鑰」對話方塊,您可以在其中設定密鑰的專案、名稱和值,以及選擇儲存密鑰的區域和用於整理密鑰的標籤。

    「建立密鑰」對話方塊開啟,並填入「名稱」欄位 (「life」) 和「密鑰值」欄位 (「42」)

使用編輯器

  1. 在編輯器中開啟要儲存為密鑰的文字檔案。
  2. 選取這段文字並按一下滑鼠右鍵。

    從選單中選取 Create Secret in Secret Manager... 選單項目。 系統會開啟「建立密鑰」對話方塊,並以醒目顯示的文字填入密鑰值。您可以在這裡自訂密鑰的專案、名稱、值、區域和標籤。

使用專案探索工具

  1. 在專案檔案總管中,不要醒目顯示任何文字,然後按一下滑鼠右鍵。
  2. 從選單中選取 Create Secret in Secret Manager... 選單項目。 系統會開啟「建立密鑰」對話方塊。在此選擇密鑰的專案、名稱、值、區域和標籤,然後按一下「確定」

建立新的密鑰版本

如要更新現有密鑰,請前往 Secret Manager 面板的「版本」分頁:

  1. 按一下「版本」分頁中的「新增」圖示。

    這時會啟動「新增版本」對話方塊,您可以使用「密鑰值」欄位或匯入檔案,設定現有密鑰的值。

    開啟「新增版本」對話方塊,並將密鑰「test-secret」的「密鑰值」欄位更新為「bar」

  2. 如要移除所有舊版密鑰,只保留新建立的版本,請選擇「停用所有舊版」

  3. 按一下「確定」新增版本後,您會看到最新的密鑰版本,以及「版本」分頁下方列出的所有密鑰版本 (如有)。

查看密鑰

如要查看密鑰,請在 Secret Manager 面板中,從「Secret Name」(密鑰名稱) 專區顯示的清單選取密鑰。「總覽」分頁會列出詳細資料,例如名稱、複製政策、建立時間戳記和資源 ID。

您也可以對密碼按一下滑鼠右鍵,然後選擇「Open in Cloud console」(在 Cloud 控制台中開啟),在瀏覽器中查看及管理密碼。

查看密鑰版本

如要查看密鑰版本,請從「Secret Name」(密鑰名稱) 專區顯示的清單中選取密鑰,然後選取「Versions」(版本) 分頁。

在要執行的密鑰版本上按一下滑鼠右鍵,然後從可用選項中選擇:查看密鑰值、複製版本 ID、啟用或停用版本,以及刪除所選版本。

已選取密鑰「test」的「版本」分頁,並以表格列出兩個可用版本「2」和「3」及其建立時間。在「3」上按一下滑鼠右鍵,然後選取「啟用密鑰版本」

從應用程式存取密鑰

建立密鑰後,您可以在程式碼中加入密鑰,並設定驗證。

Secret Manager 面板的「程式碼」分頁,列出在程式碼中存取密鑰所需的步驟

如要從應用程式存取新建立的密鑰,請按照下列步驟操作:

  1. 安裝 Secret Manager 用戶端程式庫。

    依序前往「Tools」 >「Cloud Code」 >「Add Cloud Libraries and Manage Cloud APIs」,然後從 Google Cloud API 探索工具樹狀結構中選取「Secret Manager」 >「Secret Manager API」。請按照「安裝用戶端程式庫」一節中列出的特定語言操作說明進行操作。

  2. 自訂並在應用程式的程式碼中加入相關程式碼片段

  3. 最後,如要完成驗證設定,請按照用戶端程式庫驗證指南操作:

    • 本機開發:如果您是在本機叢集 (例如 minikube、Docker Desktop) 或本機模擬器上開發,請完成本機開發部分中與工作流程相關的步驟。
    • 遠端開發:如果您在應用程式中使用 GKE 叢集或 Cloud Run 服務,請完成遠端開發部分中與工作流程相關的步驟,包括在服務帳戶中設定必要角色的 Secret Manager 專屬操作說明。

取得支援

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