Cloud Shell を使用した開発とCloud Code

1. 概要

Cloud Shell は、オンラインの開発および運用環境であり、どこにいてもお使いのブラウザでアクセスできます。gcloud コマンドラインツールや kubectl などのユーティリティがプリロードされたオンラインターミナルを使用して、リソースを管理できます。オンラインの Cloud Shell Editor を使用して、クラウドベースのアプリの開発、ビルド、デバッグ、デプロイを行うこともできます。

このラボでは、Cloud Shell と Cloud Shell エディタを使用し、Cloud Code を使用してローカルエミュレータと実際のサービスでコンテナベースのアプリケーションを作成、デプロイ、テストします。

学習内容

Cloud Shell の主な機能を操作して理解する
さまざまな Cloud Shell の使用パターンを試す
高度な使用のために Cloud Shell 環境をカスタマイズする
Cloud Code のオプションと機能について理解する
Cloud Code for Kubernetes アプリケーションの詳細を確認する
Minikube などのローカルエミュレータを使用する

前提条件

編集者の権限を持つ GCP プロジェクト、GCP アカウント、Cloud Shell へのアクセス権が必要です。
オプション部分については、ターミナルエミュレータと Google Cloud SDK がインストールされている必要があります。

2. 設定と要件

セルフペース型の環境設定

Google Cloud Console にログインして、プロジェクトを新規作成するか、既存のプロジェクトを再利用します。Gmail アカウントも Google Workspace アカウントもまだお持ちでない場合は、アカウントを作成してください。

プロジェクト名は、このプロジェクトの参加者に表示される名称です。Google API では使用されない文字列です。この設定はいつでも変更できます。
プロジェクト ID は、すべての Google Cloud プロジェクトにおいて一意でなければならず、不変です（設定後は変更できません）。Cloud コンソールでは一意の文字列が自動生成されます。通常は、この内容を意識する必要はありません。ほとんどの Codelab では、プロジェクト ID（通常は PROJECT_ID と識別されます）を参照する必要があります。生成された ID が好みではない場合は、ランダムに別の ID を生成できます。または、ご自身で試して、利用可能かどうかを確認することもできます。このステップ以降は変更できず、プロジェクトを通して同じ ID になります。
なお、3 つ目の値として、一部の API が使用するプロジェクト番号があります。これら 3 つの値について詳しくは、こちらのドキュメントをご覧ください。

次に、Cloud のリソースや API を使用するために、Cloud コンソールで課金を有効にする必要があります。この Codelab の操作をすべて行って、費用が生じたとしても、少額です。このチュートリアルの終了後に請求が発生しないようにリソースをシャットダウンするには、作成したリソースを削除するか、プロジェクト全体を削除します。Google Cloud の新規ユーザーは、300 米ドル分の無料トライアルプログラムをご利用いただけます。

3. Cloud Shell ターミナルの操作

このセクションでは、Cloud Shell ターミナルについて学習します。UI の操作方法、機能の使用方法、構成オプションについて説明します。また、生産性を向上させるためのさまざまな使用方法についても説明します。

Cloud Shell には、Cloud Shell ターミナルと Cloud Shell エディタの 2 つの主要なツールがあります。このラボでは、Cloud Shell ターミナルと Cloud Shell という用語が同じ意味で使用されますが、エディタはターミナルエミュレータと IDE を明確に区別するために、常に Cloud Shell エディタと呼ばれます。

Cloud Shell は、エフェメラル Google Compute Engine Debian ベースの Linux マシン上に構築された、完全に機能するクラウドベースの Shell です。いつでも使用できます。Google Cloud SDK がインストールされており、git、kubectl、kubectx、curl、python3、tmux などの関連ツールが付属しています。

$HOME ディレクトリは Google Cloud によって Cloud Storage に保持され、Cloud Shell マシンが起動するたびに自動的にマウントされるため、Cloud Shell マシンがシャットダウンしても、その下に残した情報が失われることはありません。つまり、Cloud Shell を再度有効にすると、$HOME ディレクトリと、そのディレクトリに対して行ったカスタマイズを使用できます。

Cloud Shell の起動

