Workflows mit Pub/Sub-Nachrichten (gcloud-CLI) auslösen

Workflows mit Pub/Sub-Nachrichten (gcloud-CLI) auslösen

In dieser Kurzanleitung erfahren Sie, wie Sie einen Workflow mit einem Eventarc-Trigger ausführen, der Ereignisse mit Pub/Sub empfängt. Der Trigger führt den Workflow aus, indem er über Pub/Sub übermittelte Ereignisse als Laufzeitargumente an einen Zielworkflow übergibt.

In dieser Kurzanleitung tun Sie Folgendes:

1. Mit Workflows einen Workflow erstellen und bereitstellen, der Pub/Sub-Nachrichten decodiert und zurückgibt
2. einen Eventarc-Trigger erstellen, der ein Pub/Sub-Thema mit einem Workflow-Ereignisempfänger verbindet
3. Senden Sie eine Nachricht an das Pub/Sub-Thema, um ein Ereignis zu generieren: Dieses Ereignis wird als Laufzeitargument an den Zielworkflow übergeben.
4. Sehen Sie sich die Pub/Sub-Nachricht als Ergebnis der Workflow-Ausführung an.

Hinweise

Sorgen Sie dafür, dass Sie Zugriff auf dieses Feature haben, indem Sie das Hinzufügen Ihres Projekts in eine private Vorschau für Google Cloud Workflows beantragen.

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
2. Install the Google Cloud CLI.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

4. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

5. Make sure that billing is enabled for your Google Cloud project.

6. Install the Google Cloud CLI.

7. To initialize the gcloud CLI, run the following command:

   gcloud init

8. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

9. Make sure that billing is enabled for your Google Cloud project.

10. Aktualisieren Sie die gcloud-Komponenten:

    gcloud components update

11. Aktivieren Sie die Compute Engine API, die Eventarc-, Pub/Sub- und Workflows APIs.

    gcloud services enable \
    compute.googleapis.com \
    eventarc.googleapis.com \
    pubsub.googleapis.com \
    workflows.googleapis.com \
    workflowexecutions.googleapis.com

12. Legen Sie die in dieser Anleitung verwendeten Konfigurationsvariablen fest:

    export WORKFLOW_LOCATION=us-central1
    export TRIGGER_LOCATION=us-central1
    export PROJECT_ID=PROJECT_ID
    gcloud config set project ${PROJECT_ID}
    gcloud config set workflows/location ${WORKFLOW_LOCATION}
    gcloud config set eventarc/location ${TRIGGER_LOCATION}

13. Wenn Sie der Projektersteller sind, wird Ihnen die einfache Owner-Rolle (roles/owner) zugewiesen. Standardmäßig enthält diese IAM-Rolle (Identity and Access Management) die Berechtigungen, die für den vollständigen Zugriff auf die meisten Google Cloud-Ressourcen erforderlich sind. Sie können diesen Schritt überspringen.

    Wenn Sie nicht der Project Creator sind, müssen dem entsprechenden Hauptkonto die erforderlichen Berechtigungen für das Projekt erteilt werden. Ein Hauptkonto kann beispielsweise ein Google-Konto (für Endnutzer) oder ein Dienstkonto (für Anwendungen und Computing-Arbeitslasten) sein. Weitere Informationen finden Sie auf der Seite Rollen und Berechtigungen für Ihr Ereignisziel.

    Erforderliche Berechtigungen

    Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Ausführen der Kurzanleitung benötigen:

    • Eventarc Admin (roles/eventarc.admin)
    • Zugriffsberechtigter für Logbetrachtung (roles/logging.viewAccessor)
    • Projekt-IAM-Administrator (roles/resourcemanager.projectIamAdmin)
    • Pub/Sub Publisher (roles/pubsub.publisher)
    • Service Account Admin (roles/iam.serviceAccountAdmin)
    • Service Account User (roles/iam.serviceAccountUser)
    • Service Usage Admin (roles/serviceusage.serviceUsageAdmin)
    • Workflow-Administrator (roles/workflows.admin)

    Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

    Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

