このページでは、Google Cloud CLI の概要、一般的なコマンド パターン、機能について説明します。
gcloud CLI とは
Google Cloud CLI は、Google Cloud リソースの作成と管理を行うための一連のツールです。これらのツールを使用すると、コマンドラインから、またはスクリプトや他の自動化により、多くの一般的なプラットフォーム タスクを実行できます。
たとえば、gcloud CLI を使用して、以下を作成、管理できます。
- Compute Engine 仮想マシン インスタンスと他のリソース
- Cloud SQL のインスタンス
- Google Kubernetes Engine クラスタ
- Dataproc クラスタとジョブ
- Cloud DNS マネージド ゾーンとレコードセット
- Cloud Deployment Manager のデプロイ
gcloud CLI を使用して、App Engine アプリケーションのデプロイ、認証の管理、ローカル構成のカスタマイズ、その他のタスクの実行ができます。
gcloud CLI をダウンロードしてインストールします。
現在の gcloud CLI のバージョンは 503.0.0 です。
最新バージョンの gcloud CLI を使用することを強くおすすめしますが、ダウンロード アーカイブから以前のバージョンをダウンロードして、インストールすることもできます。
Cloud Shell を使用している場合は、gcloud CLI が自動的に利用可能になるため、インストールする必要はありません。そうでない場合は、gcloud CLI をダウンロードしてインストールし、初期化します。
デフォルトでは、gcloud CLI は一般提供レベルのコマンドをインストールします。その他の機能は、gcloud CLI コンポーネントの alpha と beta で利用できます。こうしたコンポーネントを使用すると、一般提供前のリリースレベルで、Bigtable、Dataflow、Google Cloud の他の機能を gcloud CLI を使用して操作できるようになります。
gcloud CLI クイック リファレンス
gcloud CLI の概要、よく使用されるコマンドのリスト、これらのコマンドの構造については、gcloud CLI クイック リファレンスをご覧ください。
リリースレベル
gcloud CLI コマンドには、次のリリースレベルがあります。
| リリースレベル | ラベル | 説明 |
|---|---|---|
| 一般提供 | なし | 完全に安定しており、本番環境で使用可能と見なされているコマンドです。現在の機能を損なうコマンドに対する変更の事前通知については、リリースノートをご覧ください。 |
| ベータ版 | beta |
完全に機能しますが、未解決の問題が含まれている可能性があるコマンドです。互換性に対応しない変更が予告なしで行われることがあります。 |
| アルファ版 | alpha |
早期リリースのコマンドで、予告なく変更されることがあります。 |
デフォルトでは、alpha と beta コンポーネントは gcloud CLI と一緒にインストールされません。これらのコンポーネントは、gcloud components install コマンドを使用して別に行う必要があります。対応するコンポーネントがインストールされていないまま、アルファ版コマンドまたはベータ版コマンドを実行しようとすると、インストールするように gcloud CLI から求められます。
コマンド グループ
各リリースレベルの gcloud CLI コマンドは、入れ子構造のコマンド グループに階層状にまとめられています。各グループは、Google Cloud のサービスまたは機能か、機能のサブグループを表します。
次に例を示します。
| コマンド グループ | 説明 |
|---|---|
gcloud compute |
リリースレベルが一般提供の、Compute Engine に関連するコマンド |
gcloud compute instances |
リリースレベルが一般提供の、Compute Engine インスタンスに関連するコマンド |
gcloud beta compute |
リリースレベルがベータ版の、Compute Engine に関連するコマンド |
gcloud alpha app |
リリースレベルがアルファ版の App Engine のデプロイの管理に関連するコマンド |
gcloud CLI コマンドを実行する
gcloud CLI コマンドは、コマンドラインから、またスクリプトや他の自動化から実行できます。たとえば、Jenkins を使用して Google Cloud タスクを自動化する場合などです。
プロパティ
gcloud CLI のプロパティは、gcloud CLI ツールの動作に影響を与える設定です。これらのプロパティの一部は、グローバル オプションまたはコマンドオプションを使って設定可能です。その場合、フラグによって設定された値が優先されます。
ユーザー補助機能の有効化
スクリーン リーダーの利便性を向上させるために、gcloud CLI には accessibility/screen_reader プロパティが付属しています。
ユーザー補助プロパティを有効にするには、次のコマンドを実行します。
gcloud config set accessibility/screen_reader true
gcloud コマンドライン ツールに付属のユーザー補助機能の詳細については、ユーザー補助機能の有効化ガイドをご覧ください。
構成
構成とは、gcloud CLI のプロパティのセットです。構成は「プロファイル」のように機能します。
gcloud CLI の使用を開始する際に、default という名前の単一の構成を使用します。gcloud init または gcloud config set を実行することで、プロパティを設定できます。多くの場合、この default 構成が 1 つあれば十分です。
複数のプロジェクトや認証アカウントで作業する場合は、gcloud config configurations create によって複数の構成を設定し、構成を切り替えることができます。構成内ではプロパティをカスタマイズできます。たとえば、有効な構成内でプロジェクトを設定するには、project プロパティを次のように使用します。
gcloud config set project <project-id>
これらのコンセプトの詳細については、構成のガイドをご覧ください。
グローバル オプション
gcloud CLI は、呼び出しごとにコマンドの動作を制御する一連の gcloud CLI 向けオプションが用意されています。オプションは、gcloud CLI のプロパティで設定された値よりも優先されます。
位置引数とオプション
位置引数とフラグはいずれも gcloud CLI コマンドの出力に影響を与えますが、ユースケースには若干の違いがあります。位置引数はコマンドの対象となるエンティティの定義に使われるのに対して、オプションはコマンド動作のバリエーションの設定に必要です。
stdout と stderr を使用する
gcloud CLI コマンドの正常実行の出力は stdout に書き込まれます。他のすべてのタイプの応答（プロンプト、警告、エラー）は stderr に書き込まれます。stderr に書き込まれる応答は不安定であるため、これらの応答に対してスクリプトを作成しないでください。
出力処理のガイドラインについては、スクリプト ガイドをご覧ください。
プロンプト
意図しない破壊的な操作から保護するために、gcloud CLI は、gcloud projects delete などのコマンドを実行する前に本当に実行するかどうかを確認します。
追加情報が必要な場合は、プロンプトが表示されることがあります。
たとえば、gcloud compute instances create test-instance を使用して Compute Engine 仮想マシン インスタンスを作成する場合は、ゾーンを選択するよう求められます。
プロンプトを無効にするには、--quiet オプションを使用します。
文言は変更できるため、プロンプトの文言に対してスクリプト化しないでください。
プロンプト表示、端末への書き込み、ロギングの抑制
gcloud CLI の --quiet オプション（-q も使用可能）を使用すると、gcloud CLI コマンドの実行時にすべての対話型プロンプトが無効にされるため、スクリプト実行時に役立ちます。入力が必要な場合は、デフォルト値が使用されます。デフォルトがない場合は、エラーが発生します。
ターミナルの標準出力と標準エラーに対するコマンド出力を抑制するには、--no-user-output-enabled オプションを使用します。
ログの詳細度を調整するには、--verbosity オプションを使用して詳細度（debug、info、warning、error、critical、none）を指定します。
出力構造の決定
デフォルトでは、gcloud CLI コマンドがリソースのリストを返すと、読みやすく整形されて標準出力に書き出されます。わかりやすい出力を生成するには、format、filter、projection のオプションで出力を微調整します。
出力形式だけを定義する場合は、--format オプションを使用して、出力（対話型表示用）を表形式やフラット形式で、または出力（json、csv、yaml、value）を機械可読形式で生成します。
リソースデータの値を選択するキーのリストを書式設定するには、projections を使用します。定義した基準に従って出力をさらに絞り込むには、filter を使用します。
次のステップ
- gcloud CLI リファレンスで gcloud CLI コマンドの詳細について学習する。