console.cloud.google.com に移動し、GCP コンソールにまだログインしていない場合は、Google 認証情報を入力します。Google Cloud Platform の Console のメイン UI が表示されます。
Cloud Console のメニューバーの選択ツールで、使用する GCP プロジェクト ID を選択します。

メニューバーの右側にあるアカウントのアバターの横に、Cloud Shell を有効にするボタンがあります。

Cloud Shell アイコンをクリックすると、Cloud Shell ターミナルが開き、GCP Console UI のすぐ下に新しいペインが表示されます。

このペインには、Cloud Shell ターミナルがあります。

Cloud Shell ターミナルに移動します。GCP コンソールで適切な GCP プロジェクト ID を選択したため、Cloud Shell はその ID を認識しています。そのため、再度指定する必要はありません。

echo $GOOGLE_CLOUD_PROJECT

これにより、GCP プロジェクト ID が出力されます。この ID は Cloud Shell プロンプトにも表示されます。

ツールを切り替える

Cloud Shell には、いくつかのツールと構成オプションが用意されています。Cloud Shell メニューのオプションを使用して、これらを確認します。

バーのボタンをクリックすると、Cloud Shell ターミナルを最大化して、ブラウザのタブの領域全体を使用できます。

Cloud Shell が最大化され、ブラウザのタブのスペース全体を占有します。

もう一度クリックします。ブラウザタブの領域は、Cloud コンソールと Cloud Shell で共有される状態に戻ります。

新しいタブを開く

Cloud Shell ターミナルでは、必要な数のタブを開くことができます。

次のボタンをクリックして、新しいタブを開きます。

タブ名の横にある [x] をクリックするか、対応するシェルに exit と入力して、新しいタブを閉じます。

新しいウィンドウを開く

Cloud Shell を新しいブラウザウィンドウで開くと、Cloud コンソールを 1 つのウィンドウに、Cloud Shell を別のウィンドウに表示できます。

次のボタンをクリックして、Cloud Shell が新しいブラウザタブで開くことを確認します。

Cloud Shell に同じツールバーオプションが表示されますが、外観が少し異なります。

次のセクションでは、この新しいブラウザタブを開いたままにします。

Tmux を使用したセッションの転送

Cloud Shell には tmux が含まれています。Tmux は GNU Screen と同様に、非常に人気のあるターミナルマルチプレクサです。tmux との統合により、Cloud Shell は場所に関係なくセッションを維持できます。

以降の手順では、このコンセプトを実際に試して、この機能に対する理解を深めます。

Cloud Shell ターミナルの移動

開いた Cloud Shell タブで、コマンド top を入力します。

top コマンドは、Cloud Shell ターミナルで実行されているプロセスをリアルタイムで表示します。これを使用して、tmux によって提供される Cloud Shell のセッションの永続性を可視化します。

ブラウザの最初のタブ（Cloud コンソールがあるタブ）に戻ります。
Cloud Shell を新しいウィンドウで開くように以前に設定したため、「Your session was transferred to another browser tab. You can disable this from the "Tmux Settings" option in the Cloud Shell settings menu.」というメッセージが表示されます。
再接続ボタンをクリックします。

2 番目のタブで実行されていたシェルにアクセスできるようになり、top は中断したときと同じ状態で実行され続けます。

ブラウザの 2 番目のタブに移動します。このタブで、新しいウィンドウで Cloud Shell を開きました。
[再接続] をクリックします。ウィンドウを閉じる前に実行されていたトッププロセスが復元されます。

Tmux でウィンドウを分割する

Tmux は、先ほど使用したよりもはるかに便利なツールです。tmux のチュートリアルはこのラボの範囲外です。詳細については、tmux の公式スタートガイドをご覧ください。

ただし、tmux を使用すると、ローカルターミナルエミュレータで可能な追加機能が Cloud Shell で使用できるようになります。1 つの例として、ターミナルを左右に分割します。

Cloud Shell 内で、Ctrl + b を押してから % を押します。
tmux が元のペインの右側に新しいペインを作成する様子を確認します。

2 番目のペインをクリックし、「exit」と入力します。

ウェブプレビューを活用する

