gcloud ツールの概要

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

gcloud ツールとは

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

たとえば、gcloud ツールを使用して、以下を作成、管理できます。

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

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

gcloud ツールのクイック リファレンス

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

gcloud ツールと Cloud SDK

gcloud ツールは Cloud SDK の一部です。gcloud ツールを使用するには、まず、システムに Cloud SDK をダウンロードしてインストールし、Cloud SDK を初期化する必要があります。

デフォルトでは、Cloud SDK は一般提供レベルの gcloud ツールコマンドをインストールします。その他の機能は、Cloud SDK コンポーネントalphabeta で利用できます。こうしたコンポーネントを使用すると、一般提供前のリリースレベルで、Cloud Bigtable、Dataflow、Google Cloud の他の機能を gcloud ツールを使用して操作できるようになります。

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

gcloud ツールをダウンロードする

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

リリースレベル

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

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

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

コマンド グループ

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

次に例を示します。

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

gcloud ツール コマンドの実行

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

プロパティ

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

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

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

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

gcloud config set accessibility/screen_reader true

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

構成

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

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

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

gcloud config set project <project-id>

これらのコンセプトの詳細については、構成のガイドをご覧ください。

グローバル フラグ

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

位置引数とフラグ

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

stdoutstderr を使用する

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

出力処理のガイドラインについては、スクリプト ガイドをご覧ください。

プロンプト

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

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

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

文言は変更できるため、プロンプトの文言に対してスクリプト化しないでください。

プロンプト表示、端末への書き込み、ロギングの抑制

gcloud ツール--quiet フラグ(および -q)を指定すると、gcloud ツールコマンドを実行するときに対話型プロンプトが一切表示されなくなり、スクリプトの作成に便利です。入力が必要な場合は、デフォルト値が使用されます。デフォルトがない場合は、エラーが発生します。

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

ログの詳細度を調整するには、--verbosity フラグを使用して詳細度(debug、info、warning、error、critical、none)を指定します。

出力構造の決定

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

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

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

フィルタと書式設定機能について理解を深めるには、[Cloud Shell で開く] をクリックしてインタラクティブなクイック チュートリアルで学習することができます。

Cloud Shell で開く

次のステップ