14. Notieren Sie sich das Compute Engine Standarddienstkonto, das Sie an einen Eventarc-Trigger anhängen, um die Identität des Triggers zu Testzwecken darzustellen. Dieses Dienstkonto wird automatisch nach der Aktivierung oder Verwendung eines Google Cloud-Dienstes, der Compute Engine verwendet, mit dem folgenden E-Mail-Format erstellt:

    [e-mail]

    Ersetzen Sie PROJECT_NUMBER durch Ihre Google Cloud-Projektnummer. Sie finden Ihre Projektnummer auf der Willkommensseite der Google Cloud Console oder durch Ausführen des folgenden Befehls:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'

    Für Produktionsumgebungen empfehlen wir dringend, ein neues Dienstkonto zu erstellen und ihm eine oder mehrere IAM-Rollen zuzuweisen, die die erforderlichen Mindestberechtigungen enthalten und dem Grundsatz der geringsten Berechtigung folgen.

    Hinweis:

    Die Einschränkung für die Organisationsrichtlinie iam.automaticIamGrantsForDefaultServiceAccounts verhindert, dass die Rolle „Bearbeiter“ automatisch Standarddienstkonten zugewiesen wird. Wenn Sie Ihre Organisation nach dem 3. Mai 2024 erstellt haben, wird diese Einschränkung standardmäßig erzwungen.

    Wir empfehlen dringend, diese Einschränkung zu erzwingen, um die automatische Rollenzuweisung zu deaktivieren. Wenn Sie die automatische Rollenzuweisung deaktivieren, müssen Sie entscheiden, welche Rollen den Standarddienstkonten zugeteilt werden sollen, und diese Rollen dann selbst zuweisen.

    Wenn das Standarddienstkonto bereits die Rolle "Bearbeiter" hat, sollten Sie die Rolle "Bearbeiter" durch weniger strikte Rollen ersetzen. Verwenden Sie zum sicheren Ändern der Rollen des Dienstkontos Policy Simulator, um die Auswirkungen der Änderung zu sehen, und weisen Sie die entsprechenden Rollen zu und widerrufen Sie sie.

15. Weisen Sie dem Compute Engine-Standarddienstkonto die Rolle "Workflow-Aufrufer" (roles/workflows.invoker) für das Projekt zu, damit das Konto die Berechtigung zum Auslösen Ihres Workflows hat. ausgeführt werden.

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:[e-mail] \
        --role=roles/workflows.invoker

16. Wenn Sie den Cloud Pub/Sub-Dienst-Agent am oder vor dem 8. April 2021 aktiviert haben, um authentifizierte Pub/Sub-Push-Anfragen zu unterstützen, weisen Sie dem von Google verwalteten Dienstkonto die Rolle „Ersteller von Dienstkonto-Tokens“ (roles/iam.serviceAccountTokenCreator) zu. Andernfalls wird diese Rolle standardmäßig zugewiesen:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:[e-mail] \
        --role=roles/iam.serviceAccountTokenCreator

Workflow erstellen und bereitstellen

Workflow erstellen und bereitstellen, der ausgeführt wird, wenn eine in einem Pub/Sub-Thema veröffentlichte Nachricht einen Workflow mit einer HTTP-Anfrage auslöst.

1. Öffnen Sie ein Terminal oder eine Cloud Shell.
2. Erstellen Sie in Ihrem Basisverzeichnis eine neue Datei mit dem Namen myFirstWorkflow.yaml oder myFirstWorkflow.json.
3. Kopieren Sie Folgendes, fügen Sie es in die neue Datei ein und speichern Sie es:

   YAML

   main:
     params: [event]
     steps:
       - decode_pubsub_message:
           assign:
              - base64: ${base64.decode(event.data.message.data)}
              - message: ${text.decode(base64)}
       - return_pubsub_message:
           return: ${message}

   JSON

   {
     "main": {
       "params": [
         "event"
       ],
       "steps": [
         {
           "decode_pubsub_message": {
             "assign": [
               {
                 "base64": "${base64.decode(event.data.message.data)}"
               },
               {
                 "message": "${text.decode(base64)}"
               }
             ]
           }
         },
         {
           "return_pubsub_message": {
             "return": "${message}"
           }
         }
       ]
     }
   }

