Webhook イベントに応答してビルドを自動化する

Cloud Build では、着信 Webhook イベントの認証と受け入れができる Webhook トリガーを定義できます。これらのイベントはカスタム URL に送信されると、Bitbucket.com、Bitbucket Server、GitLab などの外部システムと外部ソースコード管理システムを Webhook イベントを介して Cloud Build に直接接続できます。

Webhook トリガーを使用すると、トリガーを作成するときにソースを指定せずにインライン ビルド構成ファイルを定義できます。インライン ビルド構成を使用すると、Git オペレーションを制御し、ビルドの残りの部分を定義できます。

このページでは、Webhook イベントに応答してビルドを自動化する Webhook トリガーを作成する方法について説明します。

始める前に

  • Enable the Cloud Build and Secret Manager APIs.

    Enable the APIs

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

Webhook トリガーの作成

コンソール

Google Cloud Console を使用して Webhook トリガーを作成するには、以下の操作を行います。

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

    [ビルドトリガー] ページを開く

  2. ページ上部でプロジェクトを選択し、[開く] をクリックします。

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

  4. 次のトリガー設定を入力します。

    • 名前: トリガーの名前。

    • リージョン: トリガーのリージョンを選択します。

      • トリガーに関連付けられたビルド構成ファイルでプライベート プールが指定されている場合、Cloud Build は、そのプライベート プールを使用してビルドを実行します。この場合、トリガーで指定するリージョンは、プライベート プールを作成したリージョンと一致する必要があります。
      • トリガーに関連付けられたビルド構成ファイルでプライベート プールが指定されていない場合、Cloud Build はデフォルトのプールを使用してトリガーと同じリージョンでビルドを実行します。

    • 説明（省略可）: トリガーの説明。

    • イベント: [Webhook イベント] を選択して、受信 Webhook イベントにレスポンスしてビルドを開始するトリガーを設定します。

    • Webhook URL: Webhook URL を使用して、受信 Webhook イベントを認証します。

      • シークレット: 受信 Webhook イベントを認証するためのシークレットが必要になります。新しいシークレットを作成することも、既存のシークレットを使用することもできます。 このシークレットは、SSH 認証鍵に関連付けられたシークレットとは別のものです。

        新しいシークレットを作成するには:

        1. [新しいシークレット（Cloud Build で生成）を使用する] を選択します。

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

          [Webhook シークレットの作成] ポップアップ ボックスが表示されます。

        3. [シークレット名] フィールドにシークレットの名前を入力します。

        4. [シークレットを作成] をクリックしてシークレットを保存します。クリックすると、シークレットが自動的に作成され Secret Manager に保存されます。

        既存の Secret を使用するには:

        1. [既存のシークレットを使用するか独自のシークレットを作成する] を選択します。
        2. [シークレット] フィールドで、使用するシークレットの名前をプルダウン メニューから選択するか、指示に従ってリソース ID でシークレットを追加します。
        3. [シークレットのバージョン] フィールドで、プルダウン メニューからシークレットのバージョンを選択します。

        既存のシークレットを使用する場合は、Secret Manager のシークレット アクセサーのロールを Cloud Build サービス アカウント service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com に手動で付与する必要があります。詳しくは、サービス アカウントに Secret Manager のロールを付与するをご覧ください。

      シークレットを作成または選択すると、Webhook URL のプレビューが表示されます。URL には、Cloud Build によって生成された API キーとシークレットが含まれます。Cloud Build で API キーを取得できない場合は、手動で API キーを URL に追加するか、API キーの取得方法（API キーがない場合）をご覧ください。

      この URL を使用して POST メソッドで HTTP リクエストを行うことで、Webhook イベントを呼び出すことができます。

      Webhook イベントを呼び出すには、次のコマンドを使用します。

      curl -X POST -H "Content-type: application/json" "https://cloudbuild.googleapis.com/v1/projects/${PROJECT_ID}/locations/${REGION}/triggers/${TRIGGER_NAME}:webhook?key=${API_KEY}&secret=${SECRET_VALUE}&trigger=${TRIGGER_NAME}&projectId=${PROJECT_ID}" -d "{}"

      これらの手順を完了すると、Secret Manager のシークレット アクセサーのロールが Cloud Build サービス アカウント service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com に自動的に付与されます。このロールがサービス アカウントに自動的に追加されない場合は、サービス アカウントに Secret Manager のロールを付与するで説明されている手順を実行してください。

    • ソース（省略可）: Webhook トリガーの実行時にビルドするソースを選択します。インライン ビルド構成を指定する場合は、次のソースを指定する必要はありません。 ソースとして第 1 世代または第 2 世代を指定できます。詳細については、Cloud Build リポジトリをご覧ください。

      • リポジトリ: 使用可能なリポジトリのリストから目的のリポジトリを選択します。

      • ブランチまたはタグ: ブランチまたはタグの値にマッチングさせる正規表現を指定します。有効な正規表現の構文については、RE2 構文をご覧ください。

      • コメント制御: イベントとして pull リクエスト（GitHub アプリのみ）を選択した場合は、ビルドをトリガーによって自動的に実行するかどうか、次のいずれかのオプションを選択します。

        • Required except for owners and collaborators: pull リクエストがリポジトリ所有者または共同編集者によって作成または更新されると、ビルドが自動的にトリガーによって実行されます。外部の投稿者がアクションを開始する場合、その pull リクエストで所有者または共同編集者が /gcbrun にコメントした後にのみビルドが実行されます。

        • 必須: 投稿者を問わず pull リクエストが作成または更新されると、所有者または共同編集者が pull リクエストに /gcbrun とコメントした後にのみビルドが実行されます。ビルドは、pull リクエストが変更されるたびに実行されます。

        • 不要: 投稿者を問わず pull リクエストが作成または更新されると、ビルドが自動的にトリガーで実行されます。

    • 構成: ビルドに使用するリモート リポジトリにあるビルド構成ファイルを選択するか、インライン ビルド構成ファイルを作成します。ソース リポジトリを指定しない場合は、構成オプションとして [インライン] ビルド構成ファイルを選択する必要があります。

      • タイプ: ビルドに使用する構成のタイプを選択します。
        • Cloud Build 構成ファイル（yaml または json）: 構成にビルド構成ファイルを使用します。
        • Dockerfile: 構成には Dockerfile を使用します。
        • Buildpacks: 構成には Buildpacks を使用します。

      • 場所: 構成の場所を指定します。

        • リポジトリ: 構成ファイルがリモート リポジトリにある場合は、ビルド構成ファイル、Dockerfile ディレクトリの場所、または Bullpack のディレクトリを指定します。ビルド構成タイプが Dockerfile または buildpack の場合、ビルドするイメージの名前と、必要に応じてビルドのタイムアウトを指定する必要があります。Dockerfile または buildpack イメージ名を指定すると、ビルドが実行される docker build または pack コマンドのプレビューが表示されます。
        • buildpack の環境変数（省略可）: 構成タイプとして buildpacks を選択した場合、[パック環境変数を追加] をクリックして buildpack 環境変数と値を指定します。buildpack 環境変数の詳細については、環境変数をご覧ください。

        • インライン: 構成オプションとして Cloud Build 構成ファイル（yaml または json）を選択した場合、インライン ビルド構成を指定できます。Google Cloud Console で [エディタを開く] をクリックして、YAML または JSON 構文でビルド構成ファイルを書き込みます。[完了] をクリックしてビルド構成ファイルを保存します。

      次の例では、インライン ビルド構成ファイルのログに「hello world」とエコーされます。

       steps:
 - name: 'ubuntu'
   args: ['echo', 'hello world']

    • 置換（省略可）: ビルド構成オプションとしてビルド構成ファイルを選択した場合、またはインライン ビルド構成ファイルを作成した場合、このフィールドを使用して、トリガー固有の置換変数を定義できます。置換変数の値を定義するときに、ペイロード バインディングを使用してデータを取得することもできます。

    • フィルタ（省略可）: 置換変数に基づいてビルドを実行するかどうかを決定するルールをトリガー内に作成できます。

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

