Console
Start free

Route backup for GKE events to Workflows

An Eventarc trigger declares your interest in a certain event or set of events. You can configure event routing by specifying filters for the trigger, including the event source, and the target workflow.

Events are delivered in the CloudEvents format through an HTTP request. The Workflows service converts the event to a JSON object (following the CloudEvents specification) and passes the event into the workflow execution as a workflow runtime argument. Make sure that the event size does not exceed the resource limit. Events larger than the maximum Workflows arguments size won't trigger workflow executions.

These instructions show you how to configure event routing so that an execution of your workflow is triggered in response to a direct Backup for GKE event. For more details, see the list of supported direct events.

Prepare to create a trigger

Before creating an Eventarc trigger for a target workflow, complete the following tasks.

Console

  • In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  • Enable the Eventarc, Eventarc Publishing, Workflows, and Workflow Executions APIs.

    Enable the APIs

  • If applicable, enable the API related to the direct events. For example, for Backup for GKE events, enable the Backup for GKE API.

    • If you don't already have one, create a user-managed service account, then grant it the roles and permissions necessary so that Eventarc can manage events for a target workflow.

  • In the Google Cloud console, go to the Service Accounts page.

    Go to Service Accounts

  • Select your project.

  • In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

    In the Service account description field, enter a description. For example, Service account for event trigger.

  • Click Create and continue.

  • To provide appropriate access, in the Select a role list, select the required Identity and Access Management (IAM) roles to grant to your service account. For more information, see Roles and permissions for Workflows targets.

    For additional roles, click Add another role and add each additional role.

  • Click Continue.

    • To finish creating the account, click Done.

    gcloud

  • In the Google Cloud console, activate Cloud Shell.

    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.

  • Enable the Eventarc, Eventarc Publishing, Workflows, and Workflow Executions APIs:

    gcloud services enable eventarc.googleapis.com \
    eventarcpublishing.googleapis.com \
    workflows.googleapis.com \
    workflowexecutions.googleapis.com

  • If applicable, enable the API related to the direct events. For example, for Backup for GKE events, enable gkebackup.googleapis.com.

    • If you don't already have one, create a user-managed service account, then grant it the roles and permissions necessary so that Eventarc can manage events for a target workflow.

  • Create the service account:

    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

    Replace SERVICE_ACCOUNT_NAME with the name of the service account. It must be between 6 and 30 characters, and can contain lowercase alphanumeric characters and dashes. After you create a service account, you cannot change its name.

    • Grant the required Identity and Access Management (IAM) roles or permissions. For more information, see Roles and permissions for Workflows targets.

    Create a trigger

    You can create an Eventarc trigger with a deployed workflow as the event receiver by using the Google Cloud CLI (gcloud or Terraform), or through the Google Cloud console.

    Console

  • In the Google Cloud console, go to the Eventarc Triggers page.

    Go to Triggers

  • Click Create trigger.
  • Type a Trigger name.

    This is the ID of the trigger and it must start with a letter. It can contain up to 63 lowercase letters, numbers, or hyphens.

  • For the Trigger type, select Google sources.
  • In the Event provider list, select Backup for GKE.

    Note that the event provider name used in the associated Google Cloud documentation might not have a prefix of Cloud or Google Cloud. For example, on the console, Memorystore for Redis is referred to as Google Cloud Memorystore for Redis.

  • In the Event type list, from the Direct events, select an event type.
  • To specify the encoding of the event payload, in the Event data content type list, select application/json or application/protobuf.

    Note that an event payload formatted in JSON is larger than one formatted in Protobuf. This might impact reliability depending on your event destination and its limits on event size. For more information, see Known issues.

  • In the Region list, select the same region as the Google Cloud service that is generating events.

    For more information, see Eventarc locations.

  • If applicable to the event provider, click Add filter and specify the following:
    1. In the Attribute 1 field, depending on the direct event you chose, select a resource ID that can act as an event filter.
    2. Select an operator:
    3. In the Attribute value 1 field, depending on the operator that you chose, type the exact value or apply a path pattern.
    4. If more attribute filters are applicable, click Add filter and specify the appropriate values.
    • Select the Service account that will invoke your service or workflow.

    Or, you can create a new service account.

    This specifies the Identity and Access Management (IAM) service account email associated with the trigger and to which you previously granted specific roles required by Eventarc.
  • In the Event destination list, select Workflows.
    • Select a workflow.

    This is the name of the workflow to pass events to. Events for a workflow execution are transformed and passed to the workflow as runtime arguments.

    For more information, see Create a trigger for Workflows.

  • Optionally, to add a label, you can click Add label. Labels are key-value pairs that help you organize your Google Cloud resources. For more information, see What are labels?
  • Click Create.

    • After a trigger is created, the event source filters can't be modified. Instead, create a new trigger and delete the old one. For more information, see Manage triggers.

    gcloud

    You can create a trigger by running the gcloud eventarc triggers create command along with required and optional flags.

      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="COLLECTION_ID=RESOURCE_ID" \
      --event-filters-path-pattern="COLLECTION_ID=PATH_PATTERN" \
      --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
      --service-account="SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

    Replace the following:

    Notes:

    Example:

      gcloud eventarc triggers create helloworld-trigger \
      --location=us-central1 \
      --destination-workflow=my-workflow \
      --destination-workflow-location=us-central1 \
      --event-filters="type=google.cloud.gkebackup.backupPlan.v1.updated" \
      --event-filters-path-pattern="backupplan=my-backupplan-*" \
      --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"

    This command creates a trigger called helloworld-trigger for the event identified as google.cloud.gkebackup.backupPlan.v1.updated and matches events for backupplan IDs starting with my-backupplan-.

    Terraform

    You can create a trigger for a workflow using Terraform. For details, see Trigger a workflow using Eventarc and Terraform.

    List a trigger

    You can confirm the creation of a trigger by listing Eventarc triggers using the Google Cloud CLI or through the Google Cloud console.

    Console

    1. In the Google Cloud console, go to the Eventarc Triggers page.

      Go to Triggers

      This page lists your triggers in all locations, and includes details such as names, regions, event providers, destinations, and more.

    2. To filter your triggers:

      1. Click Filter or the Filter triggers field.
      2. In the Properties list, select an option to filter the triggers by.

      You can select a single property or use the logical operator OR to add more properties.

    3. To sort your triggers, beside any supported column heading, click Sort.

    gcloud

    Run the following command to list your triggers:

    gcloud eventarc triggers list --location=-

    This command lists your triggers in all locations, and includes details such as names, types, destinations, and statuses.

    What's next