開発環境

1. 概要

このラボでは、コンテナ化された環境で Python アプリケーションの開発を担当するソフトウェア エンジニアの開発ワークフローを効率化するために設計された機能について説明します。一般的なコンテナ開発では、コンテナの詳細とコンテナ ビルドプロセスを理解する必要があります。また、デベロッパーは通常、フローを中断して IDE から移動し、リモート環境でアプリケーションをテストしてデバッグする必要があります。このチュートリアルで説明したツールとテクノロジーを使用すると、開発者は IDE を離れることなく、コンテナ化されたアプリケーションを効率的に操作できます。

Cloud Workstations とは

Cloud Workstations は、セキュリティ機能が組み込まれ、事前構成済みでカスタマイズ可能な開発環境がある Google Cloud 上でマネージド開発環境を提供します。Cloud Workstations には、ブラウザベースの IDE、複数のローカルコード エディタ（VSCode など、または IntelliJ IDEA Ultimate や PyCharm Professional などの JetBrains IDE）から、または SSH を介してアクセスします。

Cloud Workstations は次のリソースを使用します。

• 管理者がワークステーション クラスタを作成する
• 各ワークステーション クラスタで、管理者はワークステーションのテンプレートとして機能する 1 つ以上のワークステーション構成を作成します。
• 開発者は、クラウド IDE、言語ツール、ライブラリなどを提供する開発環境を定義するワークステーションを作成できます。

Cloud Workstations を使用すると、IT 管理者やセキュリティ管理者は、開発環境のプロビジョニング、スケーリング、管理、保護を簡単に行うことができます。また、デベロッパーは一貫した構成とカスタマイズ可能なツールを使用して開発環境にアクセスできます。

Cloud Workstations は、アプリケーション開発環境のセキュリティ ポスチャーを強化することで、セキュリティのシフトレフトに役立ちます。VPC Service Controls、非公開の上り（内向き）または下り（外向き）ネットワーク、強制イメージ更新、Identity and Access Management アクセス ポリシーなどのセキュリティ機能を備えています。

Cloud Code とは何ですか？

Cloud Code は、サンプル テンプレートを利用した新しいアプリケーションの作成やカスタマイズから、完成したアプリケーションの実行にいたるまで、Kubernetes および Cloud Run アプリケーションの開発サイクル全体を IDE でサポートしています。Cloud Code ではすぐに実行可能なサンプル、そのまま使用可能な構成スニペット、カスタマイズされたデバッグ機能が用意されているため、Kubernetes と Cloud Run での開発がより簡単になります。

Cloud Code の機能は次のとおりです。

• アプリケーションの継続的なビルドと実行
• 開発中の Kubernetes アプリケーションのデバッグのサポート
• ログのストリーミングと表示

Cloud Code のその他の機能の詳細を確認する。

学習内容

このラボでは、GCP でコンテナを使用して開発する方法について学びます。

• Cloud Workstations を確認する
• ワークステーションを起動
• Cloud Code を確認する
• Kubernetes でのデバッグ

2. 設定と要件

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

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

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

注意: プロジェクト ID はグローバルに一意である必要があります。選択されたプロジェクト ID を他のユーザーが使用することはできません。その ID を使用するのはご自身のみです。プロジェクトを削除しても、その ID を再使用することはできません。

注: Gmail アカウントを使用している場合は、デフォルトの場所の設定は [組織なし] のままにしてかまいません。Google Workspace アカウントを使用している場合は、組織に適した場所を選択してください。

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

環境設定

Cloud Shell で、プロジェクトのプロジェクト ID とプロジェクト番号を設定します。これらの情報は、PROJECT_ID 変数と PROJECT_ID 変数として保存します。

export PROJECT_ID=$(gcloud config get-value project)
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID \
    --format='value(projectNumber)')

このラボでは、コードを GKE にデプロイします。また、IDE として Cloud Workstations も使用します。

次の設定スクリプトは、このインフラストラクチャを準備します。

1. 設定スクリプトをダウンロードして実行可能にします。

wget https://raw.githubusercontent.com/GoogleCloudPlatform/container-developer-workshop/main/labs/python/setup_with_cw.sh
chmod +x setup_with_cw.sh

2. setup_with_cw.sh ファイルを開き、現在 CHANGEME に設定されているパスワードの値を編集します。
3. 設定スクリプトを実行して、このラボで使用する GKE クラスタを起動します。この設定には 20 分ほどかかります。

