gcloud コマンドライン ツールの概要

このページには、gcloud コマンドライン ツールおよびその一般的なコマンド パターンと機能の概要が含まれています。

gcloud コマンドライン ツールとは

gcloud コマンドライン インターフェースは、Google Cloud リソースを作成、管理するための主要な CLI ツールです。このツールを使用すると、コマンドラインから、またはスクリプトや他の自動化により、多くの一般的なプラットフォーム タスクを実行できます。

たとえば、gcloud CLI を使用して、以下のようなものを作成、管理できます。

  • Google Compute Engine 仮想マシン インスタンスと他のリソース
  • Google Cloud SQL インスタンス
  • Google Kubernetes Engine クラスタ
  • Google Cloud Dataproc クラスタとジョブ
  • Google Cloud DNS マネージド ゾーンとレコードセット
  • Google Cloud Deployment Manager のデプロイ

gcloud CLI を使用して、App Engine アプリケーションのデプロイ、認証の管理、ローカル構成のカスタマイズ、その他のタスクの実行ができます。このツールの機能については、gcloud CLI リファレンスをご覧ください。

gcloud コマンドライン ツールのクイック リファレンス

gcloud コマンドライン ツールの概要、よく使用されるコマンドのリスト、およびこれらのコマンドの構造については、gcloud コマンドライン ツールのクイック リファレンスをご覧ください。

gcloud CLI と Cloud SDK

gcloud CLI は Google Cloud SDK の一部です。gcloud コマンドライン ツールを使用する際は、事前にシステムに SDK をダウンロードしてインストールし、初期化しておく必要があります。

デフォルトでは、リリースレベルが一般提供の gcloud CLI コマンドのみがインストールされます。その他の機能は、SDK コンポーネントalphabeta で利用できます。これらのコンポーネントを使用すると、Google Cloud Bigtable、Google Cloud Dataflow など、一般提供前のリリースレベルの Cloud Platform の機能を gcloud CLI で使用できるようになります。

gcloud CLI のリリースには SDK と同じバージョン番号が付いています。SDK の現行バージョンは 302.0.0 です。以前のバージョンの SDK は、ダウンロード アーカイブからダウンロードしてインストールできます。

gcloud コマンドライン ツールのダウンロード

gcloud コマンドライン ツールを含む最新バージョンの Cloud SDK を、ダウンロード ページからダウンロードできます。

リリースレベル

gcloud CLI コマンドには、次のリリースレベルがあります。

リリースレベル ラベル 説明
一般提供 なし 完全に安定しており、本番環境で使用可能と見なされているコマンドです。現在の機能が利用できなくなる場合は、その旨が事前に通知され、情報がリリースノートに記載されます。
ベータ版 beta 完全に機能しますが、未解決の問題が含まれている可能性があるコマンドです。互換性に対応しない変更が予告なしで行われることがあります。
アルファ版 alpha 早期リリースのコマンドで、予告なく変更されることがあります。

デフォルトでは、alphabeta コンポーネントは SDK と一緒にインストールされません。これらのインストールは、gcloud components install コマンドを使用して別に行う必要があります。対応するコンポーネントがインストールされていないまま、アルファ版コマンドまたはベータ版コマンドを実行しようとすると、インストールするように gcloud コマンドライン ツールから求められます。

コマンド グループ

各リリースレベルの gcloud CLI コマンドは、入れ子構造のコマンド グループに階層状にまとめられています。各グループは、Cloud Platform のサービスまたは機能か、機能のサブグループを表します。

例:

コマンド グループ 説明
gcloud compute リリースレベルが一般提供の、Compute Engine に関連するコマンド
gcloud compute instances リリースレベルが一般提供の、Compute Engine インスタンスに関連するコマンド
gcloud beta compute リリースレベルがベータ版の、Compute Engine に関連するコマンド
gcloud alpha app リリースレベルがアルファ版の App Engine のデプロイの管理に関連するコマンド

gcloud CLI コマンドを実行する

gcloud CLI コマンドは、他のコマンドライン ツールと同じように、コマンドラインから実行できます。また、gcloud CLI コマンドをスクリプトや他の自動化で実行することもできます。たとえば、Jenkins を使用して Cloud Platform のタスクを自動化する場合などです。

特性

