Cloud Build を使用した Cloud Run へのデプロイ

このページでは、Cloud Build を使用して Cloud Run サービスを自動的にデプロイする方法を説明します。Cloud Build を初めて使用する場合は、最初にクイックスタートとビルド構成の概要をご覧ください。

Cloud Run を使用すると、サーバーレス環境でステートレス コンテナを実行できます。 Cloud Build を使用すると、Container Registry（非推奨） と Artifact Registry から Cloud Run にコンテナ イメージをデプロイできます。既存のイメージのデプロイ、イメージのビルドとデプロイ、デプロイの自動化が可能です。

注: Cloud Deploy を使用して継続的デリバリー パイプラインを設定し、Cloud Run にデプロイすることもできます。詳細。

始める前に

• Enable the Cloud Build, Cloud Run, Container Registry, and Resource Manager APIs.

  Enable the APIs

• アプリケーションのソースコードを用意します。 ソースコードは、Cloud Source Repositories、GitHub、Bitbucket などのリポジトリに保存する必要があります。

• このページで gcloud コマンドを実行するには、Google Cloud CLI をインストールします。

• VPC Service Controls を使用している場合は、VPC Service Controls の境界にプライベート プールを設定します。また、VPC Service Controls 用に Cloud Run を構成する必要があります。

注意: Container Registry は非推奨で、提供終了となります。2024 年 1 月 8 日より前に Container Registry を使用していない組織では、デフォルトで Artifact Registry に新しい gcr.io リポジトリがホストされます。2024 年 5 月 15 日以降、以前に Container Registry を使用していない Google Cloud プロジェクトでは、Artifact Registry で gcr.io ドメインのイメージのホスティングと管理のみがサポートされます。

Container Registry は 2025 年 3 月 18 日に提供終了となる予定です。サポート終了の詳細については、Container Registry のサポート終了をご覧ください。

注意: 2024 年 6 月 17 日以降、新規のお客様は Cloud Source Repositories をご利用いただけなくなります。組織で以前に Cloud Source Repositories を使用したことがない場合、API を有効にしたり、Cloud Source Repositories を使用したりすることはできません。組織に接続されていない新しいプロジェクトでは、Cloud Source Repositories API を有効にできません。2024 年 6 月 17 日より前に Cloud Source Repositories を使用したことのある組織は、この変更の影響を受けません。

必要な IAM 権限

デプロイ先と同じ Google Cloud プロジェクトにイメージが保存されている場合、またはイメージが Container Registry で公開されている場合は、次の IAM 権限が必要です。

Cloud Run にデプロイするには、ビルドに使用するサービス アカウントに Cloud Run 管理者とサービス アカウント ユーザーのロールを付与します。

1. Google Cloud コンソールで Cloud Build の設定ページを開きます。

   Cloud Build の設定ページに移動

2. プルダウン リストから、ロールを変更するサービス アカウントを選択します。

   

3. [サービス アカウント権限] パネルで、Cloud Run 管理者ロールのステータスを [有効] に設定します。

4. [追加の手順が必要になることがあります] ポップアップで [すべてのサービス アカウントにアクセス権を付与] をクリックします。

注: セキュリティを強化するには、サービス アカウント ユーザーのロールを Cloud Run ランタイム サービス アカウントのみに付与してください。これを行う方法については、最小限の IAM 権限の使用をご覧ください。

コンテナのビルドとデプロイ

Cloud Build を使用すると、コンテナ イメージをビルドして Container Registry にビルドイメージを保存し、そのイメージを Cloud Run にデプロイできます。

コンテナ イメージをビルドしてデプロイするには:

1. プロジェクトのルート ディレクトリに、cloudbuild.yaml という名前で構成ファイルを作成します。

2. ビルド構成ファイルで、イメージをビルドする docker ビルドステップを追加し、イメージを Container Registry に push します。さらに、gcloud run deploy コマンドを呼び出す gcloud ビルドステップを追加し、Cloud Run にイメージをデプロイします。

   steps:
   # Build the container image
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 'gcr.io/PROJECT_ID/IMAGE', '.']
   # Push the container image to Container Registry
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push', 'gcr.io/PROJECT_ID/IMAGE']
   # Deploy container image to Cloud Run
   - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
     entrypoint: gcloud
     args: ['run', 'deploy', 'SERVICE_NAME', '--image', 'gcr.io/PROJECT_ID/IMAGE', '--region', 'SERVICE_REGION']
   images:
   - gcr.io/PROJECT_ID/IMAGE
   

   ここで

   • SERVICE_NAME は、Cloud Run サービスの名前です。
   • SERVICE_REGION は、デプロイする Cloud Run サービスのリージョンです。
   • PROJECT_ID は、イメージが保存されている Google Cloud プロジェクト ID です。
   • IMAGE は、Container Registry 内のイメージの名前です。

3. プロジェクトのルート ディレクトリに移動し、次のコマンドを実行します。BUILD_REGION は、サポートされているビルド リージョンのいずれかで、ビルドを実行します。

    gcloud builds submit --region=BUILD_REGION
   

正常に完了すると、デプロイされたサービスの URL が成功のメッセージと一緒に表示されます。

継続的デプロイ