Cloud Shell は、クラウドで実行されている Cloud Shell マシンから、パソコンで実行されているローカルブラウザへの自動ポート転送を確立することもできます。

Cloud Shell で次のように入力します。

python3 -m http.server 8080

右上にある [ウェブでプレビュー] オプションに移動し、[ポート 8080 でプレビュー] を選択します。

新しいタブが開き、そのポートで提供されるデフォルトページが表示されます。

ポートを変更してプレビューできるのは、Cloud Shell でアプリケーションが公開しているポートであり、ポート 8080 に限定されません。

Cloud Shell のその他のオプションにアクセスする

Cloud Shell では、追加の設定とオプションを使用できます。

Cloud Shell メニューのその他アイコンをクリックして、次のオプションにアクセスします。

ここで最も関連性の高いオプションは、Cloud Shell にファイルをアップロードまたはダウンロードする機能と、問題が発生した場合に Cloud Shell マシンを再起動する機能です。

4. Cloud Shell エディタの使用

Cloud Shell の最も重要な機能の一つは Cloud Shell エディタです。これは、オープンソースプロジェクトの Eclipse Theia に基づく本格的な IDE であり、Google などが貢献しています。VSCode と同様のルックアンドフィールで、Monaco エディタ、拡張機能モデル、言語サーバープロトコル、デバッグアダプタプロトコルなど、いくつかの共通のオープンソースベースコンポーネントを使用しています。

Theia/Cloud Shell エディタは非常に複雑なツールであるため、このラボでは Cloud Shell エディタのすべての機能について説明しません。このセクションでは、この Google Cloud 実装で使用できる基本的なコンセプトと独自の機能について説明します。

Cloud Shell エディタへのアクセス

Cloud Shell エディタには、次の 3 つの方法でアクセスできます。

コマンドラインからアクセスする
Cloud Shell メニューからアクセスする
ブラウザで URL にアクセスする

次の手順でこれらの方法を試す

コマンドラインから次のコマンドを使用して .bashrc を開きます。

cloudshell edit $HOME/.bashrc

[エディタを開く] ボタンをクリックして、メニューから Cloud Shell を開きます。これにより、Cloud Shell ターミナルを開いたまま Cloud Shell エディタが開きます。Cloud Shell エディタのタブ領域をすべて使用する場合は、[編集] ボタンの右にあるボタンをクリックしてターミナルを閉じます。これらの 2 つのボタン（エディタを開く/閉じる、ターミナルを開く/閉じる）により、ブラウザタブに表示されるツールが決まります。両方をクリックして、コツをつかんでください。
ブラウザのアドレスバーから Cloud Shell エディタを呼び出すには、ide.cloud.google.com と入力します。

Cloud Shell エディタからコマンドラインを使用する

Cloud Shell ターミナルと Cloud Shell エディタは同じブラウザタブに共存していますが、Cloud Shell ターミナルを省略して、Cloud Shell エディタと Cloud Shell エディタ内から利用できるターミナルのみを使用することもできます。IDE を使い慣れていて、VSCode のさまざまなショートカットやペインの動作を熟知している場合は、この方法が適している可能性があります。

