管理 gdcloud CLI 設定

設定為 Distributed Cloud CLI 屬性的命名集。這些屬性是鍵/值組合,以區段形式整理,用於管理 gdcloud CLI 的行為。

設定中通常會儲存的屬性包括機構控制台網址和專案 ID。您可以透過設定,一併定義及啟用這些和其他設定。

設定會儲存在使用者設定目錄中,通常是 macOS 和 Linux 上的 ~/.config/gdcloud。另請注意,設定目錄必須啟用寫入功能。

如果您有多個設定,可以選擇切換設定,也可以使用 --configuration 旗標,透過特定設定執行指令。如要進一步瞭解如何切換設定,請參閱「啟用設定」一節。

如要從指令列讀取設定,並查看可用屬性的完整清單和所屬區段,請執行 gdcloud topic configurations

預設設定

gdcloud CLI 最初會建立名為 default 的單一設定。您可以執行 gdcloud init 指令或直接執行 gdcloud config set,在設定中設定屬性。

多重配置

單一 default 設定適用於許多用途。不過,您也可以建立其他設定並視需求在兩者間切換,方法是使用 gdcloud config configurations activate。系統會建立初始default設定,方便您使用,但並非必要。您可以視需要為這項設定和其他設定命名。

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

  • 使用多重專案:您可以為每個專案建立個別配置,並依照需求在其中切換。
  • 使用多個機構控制台網址
  • 執行一般獨立工作:例如,您可以在一個專案中針對服務 A 使用一個配置,並管理其他專案中的不相關服務 B。

建立設定

如要建立設定,請執行下列指令:

gdcloud config configurations create NAME

建立新設定後,您必須啟用才能使用。

啟用設定

多重配置中僅有一個配置會在指定時間內啟用。有效設定是指屬性會控管 gdcloud CLI 行為的設定。

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

gdcloud config configurations activate NAME

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

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

gdcloud auth print-identity-token --configuration=CONFIGURATION

列出設定

如要列出 gdcloud CLI 中的設定,請執行:

gdcloud config configurations list

gdcloud CLI 會列出所有設定,並顯示目前啟用的設定:

NAME                ISACTIVE   PROPERTIES.CORE.PROJECT PROPERTIES.CORE.ORGANIZATIONCONSOLEURL
default             False      example-project-default https://console.default-org.example.com
config-project-1    False      example-project-1       https://console.org-1.example.com
config-project-2    False      example-project-2       https://console.org-2.example.com

設定配置屬性

如要設定及取消設定使用中設定的屬性,請執行下列指令:

gdcloud config set project PROJECT

檢視配置屬性

如要檢視某個配置中的屬性,請執行:

gdcloud config configurations describe NAME

gdcloud CLI 會輸出配置屬性:

is_active: false
name: default
properties:
  accessibility:
    screen_reader: "false"
  auth:
    login_config_cert_path: /tmp/root-web-tls-ca.cert
  core:
    organization_console_url: https://console.example.com
    project: example-project

如要檢視使用中配置的屬性,請執行下列指令:

gdcloud config list

刪除設定

如要刪除設定,請執行:

gdcloud config configurations delete NAME

您無法刪除處於啟用狀態的設定。如要在刪除前切換至其他設定,請視需要使用 gdcloud config configurations activate