Eventarc トリガーは、特定のイベントまたは一連のイベントに関心があることを宣言します。イベント ルーティングを構成するには、トリガーのフィルタ（イベントソースとターゲット ワークフローを含む）を指定します。
イベントは、HTTP リクエストを介して CloudEvents 形式で配信されます。Workflows サービスは、CloudEvents 仕様に従ってイベントを JSON オブジェクトに変換し、ワークフロー ランタイム引数としてワークフロー実行に渡します。イベントサイズが 512 KB を超えていないことを確認してください。Workflows の引数サイズの上限を超えるイベントはワークフローの実行をトリガーしません。
以下では、Cloud Storage 直接イベントに応答してワークフローの実行がトリガーされるように、イベント ルーティングを構成する方法について説明します。これは、Cloud Storage イベント プロバイダに適用されます。詳細については、サポートされている直接イベントのリストをご覧ください。トリガーを作成する準備
ターゲット ワークフローの Eventarc トリガーを作成する前に、次の作業を完了します。
コンソール
Google Cloud コンソールの [プロジェクト セレクタ] ページで、プロジェクトを選択または作成します。 Google Cloud
Eventarc API、Eventarc Publishing API、Workflows API、Workflow Executions API を有効にします。
該当する場合は、ダイレクト イベントに関連する API を有効にします。たとえば、 Cloud Storage イベントの場合はCloud Storage API を有効にします。
アカウントがない場合は、ユーザー管理のサービス アカウントを作成し、Eventarc がターゲット ワークフローのイベントを管理できるように、必要なロールと権限を付与します。
Google Cloud コンソールで、[サービス アカウント] ページに移動します。
プロジェクトを選択します。
[サービス アカウント名] フィールドに名前を入力します。Google Cloud コンソールでは、この名前に基づいて [サービス アカウント ID] フィールドの値が設定されます。
[サービス アカウントの説明] フィールドに説明を入力します。例:
Service account for event trigger[作成して続行] をクリックします。
適切なアクセス権を付与するには、[ロールを選択] リストで、サービス アカウントに必要な Identity and Access Management（IAM）ロールを選択します。詳細については、Workflows ターゲットのロールと権限をご覧ください。
ロールを追加するには、[別のロールを追加] をクリックして各ロールを追加します。
[続行] をクリックします。
アカウントの作成を完了するには、[完了] をクリックします。
Cloud Storage サービス エージェントに Pub/Sub パブリッシャーのロールを付与します。通常は
service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.comであり、これにより、Cloud Storage サービス エージェントのメールアドレスを取得できます。Google Cloud コンソールの [IAM] ページに移動します。
Cloud Storage サービス エージェントの行で、「プリンシパルを編集します」をクリックします（サービス エージェントがリストにない場合は、次のステップに進みます）。権限の編集ペインが開きます。
- [add別のロールを追加] をクリックして、Pub/Sub パブリッシャーのロールを検索します。
- ロールを選択します。
- [保存] をクリックします。
サービス エージェントがリストにない場合は、[アクセス権を付与] をクリックします。アクセス権の付与ペインが開きます。
- [新しいプリンシパル] フィールドに、サービス エージェントのメールアドレスを入力します。
- [ロールを選択] リストで、Pub/Sub パブリッシャー ロールを検索します。
- ロールを選択します。
- [保存] をクリックします。
gcloud
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
Eventarc API、Eventarc Publishing API、Workflows API、Workflow Executions API を有効にします。
gcloud services enable eventarc.googleapis.com \ eventarcpublishing.googleapis.com \ workflows.googleapis.com \ workflowexecutions.googleapis.com
該当する場合は、直接イベントに関連する API を有効にします。たとえば、 Cloud Storage イベントの場合は
storage.googleapis.comを有効にします。アカウントがない場合は、ユーザー管理のサービス アカウントを作成し、Eventarc がターゲット ワークフローのイベントを管理できるように、必要なロールと権限を付与します。
サービス アカウントを作成します。
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
SERVICE_ACCOUNT_NAMEは、サービス アカウントの名前に置き換えます。6～30 文字で、小文字の英数字とダッシュを使用できます。作成したサービス アカウントの名前は変更できません。必要な Identity and Access Management（IAM）のロールまたは権限を付与します。詳細については、Workflows ターゲットのロールと権限をご覧ください。
Cloud Storage の直接イベントのトリガーを作成する場合は、Cloud Storage サービス アカウントに
pubsub.publisherロールを付与します。SERVICE_ACCOUNT="$(gsutil kms serviceaccount -p PROJECT_ID)" gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:${SERVICE_ACCOUNT}" \ --role="roles/pubsub.publisher"
トリガーを作成する
イベント レシーバとしてデプロイされたワークフローに Eventarc トリガーを作成するには、Google Cloud CLI（gcloud または Terraform）を使用するか、Google Cloud コンソールを使用します。
コンソール
- Google Cloud コンソールで、[Eventarc] の [トリガー] ページに移動します。
- [トリガーを作成] をクリックします。
- トリガー名を入力します。
これはトリガーの ID で、先頭は英字にする必要があります。63 文字以下とし、小文字、数字、ハイフンを使用できます。
- [トリガーのタイプ] で、[Google のソース] を選択します。
- [イベント プロバイダ] リストで「Cloud Storage」を選択します。
関連する Google Cloud のドキュメントでは、イベント プロバイダ名の前に Cloud またはGoogle Cloudが付いていない場合があります。たとえば、Memorystore for Redis はコンソールで Google Cloud Memorystore for Redis と表示されます。
- [イベントタイプ] リストで、直接イベントからイベントタイプを選択します。
- google.cloud.storage.object.v1.archived: オブジェクトのライブ バージョンがアーカイブまたは削除された時点でイベントが送信されます。このイベントは、バージョニング対応バケットの場合にのみ送信されます。
- google.cloud.storage.object.v1.delete: オブジェクトが完全に削除されたときにイベントが送信されます。バケットのオブジェクト バージョニングの設定に応じて、このイベントが持つ意味は以下のように異なります。
- バージョニング対応バケットの場合、バージョンが完全に削除されたときにのみ、イベントが送信されます（オブジェクトがアーカイブされたときには送信されません）。
- バージョニングに対応しないバケットの場合、オブジェクトが削除または上書きされると、イベントが送信されます。
- google.cloud.storage.object.v1.finalized: バケット内で新しいオブジェクトが作成された時点（または既存のオブジェクトが上書きされ、そのオブジェクトの新しい世代が作成された時点）でイベントが送信されます。
- google.cloud.storage.object.v1.metadataUpdated: 既存のオブジェクトの [メタデータ](/storage/docs/metadata) が変更されたときにイベントが送信されます。
- [イベントデータのコンテンツ タイプ] リストで、イベント ペイロードのエンコードを選択します。
Cloud Storageからの直接イベントの場合は、application/json にする必要があります。
- Cloud Storage バケットのグローバル固有識別子を指定するか、参照します。
Cloud Storage バケットは、Eventarc トリガーと同じGoogle Cloud プロジェクトとリージョンまたはマルチリージョンに存在する必要があります。
- リージョンを選択します。
Eventarc の Cloud Storage トリガーは、シングルリージョン、デュアルリージョン、マルチリージョンのロケーションで利用できます。Cloud Storage バケットは、Eventarc トリガーと同じ Google Cloud プロジェクトとリージョンまたはマルチリージョンに存在する必要があります。
イベントは、Cloud Storage からの Pub/Sub 通知を使用して配信されます。同一のバケットに対して過剰な数の通知を登録すると、エラー
Cloud Storage bucket ...: Pub/Sub notification limit reachedで示されるように、バケットの通知上限を超えてしまう可能性があります。特定のイベントをトリガーするように設定された通知構成は、最大 10 個までバケットに設定できます。Cloud Storage の割り当てと上限のページで、割り当てと上限の詳細をご確認ください。 - サービスまたはワークフローを呼び出すサービス アカウントを選択します。
新しいサービス アカウントを作成することもできます。
これにより、トリガーに関連付けられた Identity and Access Management（IAM）サービス アカウントのメールアドレスが設定されます。このメールアドレスには、Eventarc が必要とする特定のロールがすでに付与されています。
- [イベントの宛先] リストで、[Workflows] を選択します。
- ワークフローを選択します。
これは、イベントを渡すワークフローの名前です。ワークフロー実行用のイベントは、変換されてランタイム引数としてワークフローに渡されます。
詳細については、 Workflows のトリガーを作成するをご覧ください。
- 必要に応じて、ラベルを追加するには、 [ラベルを追加] をクリックします。ラベルは、Google Cloud リソースの整理に役立つ Key-Value ペアです。詳細については、ラベルとはをご覧ください。
- [作成] をクリックします。
トリガーの作成後は、イベントソースのフィルタを変更できません。代わりに、新しいトリガーを作成して古いトリガーを削除します。詳しくは、トリガーの管理をご覧ください。
gcloud
gcloud eventarc triggers create TRIGGER \ --location=LOCATION \ --destination-workflow=DESTINATION_WORKFLOW \ --destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \ --event-filters="type=EVENT_FILTER_TYPE" \ --event-filters="bucket=BUCKET" \ --service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"
次のように置き換えます。
TRIGGER: トリガーの ID または完全修飾識別子。LOCATION: Eventarc トリガーのロケーション。シングルリージョン、デュアルリージョン、マルチリージョンのロケーションで利用できます。globalEventarc トリガーは作成できません。Cloud Storage バケットは、Eventarc トリガーと同じ Google Cloud プロジェクトとリージョンに存在する必要があります。詳細については、Eventarc のロケーションをご覧ください。-
DESTINATION_WORKFLOW: トリガーからイベントを受け取る、デプロイ済みワークフローの ID。ワークフローは、Workflows でサポートされている任意のロケーションに配置できます。トリガーと同じロケーションに存在する必要はありません。ただし、ワークフローはトリガーと同じプロジェクトに存在する必要があります。 -
DESTINATION_WORKFLOW_LOCATION（省略可）: 宛先ワークフローがデプロイされるロケーション。指定しない場合、ワークフローはトリガーと同じロケーションにあるとみなされます。 EVENT_FILTER_TYPE: Cloud Storage イベントの識別子。次のいずれかになります。google.cloud.storage.object.v1.finalized: バケット内で新しいオブジェクトが作成された時点（または既存のオブジェクトが上書きされ、そのオブジェクトの新しい世代が作成された時点）でイベントが送信されます。google.cloud.storage.object.v1.archived: オブジェクトのライブ バージョンがアーカイブまたは削除された時点でイベントが送信されます。このイベントは、バージョニング対応バケットの場合にのみ送信されます。google.cloud.storage.object.v1.deleted: オブジェクトが完全に削除された時点でイベントが送信されます。バケットのオブジェクト バージョニングの設定に応じて、このイベントが持つ意味は以下のように異なります。- バージョニング対応バケットの場合、バージョンが完全に削除されたときにのみ、イベントが送信されます（オブジェクトがアーカイブされたときには送信されません）。
- バージョニングに対応していないバケットの場合、オブジェクトが削除または上書きされると、これが送信されます。
google.cloud.storage.object.v1.metadataUpdated: 既存のオブジェクトのメタデータが変更された時点でイベントが送信されます。
BUCKET: Cloud Storage バケットのグローバルな固有識別子。SERVICE_ACCOUNT_NAME: Workflows で必要な特定のロールを付与した IAM サービス アカウントの名前。PROJECT_ID: プロジェクト ID Google Cloud
注:
- Cloud Storageからの直接イベントの場合、イベント ペイロードのエンコードは
application/jsonです。 - 以下のフラグは必須です。
--event-filters="type=EVENT_FILTER_TYPE"--event-filters="bucket=BUCKET"
- トリガーの作成後に
EVENT_FILTER_TYPEを変更することはできません。別のイベントタイプには、新しいトリガーを作成する必要があります。 -
--service-account: Eventarc トリガーがワークフロー実行の呼び出しに使用する IAM サービス アカウントのメールアドレス。必要なリソースにアクセスするために必要な最小権限を持つサービス アカウントを使用することを強くおすすめします。サービス アカウントの詳細については、サービス アカウントの作成と管理をご覧ください。 - イベントは、Cloud Storage からの Pub/Sub 通知を使用して配信されます。同一のバケットに対して過剰な数の通知を登録すると、エラー
Cloud Storage bucket ...: Pub/Sub notification limit reachedで示されるように、バケットの通知上限を超えてしまう可能性があります。特定のイベントをトリガーするように設定された通知構成は、最大 10 個までバケットに設定できます。Cloud Storage の割り当てと上限のページで、割り当てと上限の詳細をご確認ください。 -
各トリガーには複数のイベント フィルタを指定できます。その場合は、
--event-filters=[ATTRIBUTE=VALUE,...] フラグにカンマ区切りで指定する必要があります。さらにフィルタを追加するには、このフラグを繰り返し指定します。すべてのフィルタに一致するイベントのみが宛先に送信されます。ワイルドカードと正規表現はサポートされていません。 - Cloud Storage バケットは、Eventarc トリガーと同じ Google Cloudプロジェクトとリージョンまたはマルチリージョンに存在する必要があります。
- デフォルトでは、Eventarc 用に作成された Pub/Sub サブスクリプションはアクティビティに関係なく保持され、期限切れになりません。非アクティブ期間を変更するには、サブスクリプションのプロパティをご覧ください。
例:
gcloud eventarc triggers create helloworld-trigger \ --location=us-central1 \ --destination-workflow=my-workflow \ --destination-workflow-location=europe-west4 \ --event-filters="type=google.cloud.storage.object.v1.finalized" \ --event-filters="bucket=my-project-bucket" \ --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"
このコマンドは、Cloud Storage バケット my-project-bucket と google.cloud.storage.object.v1.finalized として識別されるイベントに対して helloworld-trigger というトリガーを作成します。
Terraform
Terraform を使用して、ワークフローのトリガーを作成できます。詳細については、Eventarc と Terraform を使用してワークフローをトリガーするをご覧ください。
トリガーを一覧表示する
トリガーの作成を確認するには、Google Cloud CLI または Google Cloud コンソールを使用して Eventarc トリガーを一覧表示します。
コンソール
Google Cloud コンソールで、[Eventarc] の [トリガー] ページに移動します。
このページには、すべてのロケーションのトリガーが一覧表示されます。また、名前、リージョン、イベント プロバイダ、宛先などの詳細情報も表示されます。
トリガーをフィルタするには:
- [ フィルタ] フィールドまたは [トリガーをフィルタリング] フィールドをクリックします。
- [プロパティ] リストで、トリガーをフィルタするオプションを選択します。
1 つのプロパティを選択することも、論理演算子
ORを使用して複数のプロパティを追加することもできます。トリガーを並べ替えるには、サポートされている列見出しの横にある [ 並べ替え] をクリックします。
gcloud
次のコマンドを実行してトリガーを一覧取得します。
gcloud eventarc triggers list --location=-
すべてのロケーションのトリガーが一覧表示されます。名前、タイプ、宛先、ステータスなどの詳細情報も表示されます。