4. Stellen Sie den Workflow bereit:

   export MY_WORKFLOW=myFirstWorkflow
   gcloud workflows deploy ${MY_WORKFLOW} --source=myFirstWorkflow.yaml

   Ersetzen Sie .yaml durch .json , wenn Sie die JSON-Version des Beispielworkflows kopiert haben.

Eventarc-Trigger erstellen

Wenn eine Nachricht im Pub/Sub-Thema veröffentlicht wird, löst das Ereignis den Workflow aus.

1. Erstellen Sie einen Trigger, um Pub/Sub-Nachrichten zu überwachen:

   Neues Pub/Sub-Thema

   gcloud eventarc triggers create events-pubsub-trigger \
       --destination-workflow=${MY_WORKFLOW} \
       --destination-workflow-location=${WORKFLOW_LOCATION} \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --service-account="[e-mail]"

   Dadurch werden ein neues Pub/Sub-Thema und ein Trigger mit dem Namen events-pubsub-trigger für das Thema erstellt.

   Vorhandenes Pub/Sub-Thema

   gcloud eventarc triggers create events-pubsub-trigger \
       --destination-workflow=${MY_WORKFLOW} \
       --destination-workflow-location=${WORKFLOW_LOCATION} \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --service-account="[e-mail]" \
       --transport-topic=TOPIC_ID

   Ersetzen Sie TOPIC_ID durch die ID des vorhandenen Pub/Sub-Themas.

   Damit wird ein Trigger mit dem Namen events-pubsub-trigger für das vorhandene Pub/Sub-Thema erstellt.

   Hinweis: Standardmäßig bleiben für Eventarc erstellte Pub/Sub-Abos unabhängig von ihrer Aktivität bestehen und laufen nicht ab. Informationen zum Ändern des Inaktivitätszeitraums finden Sie unter Abo-Attribute.

   Beachten Sie, dass das Erstellen eines Eventarc-Triggers in einem Google Cloud-Projekt möglicherweise zu einer Verzögerung bei der Bereitstellung des Eventarc-Dienst-Agents kommt. Dieses Problem lässt sich normalerweise durch erneutes Erstellen des Triggers beheben. Weitere Informationen finden Sie unter Fehler „Berechtigung verweigert“.

2. Prüfen Sie, ob der Trigger korrekt erstellt wurde.

   gcloud eventarc triggers describe events-pubsub-trigger --location=${TRIGGER_LOCATION}

   Die Ausgabe sollte in etwa so aussehen, mit Angabe der Erstellungszeit und des Triggerstandorts:

   createTime: '2021-10-14T15:15:43.872360951Z'
   [...]
   name: projects/PROJECT_ID/locations/us-central1/triggers/events-pubsub-trigger

Ereignis erstellen und abrufen

Veröffentlichen Sie eine Nachricht im Pub/Sub-Thema, um ein Ereignis zu generieren und den Workflow auszulösen. Das generierte Ereignis wird als Laufzeitargument an den Workflow übergeben, der die Pub/Sub-Nachricht als Ergebnis der Workflowausführung zurückgibt. Achten Sie darauf, dass die Größe der Ereignisse, die Sie an den Workflow übergeben, 512 KB nicht überschreitet.

1. Wenn Sie einen Trigger für ein neues Pub/Sub-Thema erstellt haben, suchen Sie das erstellte Pub/Sub-Thema und legen Sie es als Umgebungsvariable fest:

   export TOPIC_ID=$(basename $(gcloud eventarc triggers describe events-pubsub-trigger --format='value(transport.pubsub.topic)'))

2. Senden Sie eine Nachricht an das Pub/Sub-Thema, um den Workflow auszulösen:

   gcloud pubsub topics publish $TOPIC_ID --message "Hello there"

   Das generierte Ereignis wird als Laufzeitargument an den Workflow übergeben, der die Nachricht "Hello da" zurückgibt.

