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

gcloud クイック リファレンス

gcloud ツールの go-to gcloud コマンドのリスト(Google Cloud のメイン コマンドライン ツール)。

また、初級入門コマンドの概要印刷可能な PDF も含まれています。

クイック リファレンス

始めに

gcloud コマンドライン ツールの使用を開始します。

ヘルプ

Cloud SDK ではヘルプを使用できます。

  • gcloud help: gcloud ツールのリファレンス ドキュメントで特定の用語を検索します。
  • gcloud feedback: Cloud SDK チームにフィードバックを送信します。
  • gcloud topic: ユーザー補助、フィルタリング、書式設定など、コマンド以外のトピックに関する補助的なヘルプ資料です。

パーソナライズ化

Cloud SDK を使いやすいように、プロパティを使用して構成をカスタマイズします。

認証情報

Cloud SDK に対する承認の付与および取り消し

  • gcloud auth login: Google ユーザー認証情報を使用して gcloud ツール用の Google Cloud アクセスを承認し、現在のアカウントをアクティブとして設定します。
  • gcloud auth activate-service-account: gcloud auth login と同様ですが、サービス アカウントの認証情報を使用します。
  • gcloud auth list: 認証情報が付与されているすべてのアカウントを一覧表示します。
  • gcloud auth print-access-token: 現在のアカウントのアクセス トークンを表示します。
  • gcloud auth revoke: アカウントのアクセス認証情報を削除します。

プロジェクト

プロジェクトのアクセス ポリシーを管理する

ID とアクセスの管理

Cloud Identity and Access Management(IAM)の設定とサービス アカウントの構成

Docker と Google Kubernetes Engine(GKE)

コンテナ化されたアプリケーションを Kubernetes で管理する

仮想マシンと Compute Engine

Google インフラストラクチャで VM を作成、実行、管理する

サーバーレスと App Engine

フルマネージド型のサーバーレスなプラットフォーム上で高度なスケーラビリティを備えたアプリケーションを構築

  • gcloud app deploy: アプリのコードと構成を App Engine サーバーにデプロイします。
  • gcloud app versions list: App Engine サーバーにデプロイされたすべてのサービスのすべてのバージョンを一覧表示します。
  • gcloud app browse: 現在のアプリをウェブブラウザで開きます。
  • gcloud app create: 現在のプロジェクト内で App Engine アプリを作成します。
  • gcloud app logs read: 最新の App Engine アプリのログを表示します。

その他

便利なコマンド

  • gcloud kms decrypt: Cloud Key Management Service(Cloud KMS)鍵を使用して、暗号テキストを(平文ファイルに)復号します。
  • gcloud logging logs list: プロジェクトのログを一覧表示します。
  • gcloud sql backups describe: Cloud SQL インスタンスのバックアップに関する情報を表示します。
  • gcloud sql export sql: Cloud SQL インスタンスから SQL ファイルにデータをエクスポートします。

初級入門

gcloud コマンドライン ツールの使用を開始するためのクイックガイド。

Cloud SDK のインストール

インストール手順に沿って Cloud SDK をインストールします。

フラグ、引数など

引数には位置引数またはフラグを指定できます

  • 位置引数: コマンド名の後に設定します。位置引数の順序を考慮する必要があります。
  • フラグ: 位置引数の後に設定します。フラグの順序に決まりはありません。

    フラグには次のいずれかを指定できます。

    • 名前と値のペア--foo=bar
    • ブール値--force/no-force

    また、フラグは次のどちらも設定できます。

    • 必須
    • 省略可: フラグが定義されていない場合は、デフォルト値が使用されます

グローバル フラグ

gcloud コマンドライン ツールの操作では、次のようなフラグを使用できます。

  • --help: コマンドの機能が不明な場合、詳細なヘルプを表示します。
  • --project: 現在のプロジェクト以外のプロジェクトを使用しているかどうか。
  • --quiet: インタラクティブなプロンプト表示(および入力のデフォルト値の適用)を無効にします。
  • --verbosity: 詳細レベルを debuginfowarningerrorcriticalnone に設定できます。
  • --version: gcloud のバージョン情報を表示します。
  • --format: 出力形式を configcsvdefaultdiffdisableflattenedgetjsonlistmultinoneobjecttabletextvalueyaml に設定します。

結果のクリーンアップ

フィルタ、形式、制限、並べ替えのフラグを指定して、出力を最大限利用します。

接頭辞は us であるが、マシンタイプは f1-micro ではない Compute Engine インスタンスの場合:

gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"

2018 年 1 月 15 日以降に作成されたプロジェクトのリストの場合、古いものから新しいものの順に並べ替えられ、プロジェクト番号、プロジェクト ID、作成日時の列(日付と時刻はローカル タイムゾーン)が含まれるテーブルとして表示されます:

gcloud projects list --format="table(projectNumber,projectId,createTime.date(tz=LOCAL))"
--filter="createTime>=2018-01-15T12:00:00" --sort-by=createTime

ラベル my-label(任意の値)が含まれる 10 個の Compute Engine インスタンスのリストの場合:

gcloud compute instances list --filter="labels.my-label:*" --limit=10

コマンドの概要

gcloud コマンドの基礎パターン。コマンドを自身で理解するのに役立ちます。

gcloud コマンドの検索

gcloud コマンドライン ツールはツリー形式です。リーフ以外のノードはコマンド グループで、リーフノードはコマンドです(また、タブ補完はコマンドやリソースでも機能します)。

gcloud コマンドのほとんどは、次の形式です。

gcloud + release level (optional) + component + entity + operation + positional args + flags

次に例を示します。gcloud + compute + instances + create + example-instance-1 + --zone=us-central1-a

リリースレベル

リリースレベルは、コマンドのリリース状況を指します。

例: アルファ版コマンドの場合は alpha、ベータ版コマンドの場合は beta で、GA コマンドにはリリースレベルは必要ありません。

コンポーネント

コンポーネントは、さまざまな Google Cloud サービスを指します。

例: Compute Engine の場合は compute、App Engine の場合は app などのようになります。

エンティティ

エンティティは、要素の複数形、またはコンポーネントの下位にある要素のコレクションを指します。

例: disksfirewallsimagesinstancesregionszones(コンピューティング用)

操作

オペレーションは、エンティティに対して実行されるオペレーションの命令の動詞形を指します。

例: describelistcreate/updatedelete/clearimportexportcopyremoveaddresetrestartrestorerundeploy が一般的なオペレーションです。

位置引数

位置引数は、コマンドの実行に必要な、命令に固有の必須の引数を指します。

例: <INSTANCE_NAMES> は、gcloud compute instances create に必要な位置引数です。

フラグ

フラグは、追加の引数を指します(--flag-name(=value))。これは位置引数の後にコマンドに渡されます。

例: --machine-type=<MACHINE_TYPE>--preemptible は、gcloud compute instances create のオプションのフラグです。