./setup_with_cw.sh &

4. Cloud Console で Cloud Workstations を開きます。クラスタが READY ステータスになるまで待ってから、次のステップに進みます。
5. Cloud Shell セッションが切断された場合は、[再接続] をクリックしてから、gcloud CLI コマンドを実行してプロジェクト ID を設定します。コマンドを実行する前に、以下のサンプル プロジェクト ID を Qwiklabs プロジェクト ID に置き換えます。

gcloud config set project qwiklabs-gcp-project-id

6. ターミナルで次のスクリプトをダウンロードして実行し、Cloud Workstations 構成を作成します。

wget https://raw.githubusercontent.com/GoogleCloudPlatform/container-developer-workshop/main/labs/python/workstation_config_setup.sh
chmod +x workstation_config_setup.sh
./workstation_config_setup.sh

Cloud Workstations クラスタと構成

Cloud Console で Cloud Workstations を開きます。クラスタが READY ステータスであることを確認します。

既存の構成のステータスを確認します。

新しいワークステーションを作成します。

名前を my-workstation に変更し、既存の構成 codeoss-python を選択します。

ワークステーションを起動

1. ワークステーションを起動します。ワークステーションの起動には数分かかります。

2. アドレスバーのアイコンをクリックして、サードパーティ Cookie を許可します。

3. [サイトが動作していない場合] をクリックします。

4. [Cookie を許可] をクリックします。

5. ワークステーションが起動すると、Code OSS IDE が表示されます。

ワークステーション IDE の [スタートガイド] ページで [完了] をクリックします。

3. Cloud Code の概要

Cloud Code で使用できるさまざまなセクションを確認します。

• Kubernetes 開発。IDE 内で完全に統合された Kubernetes 開発、デバッグ環境が手に入ります。IDE 内から直接クラスタを作成、管理できます。
• 実行中のアプリケーションをデバッグします。Cloud Code for VS Code や Cloud Code for IntelliJ で IDE 内のコードをデバッグするには、組み込みの IDE デバッグ機能を利用します。
• デプロイメントを把握します。Kubernetes クラスタと Cloud Run サービスで使用する、基盤となるリソースとメタデータを確認します。説明文を取得したり、ログを表示したり、シークレットを管理したり、ターミナルで直接 Pod に入ったりすることができます。
• Kubernetes のローカル開発をシンプルにする。Cloud Code for IDE は Skaffold、Jib、kubectl など一般的なツールをバックグラウンドで使用してコードに対する継続的なフィードバックをリアルタイムで提供します。

Google Cloud にログインする

1. Cloud Code アイコンをクリックし、[Sign in to Google Cloud] を選択します。

2. [ログインに進む] をクリックします。

3. ターミナルで出力を確認し、リンクを開きます。

4. Qwiklabs の受講者用認証情報でログインします。

5. [許可] を選択します。

6. 確認コードをコピーして、[ワークステーション] タブに戻ります。

7. 確認コードを貼り付けて Enter キーを押します。

このメッセージが表示されたら、[許可] ボタンをクリックして、ワークステーションにコピー＆ペーストできるようにします。

4. 新しい Python スターター アプリケーションを作成する

このセクションでは、新しい Python アプリケーションを作成します。

1. 新しいターミナルを開きます。

2. 新しいディレクトリを作成してワークスペースとして開く

mkdir music-service && cd music-service

code-oss-cloud-workstations -r --folder-uri="$PWD"

3. requirements.txt という名前のファイルを作成し、次の内容をコピーします。

Flask
gunicorn
ptvsd==4.3.2

4. app.py という名前のファイルを作成し、次のコードを貼り付けます。

import os
from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route("/")
def hello_world():
    message="Hello, World!"
    return message

if __name__ == '__main__':
    server_port = os.environ.get('PORT', '8080')
    app.run(debug=False, port=server_port, host='0.0.0.0')

5. Dockerfile という名前のファイルを作成し、次の内容を貼り付けます。

FROM python:3.8
ARG FLASK_DEBUG=0
ENV FLASK_DEBUG=$FLASK_DEBUG
ENV FLASK_APP=app.py
WORKDIR /app
COPY requirements.txt .
RUN pip install --trusted-host pypi.python.org -r requirements.txt
COPY . .
ENTRYPOINT ["python3", "-m", "flask", "run", "--port=8080", "--host=0.0.0.0"]