gcloud CLI のプロパティ設定は、gcloud CLI や他の Cloud SDK ツールの動作に影響を与えます。これらのプロパティの一部は、グローバル フラグまたはコマンドフラグを使って設定可能です。その場合、フラグによって設定された値が優先されます。

使用可能なプロパティのリストについては、こちらをご覧ください。

ユーザー補助機能の有効化

スクリーン リーダーの利便性を向上させるために、gcloud コマンドライン ツールには accessibility/screen_reader プロパティが付属しています。

このプロパティを有効にするには、次を実行します。

gcloud config set accessibility/screen_reader true

gcloud コマンドライン ツールに付属のユーザー補助機能の詳細については、ユーザー補助機能の有効化ガイドをご覧ください。

設定

構成とは、gcloud CLI のプロパティのセットに名前を付けたものです。これは本質的に「プロファイル」のように機能します。

Cloud SDK の初期状態では、default という名前の単一の構成が使用されます。gcloud init または gcloud config set のいずれかを実行することにより、プロパティを設定できます。多くの場合、この default 構成が 1 つあれば十分です。

複数のプロジェクトや認証アカウントで作業する場合は、gcloud config configurations create により複数の構成を設定し、状況に応じて切り替えることができます。これらの構成内ではプロパティをカスタマイズできます。たとえば、有効な構成内でプロジェクトを設定するには、project プロパティを「gcloud config set project <project-id>」のように使用します。

これらのコンセプトの詳細については、構成管理の説明をご覧ください。

グローバル フラグ

gcloud CLI は、呼び出しごとにコマンドの動作を制御する一連の gcloud CLI 向けフラグが用意されています。フラグは、SDK のプロパティで設定された値よりも優先されます。

位置引数とフラグ

位置引数とフラグはいずれも gcloud CLI コマンドの出力に影響を与えますが、ユースケースには若干の違いがあります。位置引数はコマンドの対象となるエンティティの定義に使われるのに対して、フラグはコマンド動作のバリエーションの設定に必要です。

stdout と stderr の使用

gcloud CLI コマンドの正常実行の出力は stdout に書き込まれます。 他のすべてのタイプの応答(プロンプト、警告、エラー)は stderr に書き込まれます。 なお、stderr に書き込まれる項目は不安定であるため、それを対象にスクリプトを作成しないでください。

出力処理のガイドラインについては、このセクションをご覧ください。

プロンプト

意図しない破壊的な操作から保護するために、gcloud CLI は、gcloud projects delete などのコマンドを実行する前に本当に実行するかどうかを確認します。

また、gcloud compute instances create test-instance を使用して「test-instance」などの Google Compute Engine 仮想マシン インスタンスを作成する場合も、プロンプトが表示されます。インスタンスを作成するゾーンを選択するよう求められます。

プロンプトを無効にするには、--quiet フラグを使用します。

プロンプトのメッセージは変更される可能性があるため、これを対象にスクリプトを作成しないでください。

プロンプト表示、ターミナルへの書き込み、ロギングの抑制

gcloud CLI の --quiet フラグ(また、-q)を使用すると、gcloud CLI コマンドの実行時にすべての対話型プロンプトが無効にされるため、スクリプト実行時に役立ちます。入力が必要な場合は、デフォルトが使用されます。何もない場合、エラーとなります。

ターミナルの標準出力と標準エラーに対するコマンド出力を抑制するには、--no-user-output-enabled フラグを使用します。

代わりにログの詳細度を調整するには、適切なレベル(debug、info、warning、error、critical、none)で --verbosity フラグを使用します。

出力構造の決定

デフォルトでは、gcloud CLI コマンドがリソースのリストを返すと、読みやすく整形されて標準出力に書き出されます。わかりやすい出力を生成するには、format、filter、projection のフラグで出力を微調整します。

出力形式だけを定義する場合は、--format フラグを使用して、出力(対話型表示用)を表形式やフラット形式で、または出力(jsoncsvyamlvalue)を機械可読形式で生成します。

リソースデータの値を選択するキーのリストを書式設定するには、projections を使用します。定義した基準に従って出力をさらに絞り込むには、filter を使用します。

インタラクティブなクイック チュートリアルでフィルタと書式設定機能を学習する場合は、次のリンクを使用してください。

Cloud Shell で開く

次のステップ