この Codelab について
1. はじめに
概要
Cloud Run functions は、Cloud Run と Eventarc を活用した Google Cloud の Functions as a Service サービスです。パフォーマンスとスケーラビリティの高度な制御、関数のランタイムに関するより細かい制御を提供する進化した機能を備え、90 を超えるイベントソースからトリガーできます。
この Codelab では、HTTP 呼び出しに応答し、Pub/Sub メッセージと Cloud Audit Logs によってトリガーされる Cloud Run functions の関数を作成する方法について説明します。
この Codelab では、--base-image
フラグを使用してベースイメージを指定し、関数のデプロイにベースイメージの自動更新も使用します。Cloud Run のベースイメージの自動更新を構成すると、Google はベースイメージのオペレーティング システムと言語ランタイム コンポーネントにセキュリティ パッチを自動的に適用できます。ベースイメージを更新するためにサービスを再ビルドまたは再デプロイする必要はありません。詳細については、ベースイメージの自動更新をご覧ください。
ベースイメージの自動更新を使用しない場合は、この Codelab の例から --base-image
フラグを削除できます。
学習内容
- Cloud Run functions の概要と、ベースイメージの自動更新を使用する方法。
- HTTP 呼び出しに応答する関数を作成する方法。
- Pub/Sub メッセージに応答する関数を作成する方法。
- Cloud Storage イベントに応答する関数を作成する方法。
- 2 つのリビジョン間でトラフィックを分割する方法。
- 最小インスタンスを使用してコールド スタートを回避する方法。
2. 設定と要件
ルートフォルダを作成する
すべてのサンプルのルート フォルダを作成します。
mkdir crf-codelab cd crf-codelab
環境変数を設定する
この Codelab 全体で使用する環境変数を設定します。
gcloud config set project <YOUR-PROJECT-ID> REGION=<YOUR_REGION> PROJECT_ID=$(gcloud config get-value project)
API を有効にする
必要なサービスをすべて有効にします。
gcloud services enable \ artifactregistry.googleapis.com \ cloudbuild.googleapis.com \ eventarc.googleapis.com \ run.googleapis.com \ logging.googleapis.com \ pubsub.googleapis.com
3. HTTP 関数
最初の関数として、HTTP リクエストに応答する認証済みの Node.js 関数を作成します。また、10 分間のタイムアウトを使用して、関数で HTTP リクエストに応答する時間を長くする方法についても説明します。
作成
アプリのフォルダを作成し、そのフォルダに移動します。
mkdir hello-http cd hello-http
HTTP リクエストに応答する index.js
ファイルを作成します。
const functions = require('@google-cloud/functions-framework'); functions.http('helloWorld', (req, res) => { res.status(200).send('HTTP with Node.js in Cloud Run functions!'); });
package.json
ファイルを作成して依存関係を指定します。
{ "name": "nodejs-run-functions-codelab", "version": "0.0.1", "main": "index.js", "dependencies": { "@google-cloud/functions-framework": "^2.0.0" } }
導入
関数をデプロイします。
gcloud run deploy nodejs-run-function \ --source . \ --function helloWorld \ --base-image nodejs22 \ --region $REGION \ --timeout 600 \ --no-allow-unauthenticated
このコマンドは、Buildpack を使用して、関数のソースコードを本番環境対応のコンテナ イメージに変換します。
次の点にご注意ください。
--source
フラグは、関数を実行可能なコンテナベースのサービスにビルドするように Cloud Run に指示するために使用されます。--function
フラグ(新規)は、新しいサービスのエントリ ポイントを、呼び出される関数シグネチャに設定するために使用されます。--base-image
フラグ(新規): 関数のベースイメージ環境を指定します(例:nodejs22
、python312
、go123
、java21
、dotnet8
、ruby33
、php83
)。ベースイメージと各イメージに含まれるパッケージの詳細については、ランタイム ベースイメージをご覧ください。- (省略可)
--timeout
フラグを使用すると、関数で HTTP リクエストに応答するタイムアウトを長くできます。この例では、600 秒を使用して 10 分間のレスポンス時間を示しています。 - (省略可)関数を一般公開から呼び出せないようにする
--no-allow-unauthenticated
テスト
次のコマンドを使用して関数をテストします。
# get the Service URL SERVICE_URL="$(gcloud run services describe nodejs-run-function --region $REGION --format 'value(status.url)')" # invoke the service curl -H "Authorization: bearer $(gcloud auth print-identity-token)" -X GET $SERVICE_URL
レスポンスとして HTTP with Node.js in Cloud Run functions!
というメッセージが表示されます。
4. Pub/Sub 関数
2 番目の関数として、特定のトピックにパブリッシュされた Pub/Sub メッセージによってトリガーされる Python 関数を作成します。
Pub/Sub 認証トークンを設定する
2021 年 4 月 8 日以前に Pub/Sub サービス アカウントを有効にした場合は、Pub/Sub サービス アカウントに iam.serviceAccountTokenCreator
ロールを付与します。
PROJECT_NUMBER=$(gcloud projects list --filter="project_id:$PROJECT_ID" --format='value(project_number)') gcloud projects add-iam-policy-binding $PROJECT_ID \ --member serviceAccount:service-$PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role roles/iam.serviceAccountTokenCreator
作成
サンプルに使用する Pub/Sub トピックを作成します。
TOPIC=cloud-run-functions-pubsub-topic gcloud pubsub topics create $TOPIC
アプリのフォルダを作成し、そのフォルダに移動します。
mkdir ../hello-pubsub cd ../hello-pubsub
CloudEvent ID を含むメッセージをログに記録する main.py
ファイルを作成します。
import functions_framework @functions_framework.cloud_event def hello_pubsub(cloud_event): print('Pub/Sub with Python in Cloud Run functions! Id: ' + cloud_event['id'])
次の内容の requirements.txt
ファイルを作成して、依存関係を指定します。
functions-framework==3.*
導入
関数をデプロイします。
gcloud run deploy python-pubsub-function \ --source . \ --function hello_pubsub \ --base-image python313 \ --region $REGION \ --no-allow-unauthenticated
サービス アカウント ID に使用するプロジェクト番号を取得します。
PROJECT_NUMBER=$(gcloud projects list --filter="project_id:$PROJECT_ID" --format='value(project_number)')
トリガーを作成する
gcloud eventarc triggers create python-pubsub-function-trigger \ --location=$REGION \ --destination-run-service=python-pubsub-function \ --destination-run-region=$REGION \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --transport-topic=projects/$PROJECT_ID/topics/$TOPIC \ --service-account=$PROJECT_NUMBER-compute@developer.gserviceaccount.com
テスト
トピックにメッセージを送信して関数をテストします。
gcloud pubsub topics publish $TOPIC --message="Hello World"
受信した CloudEvent がログに表示されます。
gcloud run services logs read python-pubsub-function --region $REGION --limit=10
5. Cloud Storage 関数
次の関数では、Cloud Storage バケットのイベントに応答する Node.js 関数を作成します。
設定
Cloud Storage の関数を使用するには、Cloud Storage サービス アカウントに pubsub.publisher
IAM ロールを付与します。
SERVICE_ACCOUNT=$(gsutil kms serviceaccount -p $PROJECT_NUMBER) gcloud projects add-iam-policy-binding $PROJECT_ID \ --member serviceAccount:$SERVICE_ACCOUNT \ --role roles/pubsub.publisher
作成
アプリのフォルダを作成し、そのフォルダに移動します。
mkdir ../hello-storage cd ../hello-storage
Cloud Storage イベントにのみ応答する index.js
ファイルを作成します。
const functions = require('@google-cloud/functions-framework'); functions.cloudEvent('helloStorage', (cloudevent) => { console.log('Cloud Storage event with Node.js in Cloud Run functions!'); console.log(cloudevent); });
package.json
ファイルを作成して依存関係を指定します。
{ "name": "nodejs-crf-cloud-storage", "version": "0.0.1", "main": "index.js", "dependencies": { "@google-cloud/functions-framework": "^2.0.0" } }
導入
まず、Cloud Storage バケットを作成します(または既存のバケットを使用します)。
export BUCKET_NAME="gcf-storage-$PROJECT_ID" export BUCKET="gs://gcf-storage-$PROJECT_ID" gsutil mb -l $REGION $BUCKET
関数をデプロイします。
gcloud run deploy nodejs-crf-cloud-storage \ --source . \ --base-image nodejs22 \ --function helloStorage \ --region $REGION \ --no-allow-unauthenticated
関数がデプロイされると、Cloud コンソールの [Cloud Run] セクションに表示されます。
次に、Eventarc トリガーを作成します。
BUCKET_REGION=$REGION gcloud eventarc triggers create nodejs-crf-cloud-storage-trigger \ --location=$BUCKET_REGION \ --destination-run-service=nodejs-crf-cloud-storage \ --destination-run-region=$REGION \ --event-filters="type=google.cloud.storage.object.v1.finalized" \ --event-filters="bucket=$BUCKET_NAME" \ --service-account=$PROJECT_NUMBER-compute@developer.gserviceaccount.com
テスト
バケットにファイルをアップロードして関数をテストします。
echo "Hello World" > random.txt gsutil cp random.txt $BUCKET/random.txt
受信した CloudEvent がログに表示されます。
gcloud run services logs read nodejs-crf-cloud-storage --region $REGION --limit=10
6. トラフィック分割
Cloud Run functions は、関数の複数のリビジョンをサポートしています。トラフィックを異なるリビジョン間で分割し、関数を以前のバージョンにロールバックできます。
このステップでは、関数の 2 つのリビジョンをデプロイし、トラフィックを 50% ずつ分割します。
作成
アプリのフォルダを作成し、そのフォルダに移動します。
mkdir ../traffic-splitting cd ../traffic-splitting
色の環境変数を読み取り、その背景色で Hello World
を返す Python 関数を含む main.py
ファイルを作成します。
import os color = os.environ.get('COLOR') def hello_world(request): return f'<body style="background-color:{color}"><h1>Hello World!</h1></body>'
次の内容の requirements.txt
ファイルを作成して、依存関係を指定します。
functions-framework==3.*
導入
オレンジ色の背景で関数の最初のリビジョンをデプロイします。
COLOR=orange gcloud run deploy hello-world-colors \ --source . \ --base-image python313 \ --function hello_world \ --region $REGION \ --allow-unauthenticated \ --update-env-vars COLOR=$COLOR
この時点で、ブラウザで HTTP トリガー(上記のデプロイ コマンドの URI 出力)を表示して関数をテストすると、オレンジ色の背景の Hello World
が表示されます。
黄色の背景の 2 番目のリビジョンをデプロイします。
COLOR=yellow gcloud run deploy hello-world-colors \ --source . \ --base-image python313 \ --function hello_world \ --region $REGION \ --allow-unauthenticated \ --update-env-vars COLOR=$COLOR
これは最新のリビジョンであるため、関数をテストすると、黄色の背景の Hello World
が表示されます。
トラフィックを 50% ずつ分割する
オレンジ色と黄色のリビジョン間でトラフィックを分割するには、Cloud Run サービスのリビジョン ID を見つける必要があります。リビジョン ID を表示するコマンドは次のとおりです。
gcloud run revisions list --service hello-world-colors \ --region $REGION --format 'value(REVISION)'
出力例を以下に示します。
hello-world-colors-00001-man hello-world-colors-00002-wok
次のように、この 2 つのリビジョン間でトラフィックを分割します(リビジョン名に応じて X-XXX
を更新します)。
gcloud run services update-traffic hello-world-colors \ --region $REGION \ --to-revisions hello-world-colors-0000X-XXX=50,hello-world-colors-0000X-XXX=50
テスト
公開 URL にアクセスして関数をテストします。半分はオレンジ色のリビジョンが、もう半分は黄色のリビジョンが表示されます。
詳細については、ロールバック、段階的なロールアウト、トラフィックの移行をご覧ください。
7. 最小インスタンス数
Cloud Run functions では、ウォーム状態を維持し、いつでもリクエストを処理できる関数インスタンスの最小数を指定できます。これは、コールド スタートの数を制限するのに役立ちます。
このステップでは、初期化に時間がかかる関数をデプロイします。コールド スタートの問題が発生します。次に、最小インスタンス値を 1 に設定して関数をデプロイし、コールド スタートを回避します。
作成
アプリのフォルダを作成し、そのフォルダに移動します。
mkdir ../min-instances cd ../min-instances
main.go
ファイルを作成します。この Go サービスには、10 秒間スリープして長時間の初期化をシミュレートする init
関数があります。また、HTTP 呼び出しに応答する HelloWorld
関数もあります。
package p import ( "fmt" "net/http" "time" ) func init() { time.Sleep(10 * time.Second) } func HelloWorld(w http.ResponseWriter, r *http.Request) { fmt.Fprint(w, "Slow HTTP Go in Cloud Run functions!") }
導入
デフォルトの最小インスタンス値 0 で関数の最初のリビジョンをデプロイします。
gcloud run deploy go-slow-function \ --source . \ --base-image go123 \ --function HelloWorld \ --region $REGION \ --no-allow-unauthenticated
次のコマンドを使用して関数をテストします。
# get the Service URL SERVICE_URL="$(gcloud run services describe go-slow-function --region $REGION --format 'value(status.url)')" # invoke the service curl -H "Authorization: bearer $(gcloud auth print-identity-token)" -X GET $SERVICE_URL
最初の呼び出しでは 10 秒の遅延(コールド スタート)が発生し、その後メッセージが表示されます。以降の呼び出しはすぐに返されます。
最小インスタンス数を設定する
最初のリクエストでコールド スタートが発生しないようにするには、次のように --min-instances
フラグを 1 に設定して関数を再デプロイします。
gcloud run deploy go-slow-function \ --source . \ --base-image go123 \ --function HelloWorld \ --region $REGION \ --no-allow-unauthenticated \ --min-instances 1
テスト
関数を再度テストします。
curl -H "Authorization: bearer $(gcloud auth print-identity-token)" -X GET $SERVICE_URL
最初のリクエストで 10 秒の遅延は発生しなくなります。最小インスタンス数により、長い間使用していなかった後の最初の呼び出しで発生するコールド スタートの問題が解消されました。
詳細については、最小インスタンスの使用をご覧ください。
8. お疲れさまでした
以上で、この Codelab は完了です。
学習した内容
- Cloud Run functions の概要と、ベースイメージの自動更新を使用する方法。
- HTTP 呼び出しに応答する関数を作成する方法。
- Pub/Sub メッセージに応答する関数を作成する方法。
- Cloud Storage イベントに応答する関数を作成する方法。
- 2 つのリビジョン間でトラフィックを分割する方法。
- 最小インスタンスを使用してコールド スタートを回避する方法。