Cloud Build トリガーを作成すると、ソフトウェアの Cloud Run へのデプロイを自動化できます。トリガーを構成すると、ソースコードを更新するたびにイメージをビルドしてデプロイできます。

デプロイを自動化するには:

1. リポジトリのルートに、イメージをビルドするステップを含む cloudbuild.yaml という名前の構成ファイルを追加し、イメージを Container Registry に push して、gcloud run deploy コマンドを呼び出します。

     steps:
     # Build the container image
     - name: 'gcr.io/cloud-builders/docker'
       args: ['build', '-t', 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA', '.']
     # Push the container image to Container Registry
     - name: 'gcr.io/cloud-builders/docker'
       args: ['push', 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA']
     # Deploy container image to Cloud Run
     - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
       entrypoint: gcloud
       args:
       - 'run'
       - 'deploy'
       - 'SERVICE_NAME'
       - '--image'
       - 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA'
       - '--region'
       - 'SERVICE_REGION'
     images:
     - 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA'
   

   ここで

   • SERVICE_NAME は、Cloud Run サービスの名前です。
   • SERVICE_REGION は、デプロイする Cloud Run サービスのリージョンです。

   $COMMIT_SHA 置換変数は、Git リポジトリからトリガーされたときに Cloud Build によって事前入力されます。

2. 前のステップで作成した構成ファイルを使用して、ビルドトリガーを作成します。

   1. [トリガー] ページを開く

      [トリガー] ページに移動

   2. [トリガーを作成] をクリックします。

   3. [名前] 欄にトリガーの名前を入力します。

   4. [リージョン] で、トリガーのリージョンを選択します。

      注: トリガーのリージョンは、デプロイ先の Cloud Run サービスのリージョンと一致する必要があります。

   5. [イベント] で、リポジトリ イベントを選択してトリガーを開始します。

   6. [ソース] で、トリガーを開始するリポジトリとブランチまたはタグ名を選択します。自動ビルドのブランチを指定する方法については、ビルドトリガーの作成をご覧ください。

   7. [構成] で [Cloud Build 構成ファイル（YAML または JSON）] を選択します。

   8. [Cloud Build 構成ファイルの場所] フィールドで、/ の後に「cloudbuild.yaml」と入力します。

   9. [作成] をクリックして、ビルドトリガーを保存します。

3. これで完了です。これで、リポジトリに push するたびに、Cloud Run サービスのビルドとデプロイが自動的に開始されます。

注: デプロイされたサービスを公開するには、サービスの IAM 設定で 1 回のみ変更します。

リポジトリに新しいコードを push するたびに、ビルドが自動的にトリガーされ、Cloud Run サービスにデプロイされます。

Cloud Build トリガーの作成方法については、ビルドトリガーの作成と管理をご覧ください。

最小限の IAM 権限の使用

コンテナが Cloud Run サービスにデプロイされると、この Cloud Run サービスのランタイム サービス アカウントの ID でコンテナが実行されます。 Cloud Build は新しいコンテナを自動的にデプロイできます。このため、Cloud Run サービスのランタイム サービス アカウントとして機能できるように Cloud Build を構成する必要があります。

Cloud Build に Cloud Run サービスにデプロイする制限付きアクセス権を付与するには、次の手順を行います。

コンソール

1. Google Cloud Console の [サービス アカウント] ページに移動します。

   [サービス アカウント] に移動

2. Cloud Run サービスのランタイム サービス アカウントのメールアドレス（デフォルトは [e-mail]）をクリックします。

3. [権限] タブをクリックします。

4. [ アクセスを許可] をクリックします。

5. Cloud Build サービス アカウントを入力します（[e-mail]）

6. [ロールを選択] プルダウンで、[サービス アカウント] > [サービス アカウント ユーザー] ロールを選択します。

7. [保存] をクリックします。

gcloud

gcloud iam service-accounts add-iam-policy-binding コマンドを使用します。ここで、PROJECT_NUMBER はプロジェクトの数値 ID です。

gcloud iam service-accounts add-iam-policy-binding \
  [e-mail] \
  --member="serviceAccount:[e-mail]" \
  --role="roles/iam.serviceAccountUser"

PROJECT_NUMBER は、プロジェクトの数値 ID に置き換えます。

カスタマイズされたサービス ID を使用して Cloud Run を使用する場合は、[e-mail] をサービス アカウントのアドレスに置き換えます。

詳しくは、デプロイ権限をご覧ください。

コードの例

以下では、いくつかのサンプル リポジトリを紹介します。各リポジトリには、サンプル アプリケーションと、Cloud Run にアプリケーションをデプロイするためのビルド構成ファイルが含まれています。

• deploy-prebuilt: ビルド済みのイメージを Cloud Run にデプロイするコードの例。
• run-example-builddeploy: イメージをビルドして Cloud Run にデプロイするコードの例。

次のステップ

• Cloud Deploy を使用して Cloud Run にデプロイする方法を学習する。
• GKE にデプロイする方法を学習する。
• Cloud Run functions にデプロイする方法を学習する。
• App Engine にデプロイする方法を学習する。
• Firebase にデプロイする方法を学習する。
• Compute Engine で Blue/Green デプロイを実行する方法を学習する。
• ビルドエラーをトラブルシューティングする方法について学習する。