管理 SDK 配置

什麼是配置?

配置為具有名稱的 SDK 屬性集。這些屬性為鍵/值組合,用於管理 gcloud 指令列工具和其他 SDK 工具的行為。

通常儲存在配置中的屬性包含預設的 Google Compute Engine 區域、細項等級、使用報告、專案 ID,以及使用中的使用者或服務帳戶。配置可允許您以群組一起定義並啟用這些項目和其他設定。

如果您有多重配置,您可以選擇在配置間切換,或是運用 --configuration 標記來使用特定配置執行指令。如要進一步瞭解如何切換配置,請參閱下方啟用配置一節的說明。

如要進一步瞭解指令列 (與可用屬性的完整清單),請執行 gcloud topic configurations

預設配置

SDK 一開始會為您提供名為 default 的單一配置,您可以執行 gcloud init 指令或直接執行 gcloud config set,設定配置中的屬性。

舉例來說,如要停用編寫指令碼的提示,請執行:

gcloud config set disable_prompts true

多重配置

單一 default 配置可適用於許多用途。不過您也可以建立其他配置,並視情況需要,使用 gcloud config configurations activate 進行切換。初始的 default 並無特別之處,它的建立只是為了方便使用。您可以隨意命名這項配置或任何其他配置。

如果您想執行下列事項,多重配置就相當實用:

  • 使用多重專案:您可以為每個專案建立個別配置,並依照需求在其中切換。
  • 使用多重授權帳戶
  • 執行一般獨立工作:例如,您可以在一個專案中針對 Google App Engine 應用程式使用一個配置,並管理其他專案中的不相關 Compute Engine 執行個體。

建立配置

如要建立配置,請執行 gcloud config configurations create

gcloud config configurations create [NAME]

您必須在配置建立後進行啟用才能使用該配置。

啟用配置

多重配置中僅有一個配置會在指定時間內啟用。啟用中的配置即為管理 SDK 工具行為的屬性配置。

如要啟用新配置或切換至新啟用的配置,請執行:gcloud config configurations activate:

gcloud config configurations activate [NAME]

gcloud config list 會一律顯示您所啟用配置的屬性。

如要變更單一指令叫用的使用中配置,可以在任何 gcloud CLI 指令上使用 --configuration 標記:

gcloud auth list --configuration=[CONFIGURATION_NAME]

如要將啟用中的配置在您的目前終端機中變更為適用所有指令,您可以將環境變數 CLOUDSDK_ACTIVE_CONFIG_NAME 設為您想使用的配置名稱。

自動進行配置切換

為了能夠天衣無縫地變更配置,您可以利用 direnvondir 等工具,在您切換工作目錄時自動切換配置。有一種方法可以達成這個目的,那就是在專案根目錄的 .envrc 檔案中設定必要的環境變數 (例如 CLOUDSDK_ACTIVE_CONFIG_NAME)。

列出配置

如要列出 Cloud SDK 安裝內容中的配置,請執行 gcloud config configurations list

gcloud config configurations list

gcloud CLI 會列出所有配置並顯示目前啟用的配置項目:

NAME         IS_ACTIVE     ACCOUNT            PROJECT               DEFAULT_ZONE  DEFAULT_REGION
default      False         user@gmail.com     example-project-1     us-east1-b    us-east1
project-1    False         user@gmail.com     example-project-2     us-east1-c    us-east1
project-2    True          user@gmail.com     example-project-3     us-east1-b    us-east1

設定配置屬性

如要設定及取消設定使用中配置的屬性,請執行 gcloud config setgcloud config unset

gcloud config set project [PROJECT]
gcloud config unset disable_usage_reporting

檢視配置屬性

如要檢視某個配置中的屬性,請執行 gcloud config configurations describe

gcloud config configurations describe [NAME]

如要檢視使用中配置的屬性:

gcloud config list

gcloud CLI 會輸出配置屬性:

is_active: false
name: default
properties:
  compute:
    region: us-east1
    zone: us-east1-b
  core:
    account: user@google.com
    project: example-project

刪除配置

如要刪除配置,請執行 gcloud config configurations delete

gcloud config configurations delete [NAME]

您無法刪除啟用中的配置。在刪除前,如需切換至其他配置,請使用 gcloud config configurations activate

後續步驟

  • 閱讀 SDK 屬性一文,進一步瞭解屬性。