注: FLASK_DEBUG=1 を使用すると、Python Flask アプリへのコード変更を自動的に再読み込みできます。この Dockerfile では、この値をビルド引数として渡すことができます。

マニフェストを生成する

ターミナルで次のコマンドを実行して、デフォルトの skaffold.yaml と deployment.yaml を生成します。

1. 次のコマンドで Skaffold を初期化します。

skaffold init --generate-manifests

プロンプトが表示されたら、矢印キーでカーソルを移動し、Space キーでオプションを選択します。

次のいずれかを選択:

• ポートの 8080
• y をクリックして構成を保存します。

Skaffold 構成を更新する

• デフォルトのアプリケーション名を変更する
• skaffold.yaml を開く
• 現在 dockerfile-image として設定されているイメージ名を選択します。
• 右クリックして [すべての出現箇所を変更] を選択します。
• 新しい名前を python-app として入力します。
• ビルド セクションをさらに編集して、
• docker.buildArgs をパス FLASK_DEBUG=1 に追加
• 同期設定により、IDE から実行中のコンテナに *.py ファイルの変更が読み込まれる

編集後の skaffold.yaml ファイルのビルド セクションは次のようになります。

build:
 artifacts:
 - image: python-app
   docker:
     buildArgs:
       FLASK_DEBUG: "1"
     dockerfile: Dockerfile
   sync:
     infer:
     - '**/*.py'

Kubernetes 構成ファイルを変更する

1. デフォルトの名前を変更する

• deployment.yaml ファイルを開く
• 現在 dockerfile-image として設定されているイメージ名を選択します。
• 右クリックして [すべての出現箇所を変更] を選択します。
• 新しい名前を python-app として入力します。

5. 開発プロセスを理解する

ビジネス ロジックを追加したので、アプリケーションをデプロイしてテストできるようになりました。次のセクションでは、Cloud Code プラグインの使用例を紹介します。このプラグインは、skaffold と統合して開発プロセスを効率化します。次の手順で GKE にデプロイすると、Cloud Code と Skaffold がコンテナ イメージを自動的にビルドして Container Registry に push し、your アプリケーションを GKE にデプロイします。これは舞台裏で行われ、デベロッパー フローから詳細が抽象化されます。

Kubernetes クラスタを追加する

1. クラスタを追加する

2. [Google Kubernetes Engine] を選択します。

3. プロジェクトを選択します。

4. 初期設定で作成された「python-cluster」を選択します。

5. これで、クラスタが Cloud Code の Kubernetes クラスタのリストに表示されます。ここからクラスタをナビゲートして探索します。

Kubernetes へのデプロイ

1. Cloud Shell エディタの下部にあるペインで、Cloud Code  を選択します。

2. 上部に表示されるパネルで、[Kubernetes 上で実行する] を選択します。

プロンプトが表示されたら、[Yes] を選択して現在の Kubernetes コンテキストを使用します。

このコマンドは、ソースコードのビルドを開始し、テストを実行します。ビルドとテストの実行には数分かかります。テストには、単体テストと、デプロイ環境に設定されたルールをチェックする検証ステップが含まれています。この検証ステップはすでに構成されており、開発環境で作業している場合でも、デプロイの問題に関して警告が表示されます。

3. コマンドを初めて実行すると、画面上部に現在の Kubernetes コンテキストを使用するかどうかを尋ねるプロンプトが表示されます。[Yes] を選択して、現在のコンテキストを受け入れて使用します。
4. 次に、使用するコンテナ レジストリを尋ねるプロンプトが表示されます。Enter キーを押して、指定されたデフォルト値を受け入れます。
5. 下部ペインの [出力] タブを選択して、進行状況と通知を表示します。プルダウンを使用して [Kubernetes: Run/Debug] を選択します。

6. 右側のチャンネル プルダウンで [Kubernetes: Run/Debug - Detailed] を選択すると、追加の詳細とコンテナからライブ ストリーミングされるログが表示されます。

ビルドとテストが完了すると、[出力] タブのログに URL http://localhost:8080 が [Kubernetes: Run/Debug] ビューに表示されます。

7. Cloud Code ターミナルで、出力の最初の URL（http://localhost:8080）にカーソルを合わせ、表示されたツールチップで [Open Web Preview] を選択します。
8. 新しいブラウザタブが開き、Hello, World! というメッセージが表示されます。