上記の方法のいずれかを使用して、Cloud Shell エディタを開きます。次に、エディタメニューに移動して、[ターミナル] > [新しいターミナル] を選択します（または、キーボードで Ctrl+` キーを押します）。Cloud Shell エディタの下部に新しいターミナルペインが開きます。このペインは、シェルに関するすべてのニーズに使用できます。

また、Cloud Shell ターミナルの場合のように tmux ペイン管理を使用しなくても、さまざまなターミナルペインを管理できるようになります。

Cloud Shell の設定をカスタマイズする

Cloud Shell には、外観や基本的な動作から、Cloud Shell ターミナルの起動構成や詳細な操作まで、いくつかのカスタマイズオプションがあります。次のセクションでは、さまざまなオプションについて詳しく説明します。

Cloud Shell ターミナルメニューに移動し、歯車アイコンをクリックします。いくつかの構成オプションが表示されます。

いくつか見てみましょう。

カラーテーマ: ライト、ダーク、またはカスタムカラーのセット（フォントの色や背景色など）を使用できます。
テキストサイズ: 5 つのフォントサイズから選択できます
フォント: Courier New または Monospace
設定をコピー: ここでは、コピーのキーボードショートカットを、最も一般的な Linux ターミナルエミュレータで使用されているショートカットに似たものに変更できます。
キーボード: Meta キーを Alt にマッピング（デフォルトでは Meta は ESC）、一部の OS での Alt Gr キーのマッピング。

シェル環境の構成

Debian ベースの Linux マシンでシェルを実行するターミナルエミュレータとして、Linux と同じ方法でシェル環境をカスタマイズできます。そのため、$HOME に存在する構成ファイル（.bashrc) など）は、新しいログインシェルプロセスが作成されるたびに取得されます。

Cloud Shell では、.customize_environment という特別な構成ファイルで、Cloud Shell インスタンスが起動するたびに実行するアクションを指定することもできます。詳細については、環境のカスタマイズのドキュメントをご覧ください。

Cloud Shell ターミナルに構成を追加する練習をします。Cloud Shell ターミナルに移動し、次のサンプルコードリポジトリのクローンを作成します。

git clone https://gitlab.com/javiercanadillas/cloud-code-getting-started.git

このリポジトリには、Cloud Shell の構成が必要になる可能性のある 2 つの主要なイベントのサンプルが含まれています。

Cloud Shell インスタンスが起動するたびに、ファイル $HOME/.customize_environment が読み取られます。このプロセスの実行ログは /var/log/customize_environment にあります。実行が成功すると /google/devshell/customize_environment_done が作成されます。
新しいシェルプロセスが開始されるたびに（新しいウィンドウ、新しいタブなど）、通常の bash シェル構成ファイルが読み取られます。

次の手順に沿って、両方の練習をします。

次のコマンドを実行して、リポジトリで提供されるカスタマイズを起動します。

cd cloud-code-getting-started
source set_env_cust.sh

これにより、前述のカスタマイズオプションが設定され、有効になります。

新しいシェルプロンプトが表示されます。.bash_profile ファイルでソースされた bash スクリプトは、デフォルトよりも短く、チェックアウトされたブランチや git ステータスなどの基本的な Git 情報を含む新しいプロンプトを構成しています。
cloudshell edit コマンドの新しいエイリアス code が追加されました。これは、より短いエイリアスです。これを使用して、.bash_profile ファイルの内容を確認します。

code $HOME/.bash_profile

新しくインストールされたコマンド bat を使用して、.customize_environment ファイルの内容を確認します。

bat $HOME/.customize_environment

bat は、一般的な Unix ツール cat の拡張版です。bat の出力には、新しい Cloud Shell マシンが起動されるたびに hey（ロードテストツール）を再インストールするために使用される apt install コマンドが表示されています。

Cloud Shell メニュー（右上にある 3 つのドット）をクリックして [再起動] を選択し、すべてが機能していることをテストします。

これにより、Cloud Shell のタイムアウトとインスタンスの再作成をシミュレートして、すべてが正しく構成されていることを確認できます。

Cloud Shell コンテナイメージのカスタマイズ

このカスタマイズオプションを使用すると、追加のパッケージとカスタム構成を使用して、カスタム Cloud Shell 環境として機能する Docker イメージを作成できます。生成されたイメージは、完全にエフェメラルな Cloud Shell インスタンスを起動するため、Cloud Shell VM も、それにアタッチされた $HOME ディレクトリも永続化されません。ただし、このイメージ作成は、関数固有の Cloud Shell インスタンスをサードパーティに提供して、特定のタスクを最も効率的な方法で実行する必要があるユースケースで役立ちます。

前のセクションで行ったように環境をカスタマイズするのではなく、Cloud Shell の起動に使用される新しいイメージに変更を組み込みます。カスタム Cloud Shell の起動が速くなるというメリットがあります。

新しい Cloud Shell イメージの作成

Cloud Shell ターミナルに次のように入力して、Cloud Shell コンテナイメージの作成を開始します。

cloudshell env create-custom-image custom-cloud-shell
cd custom-cloud-shell

これにより、Cloud Shell に新しいディレクトリが作成され、コードをホストする同じ名前の新しい Cloud Source Repositories リポジトリが作成されます。また、$HOME/custom-cloud-shell/ directory にサンプル Dockerfile のクローンを作成します。

Dockerfile の最後の行に RUN apt install -y hey という行を追加します。

echo "RUN apt install -y hey" >> $HOME/custom-cloud-shell/Dockerfile

これにより、.customize_environment で行っていたカスタマイズと同じカスタマイズが設定されますが、コンテナに組み込まれます。

イメージをローカルでビルドします。

cloudshell env build-local

次のコマンドを実行して、新しいイメージをテストします。

cloudshell env run

これで、イメージ内のシェルに移動します。

hey コマンドを実行して、インストールされていることをテストします。

hey

完了したら、「exit」と入力してコンテナを終了します。

exit

変更を Cloud Source Repository に push し、イメージを Container Registry に push します。

git commit -a -m "Initial commit"
git push origin master
cloudshell env push

新しいイメージをテストする

イメージを一般公開して、使用できるようにします。

gsutil iam ch allUsers:objectViewer $(gsutil ls)

公開した Cloud Shell カスタムインスタンスのテストに使用できる URL を生成します。

echo "https://ssh.cloud.google.com/cloudshell/editor?cloudshell_image=gcr.io/$GOOGLE_CLOUD_PROJECT/custom-cloud-shell"

出力 URL をコピーして新しいブラウザタブに貼り付けると、Cloud Shell カスタムインスタンスが開きます。インスタンスにアクセスすると、完全な一時モードで実行されていることを示すバナーが表示されます。

hey コマンドを実行してイメージを再度テストする

hey

完了したら、エフェメラル Cloud Shell インスタンスを exit し、通常の Cloud Shell が開いているタブに戻って、[再接続] をクリックします。

SSH を使用して Cloud Shell にリモートでアクセスする

ローカル PC から Cloud Shell の機能をリモートで使用することもできます。通常、これには次の 2 つの異なるユースケースが含まれます。

ローカルターミナルから Cloud Shell マシンに SSH 接続する
Cloud Shell のリモート $HOME ディレクトリをローカルにマウントします。

これを行うには、Google Cloud SDK がローカルにインストールされている必要があります。また、プロジェクト ID と使用する特定の認証情報を使用して構成する必要があります。

ローカルマシンで実行されているターミナルエミュレータから次の手順を行います。

GCP プロジェクト ID を設定し、Cloud Shell がある Cloud 組織に対応する認証情報でログインします。

gcloud config set project <your project id>
gcloud auth login

リモート Cloud Shell マシンに SSH で接続します。

gcloud cloud-shell ssh --authorize-session

これで Cloud Shell が起動しますが、ローカルターミナルエミュレータの機能と構成が使用されます。使用しているものが tmux をサポートしている場合は、統合をさらに活用してリモートエクスペリエンスを向上させることができます。

ローカルマシンから Cloud Shell ホームディレクトリをマウントする

リモート Cloud Shell インスタンスに SSH 接続できるのは便利ですが、リモート Cloud Shell の $HOME ディレクトリにアクセスできるローカル IDE を使用できると、さらに便利です。これにより、前述の SSH アクセスと、リモートコードをローカルで編集する機能を組み合わせることができます。

これを行うには、まずローカルマシンからマウントポイントを作成します。

mkdir $HOME/cloudshell

これは、Cloud Shell がマウントされるディレクトリです。マウントするには、Cloud Shell インスタンスが起動していることを確認してから、ローカルターミナルに次のように入力します。

$(gcloud cloud-shell get-mount-command $HOME/cloudshell)
cd $HOME/cloudshell

これにより、Cloud Shell をローカルにマウントするために発行する必要があるマウントコマンドが取得され、マウントされます。Cloud Shell ホームディレクトリの内容がローカルマシンにマウントされます。

これで、VSCode などの IDE をローカルで開き、クラウド内のリモートワークスペースを開くことができます。同時に、Cloud Shell への SSH アクセスを使用すると、IDE 内にターミナルペインを開いて、ローカル IDE にリモートターミナルを統合することもできます。

5. Cloud Code の使用

Cloud Code は、開発者がクラウドベースのツールをより効果的に使用できるようにする Google が開発したプラグインです。VSCode や Jetbrains プロダクトなどの複数の IDE やコードエディタで利用でき、利便性を高めるために Cloud Shell エディタにデフォルトで統合されています。Cloud Code には、次のステップで実際に使用するデベロッパー向けの機能が多数用意されています。

Cloud Shell エディタで Cloud Code を見つける

クイックアクセスボタンを使用する

エディタの左側のペインに表示されている次の 4 つのボタンを見つけます。

これらのメニュー項目を使用すると、Cloud Shell エディタから GCP サービスに簡単にアクセスして構成できます。

このラボでは、Kubernetes クラスタに焦点を当てます。

ステータスバーを使用する

Cloud Shell エディタの UI を介して公開される Cloud Cloud の追加部分のうち、関連するものは 2 つあります。エディタの下部バーに両方が表示されます。

<> Cloud Code: ここをクリックすると、このチュートリアルで使用するクイックアクションメニューが表示されます。
minikube を制御する: クラスタの起動や停止などの基本的なアクションで、ローカルの Kubernetes エミュレータである minikube を制御できます。

Minikube インスタンスの作成

ボタンをクリックして、Minikube インスタンスを作成します。

Cloud Code を使用して GKE クラスタを作成する

左側のアイコン Cloud Code - Kubernetes Clusters（）をクリックします。左側に [CLOUD CODE - KUBERNETES: CLUSTERS] という新しいペインが表示されます。
[CLOUD CODE - KUBERNETES: CLUSTERS] の横にある [+] ボタンをクリックし、[Google Kubernetes Engine] を選択します（前に起動した Minikube などの他のオプションを選択することもできます）。

[新しい GKE クラスタを作成する] をクリックします。このオプションを選択すると、右側に新しいペインが読み込まれ、追加情報を入力して開発クラスタをすばやく作成できます。パネルの手順に沿って、次の情報を入力します。

Autopilot を選択する
リージョンを選択する（europe-west-1）
クラスタに「dev」という名前を付けます。

[クラスタを作成] ボタンをクリックします。これにより、新しい Autopilot クラスタが作成されます。

クラスタの作成プロセスには 5 分ほどかかります。クラスタの作成中に、Cloud Code の Kubernetes ペインをもう少し詳しく見てみましょう。

Cloud Code Kubernetes ペインを確認する

先ほど Minikube クラスタを作成しました。準備が完了すると、このクラスタが Cloud Code Kubernetes ペインに表示されます。名前は minikube になります。

クラスタは UI に ACTIVE として表示されます。この設定は、コマンドラインの現在の Kubernetes コンテキストと同期しています。.

Cloud Code Kubernetes ペインには、次の内容が表示されます。

デフォルトの KubeConfig ファイル: Cloud Code はユーザーの ~/.kube/config ファイルを読み取り、それを使用して構成された Kubernetes クラスタに接続します。これにより、簡単に移動できます。必要に応じて、Default Kubeconfig 行にカーソルを合わせて、その横にある外向き矢印の付いた四角をクリックして、Kubeconfig ファイルを編集できます。
登録済みクラスタのさまざまなオブジェクトのブラウジング可能なレンダリング: この場合、以前に作成した minikube Minikube クラスタとそのコンテキスト、Namespace、ノードが表示されます。ツリーのノードをいくつか展開してみましょう。アプリケーションをデプロイしていないため、まだ Pod はありません。

新しい GKE クラスタが起動して実行されると、左側のペインに minikube Minikube クラスタとともに表示されます。クラスタを右クリックして、起動する Cloud Code アクションのクラスタを選択するという意味で「アクティブ」にすることができます。

6. 完了

お疲れさまでした。これでこの Codelab は終了です。

学習した内容

Cloud Shell の主な機能を操作して理解した
さまざまな Cloud Shell の使用パターンを実践した
高度な使用のために Cloud Shell 環境をカスタマイズした
Cloud Code のオプションと機能に精通している
Cloud Code for Kubernetes アプリケーションの詳細を確認した
Minikube などのローカルエミュレータを使用する