gcloud

Webhook トリガーを作成するには、以下を実行します。

gcloud builds triggers create webhook \
  --region=REGION \
  --name=TRIGGER_NAME \
  --repository=projects/PROJECT_ID/locations/REGION/connections/CONNECTION_NAME/repositories/REPO_NAME \
  --secret=projects/PROJECT_ID/secrets/SECRET_NAME/versions/SECRET_VERSION \
  --substitutions=_SUB_ONE='$(body.message.test)',_SUB_TWO='$(body.message.output)' \
  --subscription-filter='_SUB_ONE == "prod"' \
  --inline-config=PATH_TO_INLINE_BUILD_CONFIG \
  --tag=TAG_NAME
  # --build-config=PATH_TO_BUILD_CONFIG \
  # --branch=BRANCH_NAME

ここで

  • REGION はトリガーのリージョンです。
  • TRIGGER_NAME はトリガーの名前です。
  • PROJECT_ID は Cloud プロジェクト ID です。
  • CONNECTION_NAME は、ホスト接続の名前です。
  • REPO_NAME はリポジトリの名前です。
  • SECRET_NAME はシークレット マネージャーに保存されているシークレットの名前です。
  • SECRET_VERSION は、Secret Manager に保存されている Secret に関連付けられているバージョンです。
  • PATH_TO_INLINE_BUILD_CONFIG は、--inline-config を使用する場合のインライン ビルド構成ファイルへのパスです。
  • TAG_NAME は、タグでビルドのトリガーを設定するタグの名前です。
  • --build-config を使用する場合は、PATH_TO_BUILD_CONFIG がビルド構成ファイルへのパスです。
  • BRANCH_NAME は、ブランチでビルドのトリガーを設定する場合、ブランチの名前です。

