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

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

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

始める前に

  • Cloud Build, Cloud Run, Container Registry, and Resource Manager API を有効にします。

    API を有効にする

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

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

必要な IAM 権限

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

Cloud Run

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

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

    Cloud Build の設定ページに移動

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

    サービス アカウント権限ページのスクリーンショット

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

Cloud Run for Anthos

Cloud Run for Anthos にデプロイするには、Kubernetes Engine デベロッパーのロールを Cloud Build サービス アカウントに付与します。

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

    Cloud Build の設定ページに移動

  2. [サービス アカウント権限] パネルで、Kubernetes Engine デベロッパーのロールのステータスを [有効] に設定します。

    サービス アカウント権限ページのスクリーンショット

イメージがデプロイ先とは異なる Google Cloud プロジェクトに保存されている場合は、他の Google Cloud プロジェクトからイメージをデプロイするで説明しているように、追加の IAM 権限が必要になります。

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

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

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

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

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

    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', 'REGION']
images:
- gcr.io/PROJECT_ID/IMAGE

    ここで

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

    Cloud Run for Anthos 

    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 for Anthos
- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
  entrypoint: gcloud
  args: ['run', 'deploy', 'SERVICE-NAME', '--image', 'gcr.io/PROJECT_ID/IMAGE', '--cluster', 'CLUSTER', '--cluster-location', 'CLUSTER_LOCATION', '--platform', 'gke']
images:
- gcr.io/PROJECT_ID/IMAGE

    ここで

    • SERVICE-NAME は、Cloud Run サービスの名前です。
    • CLUSTER は、Cloud Run for Anthos クラスタの名前です。
    • CLUSTER_LOCATION は、Cloud Run for Anthos クラスタのロケーションです。
    • PROJECT_ID は、イメージが保存されている Google Cloud プロジェクト ID です。
    • IMAGE は、Container Registry 内のイメージの名前です。

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

     gcloud builds submit --region=REGION

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

継続的デプロイ

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

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

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

    Cloud Run

     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'
   - 'REGION'
 images:
 - 'gcr.io/$PROJECT_ID/SERVICE-NAME:$COMMIT_SHA'

    ここで

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

    Cloud Run for Anthos 

     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 for Anthos
 - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
   entrypoint: gcloud
   args:
   - 'run'
   - 'deploy'
   - 'SERVICE-NAME'
   - '--image'
   - 'gcr.io/$PROJECT_ID/SERVICE-NAME:$COMMIT_SHA'
   - '--cluster'
   - 'CLUSTER'
   - '--cluster-location'
   - 'CLUSTER_LOCATION'
   - '--platform'
   - 'gke'
 images:
 - 'gcr.io/$PROJECT_ID/SERVICE-NAME:$COMMIT_SHA'

    ここで

    • SERVICE-NAME は、Cloud Run サービスの名前です。
    • CLUSTER は、Cloud Run for Anthos クラスタの名前です。
    • CLUSTER_LOCATION は、Cloud Run for Anthos クラスタのロケーションです。

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

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

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

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

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

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

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

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

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

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

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

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

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

リポジトリに新しいコードを 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 サービスのランタイム サービス アカウントのメールアドレス（デフォルトは PROJECT_NUMBER-compute@developer.gserviceaccount.com）をクリックします。

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

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

  5. Cloud Build サービス アカウントを入力します（PROJECT_NUMBER@cloudbuild.gserviceaccount.com）

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

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

gcloud

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

gcloud iam service-accounts add-iam-policy-binding \
  PROJECT_NUMBER-compute@developer.gserviceaccount.com \
  --member="serviceAccount:PROJECT_NUMBER@cloudbuild.gserviceaccount.com" \
  --role="roles/iam.serviceAccountUser"

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

カスタマイズされたサービス ID を使用して Cloud Run を使用する場合は、PROJECT_NUMBER-compute@developer.gserviceaccount.com をサービス アカウントのアドレスに置き換えます。

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

コードの例

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

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

次のステップ