ホットリロード

1. app.py ファイルを開きます。
2. 応答メッセージを Hello from Python に変更します

Output ウィンドウの Kubernetes: Run/Debug ビューで、更新されたファイルが Kubernetes のコンテナと同期されていることがすぐにわかります。

Update initiated
Build started for artifact python-app
Build completed for artifact python-app

Deploy started
Deploy completed

Status check started
Resource pod/python-app-6f646ffcbb-tn7qd status updated to In Progress
Resource deployment/python-app status updated to In Progress
Resource deployment/python-app status completed successfully
Status check succeeded
...

3. Kubernetes: Run/Debug - Detailed ビューに切り替えると、ファイル変更が認識され、アプリがビルドされて再デプロイされていることがわかります。

files modified: [app.py]
Syncing 1 files for gcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Copying files:map[app.py:[/app/app.py]]togcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Watching for changes...
[python-app] * Detected change in '/app/app.py', reloading
[python-app] * Restarting with stat
[python-app] * Debugger is active!
[python-app] * Debugger PIN: 744-729-662

4. 以前の結果が表示されたブラウザタブを更新して、更新された結果を表示します。

デバッグ

1. デバッグビューに移動し、現在のスレッドを停止します 。実行後にクリーンアップするかどうかを尋ねられた場合は、クリーンアップすることを選択できます。
2. 
3. 下部のメニューで Cloud Code をクリックし、Debug on Kubernetes を選択して、debug モードでアプリケーションを実行します。

• Output ウィンドウの Kubernetes Run/Debug - Detailed ビューで、skaffold がこのアプリケーションをデバッグモードでデプロイすることを確認します。

4. 初回実行時には、コンテナ内のソースの場所を尋ねるプロンプトが表示されます。この値は Dockerfile のディレクトリに関連しています。

Enter キーを押してデフォルトを受け入れます

アプリケーションのビルドとデプロイには数分かかります。デバッグ セッションが切断された場合は、「開発セッション」セクションの「Kubernetes でデバッグする」の手順を再度実行します。

5. プロセスが完了したとき。デバッガが接続され、[出力] タブに Attached debugger to container "python-app-8476f4bbc-h6dsl" successfully. と表示され、URL http://localhost:8080 が表示されます。

Port forwarding pod/python-app-8bd64cf8b-cskfl in namespace default, remote port 5678 -> http://127.0.0.1:5678

6. 下部のステータスバーの色が青からオレンジに変わり、デバッグモードになっていることを示します。

7. Kubernetes Run/Debug ビューで、デバッグ可能なコンテナが起動していることを確認します。

**************URLs*****************
Forwarded URL from service python-app: http://localhost:8080
Debuggable container started pod/python-app-8bd64cf8b-cskfl:python-app (default)
Update succeeded
***********************************

ブレークポイントを活用する

1. app.py ファイルを開きます。
2. return message と書かれたステートメントを見つけます。
3. 行番号の左側にある余白をクリックして、その行にブレークポイントを追加します。ブレークポイントが設定されたことを示す赤いインジケーターが表示されます。
4. ブラウザを再読み込みします。デバッガがブレークポイントでプロセスを停止し、GKE でリモートで実行されているアプリケーションの変数と状態を調べることができます。
5. [変数] セクションをクリックします。
6. [Locals] をクリックすると、"message" 変数が表示されます。
7. 変数名「message」をダブルクリックし、ポップアップで値を "Greetings from Python" など別の値に変更します。
8. デバッグ コントロール パネルの [続行] ボタンをクリックします。
9. ブラウザでレスポンスを確認します。入力した更新後の値が表示されます。
10. 停止ボタン を押して [デバッグ] モードを停止し、ブレークポイントをもう一度クリックしてブレークポイントを削除します。

6. クリーンアップ

おめでとうございます！このラボでは、新しい Python アプリケーションをゼロから作成し、コンテナで効果的に動作するように構成しました。次に、従来のアプリケーション スタックと同じデベロッパー フローに従って、アプリケーションをリモート GKE クラスタにデプロイしてデバッグしました。

ラボの完了後にクリーンアップするには:

1. ラボで使用したファイルを削除する

cd ~ && rm -rf ~/music-service

2. プロジェクトを削除して、関連するインフラストラクチャとリソースをすべて削除する

—

最終更新日: 2023 年 3 月 22 日