（省略可）API キーの取得

受信 Webhook イベントを認証するには、API キーが必要です。

API キーを取得するには:

  1. Google Cloud Console の認証情報ページを開きます。

    [認証情報] ページを開く

  2. [認証情報を作成] をクリックします。

  3. [API キー] をクリックします。

    作成した API キーとともにダイアログが表示されます。API キーをメモします。

  4. プロダクト アプリケーションのキーを制限する場合は、[キーを制限] をクリックして、キーを保護する追加の手順を行います。制限しない場合は、[閉じる] をクリックします。

    キーを制限する方法については、API キーの制限を適用するをご覧ください。

（省略可）サービス アカウントに Secret Manager のロールを付与する

Cloud Build は、Secret の構成中にそのロールがを必要とするサービス アカウントに Secret Manager のシークレット アクセサーのロールを自動的に付与します。このロールが必要なサービス アカウントに自動的に付与されない場合は、次の手順でロールを手動で追加し、サービス アカウントが Secret にアクセスできるようにします。

  1. Google Cloud コンソールで [IAM] ページを開きます。

    [IAM] ページを開く

  2. ロールを付与する Cloud Build サービス アカウントをメモします。

  3. Google Cloud コンソールで [シークレット マネージャー] ページを開きます。

    [シークレット マネージャー] ページを開く

  4. Secret の名前をクリックします。

    [Secret の詳細] ページが表示されます。

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

    2. [アクセス権を付与] をクリックします。

      [アクセス権を付与] パネルが表示されます。

    3. [プリンシパルを追加] セクションで、Cloud Build サービス アカウントに関連付けられているメールを追加します。

    4. [ロールの割り当て] セクションで、[Secret Manager] > [Secret Manager シークレット アクセサー] を選択します。

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

次のステップ