SDK のプロパティの管理

プロパティとは

プロパティとは、gcloud CLI などの SDK ツールの動作を制御する設定です。

プロパティを使用して、プロダクトやサービスの設定を定義できます。たとえば、gcloud CLI や他の Cloud SDK ツールが認証に使用するアカウントや Google Compute Engine リソースのデフォルト リージョンを指定できます。また、Cloud SDK コンポーネントの自動更新を無効にすることもできます。プロパティは、gcloud CLI コマンドの詳細レベルやプロンプトの構成など、gcloud コマンドライン ツールの設定を定義する際にも使用できます。

プロパティとフラグ

gcloud CLI では、SDK プロパティと同じ効果を持つグローバル フラグとコマンドフラグがいくつかサポートされています。たとえば gcloud CLI では、--project フラグと project プロパティを両方サポートしています。プロパティを使用すると、コマンドの実行中に同じ設定を維持できます。コマンドを呼び出すたびに、フラグによってコマンドの動作が制御されます。両方を設定すると、フラグによってプロパティがオーバーライドされます。

構成

構成とは、SDK の一連のプロパティに名前を付けたものです。gcloud CLI では、default という名前の構成が最初に有効になります。default は、ほとんどのユースケースに適した構成です。追加の構成を作成して、必要に応じて切り替えることもできます。

プロパティのリスト表示

アクティブな構成の中のプロパティを一覧表示するには、gcloud config list を実行します。

gcloud config list
    

gcloud CLI により、プロパティのリストが返されます。

    [compute]
    region = us-east1
    zone = us-east1-d
    [core]
    account = user@google.com
    disable_usage_reporting = False
    project = example-project
    [metrics]
    command_name = gcloud.config.list
    

プロパティの設定

アクティブな構成の中のプロパティを設定するには、gcloud config set を実行します。

gcloud config set project [PROJECT]
    

core プロパティ セクションに含まれていないプロパティを設定するには、セクションを指定し、続けてスラッシュとプロパティ名を指定する必要があります。

gcloud config set compute/zone us-east1-b
    

プロパティの設定解除

アクティブな構成の中のプロパティを設定解除するには、gcloud config unset を使用します。

gcloud config unset disable_usage_reporting
    

プロパティの種類

SDK のプロパティはセクションに分類されています。セクションとは、プロパティ リストを表示する際にわかりやすくなるよう関連プロパティをグループ化したものです。

コアプロパティ

core セクションには、gcloud コマンドの構成プロパティが含まれます。

名前 説明
account gcloud CLI や他の SDK ツールで使用される、承認用のユーザー アカウントまたはサービス アカウント。
custom_ca_certs_file 使用するカスタム CA 証明書ファイルへの絶対パス。
disable_color True に設定した場合、gcloud CLI によるターミナルへのメッセージは、モノクロで表示されます。
disable_file_logging True に設定した場合は、gcloud CLI によってログがファイルに保存されます。これは、ディスク使用量が制限されている場合に役立つことがあります。
disable_prompts True に設定した場合、すべての gcloud CLI コマンドでプロンプトが抑制され、デフォルトの応答が使用されます。コマンドにユーザー入力が必要なためデフォルトを使用できない場合は、gcloud CLI によってエラーが報告されます。グローバル --quiet フラグと同等です。
disable_usage_reporting True に設定した場合、SDK の使用状況に関する匿名の統計情報の収集が無効になります。SDK のインストール時にこの値を設定しますが、いつでも変更できます。
log_http True に設定した場合、ログへの HTTP リクエストと応答の書き込みが有効になります。これらのメッセージがターミナルで表示されるようにするには、verbosity プロパティまたはグローバル --verbosity フラグを使用して詳細設定を調整します。
max_log_days ログファイルを削除するまで保持する最長期間。0 に設定した場合、ログガベージ コレクションはオフになり、ログファイルは削除されません。設定しなかった場合、デフォルトは 30 日です。
pass_credentials_to_gsutil True に設定した場合、構成された Cloud SDK 認証を gsutil に渡します。
project 現在の Cloud Platform プロジェクトのプロジェクト ID。グローバル --project フラグを使用して、この値をオーバーライドできます。
show_structured_logs 標準エラーに書き込まれた JSON 構造化ログメッセージの可視性と形式。このプロパティが無効な場合、ログの形式はデフォルトで text になります。有効な値は neveralwayslogterminal です。設定しなかった場合、デフォルトは never です。
trace_token 問題を調査できるようサービス リクエストのトレースをルーティングするために Google サポートによって提供されるトークン。
user_output_enabled ターミナルでの標準出力と標準エラーに対するコマンド出力が有効になります。False に設定した場合、出力は抑制されます。
verbosity gcloud CLI コマンドのログの詳細度。gcloud CLI では、次の標準的な詳細レベルがサポートされています。
  • debug
  • info
  • warning
  • error
  • critical
  • none
グローバル --verbosity フラグを使用する場合と同じです。

コンポーネント マネージャー プロパティ

component_manager セクションには、SDK コンポーネントを管理するときに使用するプロパティが含まれます。

名前 説明
component_manager/additional_repositories コンポーネントを確認するための追加リポジトリのカンマ区切りのリスト。このプロパティは、gcloud components repositories コマンド グループのコマンドによって自動的に管理されます。
component_manager/disable_update_check True の場合、SDK は更新を自動的には確認しません。

App Engine プロパティ

app セクションには、gcloud app deploy コマンドの動作を指定するプロパティが含まれています。

名前 説明
app/stop_previous_version True の場合、アプリケーションの新しいバージョンをデプロイするときに、以前にデプロイされたバージョンが停止されます。False の場合、デプロイの前に古いバージョンを手動で停止する必要があります。

Compute Engine プロパティ

compute セクションには、Google Kubernetes Engine リソースに対して機能する gcloud CLI コマンドで使用されるプロパティが含まれます。

名前 説明
compute/region Compute Engine リソースを操作するときに使用するデフォルトのリージョン。--region フラグが gcloud CLI コマンドに必要な場合に、フラグが指定されていないときは、この値が使用されます。
compute/zone Compute Engine リソースを操作するときに使用するデフォルトのゾーン。--zone フラグが gcloud CLI コマンドに必要な場合に、フラグが指定されていないときは、この値が使用されます。

Kubernetes Engine プロパティ

container セクションには、Google Kubernetes Engine クラスタに対して機能する gcloud CLI コマンドで使用されるプロパティが含まれています。

名前 説明
container/cluster デフォルトで使用するクラスタの名前。

ネットワーク プロキシ プロパティ

proxy セクションには、gcloud コマンドによるネットワーク プロキシの使用に関連するプロパティが含まれます。

名前 説明
proxy/type プロキシ サーバーの種類。サポートされているプロキシの種類は、次のとおりです。
  • http
  • http_no_tunnel
  • socks4
  • socks5
proxy/address プロキシ サーバーのホスト名または IP アドレス。
proxy/port プロキシ サーバーへの接続時に使用するポート。
proxy/username 必要に応じて、プロキシ サーバーへの接続時に使用するユーザー名。
proxy/password 必要に応じて、プロキシ サーバーへの接続時に使用するパスワード。
proxy/rdns True(デフォルト)の場合、DNS クエリはローカルで実行され、プロキシで参照の解決が行われます。

次のステップ