3. Um zu prüfen, ob eine Workflowausführung ausgelöst wurde, listen Sie die letzten fünf Ausführungen auf:

   gcloud workflows executions list ${MY_WORKFLOW} --limit=5

   Die Ausgabe sollte in etwa so aussehen, wobei für jede Workflowausführung NAME und STATUS als SUCCEEDED aufgelistet werden:

   NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/8c02b8f1-8836-4a6d-99d9-fc321eb9668f
   STATE: SUCCEEDED
   START_TIME: 2021-09-13T19:15:10.275677049Z
   END_TIME: 2021-09-13T19:15:10.963136883Z
   NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/a6319d9d-36a6-4117-904e-3d1118bdc90a
   STATE: SUCCEEDED
   START_TIME: 2021-09-13T17:28:51.492864252Z
   END_TIME: 2021-09-13T17:28:52.227212414Z
   

   Beachten Sie, dass im vorherigen Beispiel im Feld NAME die ID der Workflowausführung a6319d9d-36a6-4117-904e-3d1118bdc90a ist. Kopieren Sie Ihre Ausführungs-ID, um sie im nächsten Schritt zu verwenden.

4. Führen Sie den folgenden Befehl aus, um den Ausführungsstatus anzuzeigen:

   gcloud workflows executions describe WORKFLOW_EXECUTION_ID --workflow=${MY_WORKFLOW}

   Ersetzen Sie WORKFLOW_EXECUTION_ID durch die ID der Workflowausführung, die der Veröffentlichungszeit des Pub/Sub-Themas entspricht. Die Ausgabe sieht in etwa so aus:

   argument: [...]
   endTime: '2021-09-13T17:28:47.301012152Z'
   name: projects/1234567/locations/us-central1/workflows/myFirstWorkflow/executions/f72bc6d4-5ea0-4dfb-bb14-2dae82303120
   result: 'Hello there'
   startTime: '2021-09-13T17:28:51.492864252Z'
   state: SUCCEEDED

5. Prüfen Sie, ob die publish_time, an der die Pub/Sub-Nachricht veröffentlicht wurde, und die startTime der Workflowausführung einander entsprechen.

Glückwunsch! Sie haben mithilfe eines Pub/Sub-Themas erfolgreich ein Ereignis generiert, das einen Workflows-Ereignisempfänger mithilfe von Eventarc ausgelöst hat.

Bereinigen

1. Löschen Sie den erstellten Workflow:

   gcloud workflows delete ${MY_WORKFLOW}

   Wenn Sie gefragt werden, ob Sie fortfahren möchten, geben Sie y ein.
2. Löschen Sie den von Ihnen erstellten Trigger:

   gcloud eventarc triggers delete events-pubsub-trigger

3. Alternativ können Sie Ihr Google Cloud-Projekt löschen, um wiederkehrende Gebühren zu vermeiden. Wenn Sie Ihr Google Cloud-Projekt löschen, wird die Abrechnung für alle in diesem Projekt verwendeten Ressourcen beendet.
   Achtung: Das Löschen von Projekten hat folgende Auswirkungen:

   • Alle Inhalte des Projekts werden gelöscht. Wenn Sie für die Aufgaben in diesem Dokument ein bereits bestehendes Projekt verwendet haben und dieses löschen, werden auch alle anderen im Rahmen des Projekts erstellten Daten gelöscht.
   • Benutzerdefinierte Projekt-IDs gehen verloren. Beim Erstellen dieses Projekts haben Sie möglicherweise eine benutzerdefinierte Projekt-ID erstellt, die Sie weiterhin verwenden möchten. Damit die URLs, die die Projekt-ID nutzen, z. B. eine appspot.com-URL, erhalten bleiben, sollten Sie ausgewählte Ressourcen innerhalb des Projekts löschen, statt das gesamte Projekt.

   Delete a Google Cloud project:

   gcloud projects delete PROJECT_ID

Nächste Schritte

• Ausführungsreihenfolge in Workflows steuern

• Trigger zum Weiterleiten von Pub/Sub-Ereignissen an Workflows erstellen