構成とは、Distributed Cloud CLI のプロパティのセットに名前を付けたものです。これらのプロパティは、Key-Value ペアの形でセクションごとにまとめられ、gdcloud CLI の動作を制御します。
構成内に保存される一般的なプロパティには、組織コンソールの URL やプロジェクト ID などがあります。構成を使用すると、このような設定やその他の設定をグループとして定義し、有効にすることができます。
構成はユーザー構成ディレクトリに保存されます。通常、macOS と Linux では ~/.config/gdcloud です。また、構成ディレクトリで書き込みが有効になっている必要があります。
複数の構成がある場合は、それらの切り替えや、--configuration フラグを使用して特定の構成でコマンドを実行できます。構成の切り替えについて詳しくは、構成を有効にするのセクションをご覧ください。
構成に関する情報と、使用可能なプロパティの完全なリストと、それが入っているセクションをコマンドラインから参照するには、gdcloud topic
configurations を実行してください。
デフォルト構成
gdcloud CLI は、最初に default という名前の単一の構成を作成します。gdcloud
init コマンドを実行するか、gdcloud config set を直接実行することで、構成にプロパティを設定できます。
複数の構成
たいていは、default 構成が 1 つあれば十分ですが、追加の構成を作成して、必要に応じて gdcloud config configurations activate を使用して切り替えることもできます。初期の default 構成は便宜上作成されたものであり、使用する必要はありません。これに名前を付け、必要に応じて構成を追加することもできます。
複数の構成があると、次のような場合に便利です。
- 複数のプロジェクトを使用する: プロジェクトごとに別の構成を作成し、必要に応じて切り替えることができます。
- 複数の組織コンソール URL を使用する。
- 独立したタスクを実行する: たとえば、プロジェクトのサービス A で使用する構成を作成し、別のプロジェクトのサービス B を管理する構成を作成します。
設定を作成する
構成を作成するには、次のコマンドを実行します。
gdcloud config configurations create NAME
新しい構成を使用するには、作成後に新しい構成を有効にする必要があります。
構成を有効にする
複数の構成があっても、一度に有効にできるのは 1 つのみです。有効な構成とは、そのプロパティによって gcloud CLI の動作を制御する構成のことです。
新しい構成を有効にするか、新しい有効な構成に切り替えるには、次のコマンドを実行します。
gdcloud config configurations activate NAME
gdcloud config list を使用すると、有効な構成のプロパティの一覧が表示されます。
有効な構成を指定してコマンドを 1 回だけ実行するには、任意の 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 を使用します。