Workflow mit Cloud Scheduler planen

Auf dieser Seite wird gezeigt, wie Sie mit Cloud Scheduler einen Workflow nach einem bestimmten Zeitplan ausführen, z. B. jeden Montag um 9:00 Uhr oder alle 15 Minuten. Sie können den Zeitplan entweder in der Google Cloud Console oder mit der Google Cloud CLI konfigurieren.

Hinweise

  1. Wenn Sie noch keinen Workflow haben, den Sie planen möchten, erstellen und implementieren Sie einen.

  2. Enable the Cloud Scheduler API.

    Enable the API

    3. Oder geben Sie in einem Terminal den folgenden Befehl ein: 
    gcloud services enable cloudscheduler.googleapis.com

Workflow planen

  1. Erstellen Sie ein Dienstkonto, damit Cloud Scheduler Anfragen an die Workflows API senden kann:

    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

    Ersetzen Sie SERVICE_ACCOUNT_NAME durch einen Namen mit 6 bis 30 Zeichen. Er kann alphanumerische Zeichen in Kleinschreibung sowie Bindestriche enthalten. Nachdem Sie ein Dienstkonto erstellt haben, können Sie den Namen nicht mehr ändern.

  2. Damit das Hauptkonto, das Ihre Cloud Scheduler-Befehle ausführt, als IAM-Dienstkonto (Identity and Access Management) fungieren kann, weisen Sie eine Rolle zu, mit der das Hauptkonto die Identität des Dienstes übernehmen kann..

  3. Weisen Sie Ihrem neuen Dienstkonto die Rolle workflows.invoker zu, damit das Konto die Berechtigung zum Auslösen Ihres Workflows hat:

    gcloud projects add-iam-policy-binding PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
  --role roles/workflows.invoker

    Dabei gilt:

    • PROJECT_ID ist die ID Ihres Google Cloud-Projekts.
    • SERVICE_ACCOUNT_NAME: Name des zuvor erstellten Dienstkontos.

  4. Erstellen Sie einen Cloud Scheduler-Job, der Ihren Workflow auslöst. Verwenden Sie dazu das Dienstkonto, das Sie zuvor zur Authentifizierung erstellt haben.

    Wenn Sie Anrufprotokollierung verwenden, müssen Sie die Anrufprotokollierung auf der Seite Workflows in der Google Cloud Console konfigurieren. Weitere Informationen finden Sie in den folgenden Schritten.

    Console

    1. Rufen Sie zum Planen eines Workflows die Seite Workflows in der Google Cloud Console auf:

      Zur Seite "Workflows"

    2. Wählen Sie auf der Seite "Workflows" einen Workflow aus, um dessen Detailseite aufzurufen.

    3. Klicken Sie auf der Seite Workflow-Details auf Bearbeiten.

    4. Wählen Sie auf der Seite Workflow bearbeiten die Option Neuen Trigger hinzufügen > Cloud Scheduler aus.

      Der Bereich Scheduler-Job erstellen wird geöffnet.

    5. Zeitplan definieren:

      1. Geben Sie im Feld Name einen Namen für den Cloud Scheduler-Job ein. Er darf unter den Jobs in derselben Region nur einmal vorkommen.

      2. Wählen Sie in der Liste Region eine geeignete Region aus, z. B. us-central1.

      3. Geben Sie im Feld Häufigkeit ein Zeitintervall im unix-cron-Format an. Wenn Sie den Workflow beispielsweise alle 5 Minuten ausführen lassen möchten, geben Sie */5 * * * * ein.

      4. Wählen Sie in der Liste Zeitzone die Zeitzone aus, die Cloud Scheduler zum Interpretieren des von Ihnen angegebenen Zeitplans verwenden soll. Sie können nach Land suchen.

    6. Klicken Sie auf Weiter.

    7. Ausführung konfigurieren:

      1. Geben Sie im Feld Argument des Workflows alle Laufzeitargumente an, die vor der Ausführung an Ihren Workflow übergeben werden sollen. Argumente müssen im JSON-Format vorliegen. Beispiel: {"firstName":"Sherlock", "lastName":"Holmes"}. Wenn Ihr Workflow keine Laufzeitargumente verwendet, akzeptieren Sie den Standardwert {} oder lassen Sie das Feld leer.

      2. Wählen Sie in der Liste Aufruflogebene des Workflows die Ebene des Aufruf-Loggings aus, die Sie während der Ausführung des Workflows anwenden möchten:

        • Nicht angegeben: Es wird keine Logging-Ebene angegeben. Das ist die Standardeinstellung. Eine Ausführungslogebene hat Vorrang vor einer Workflow-Logebene, sofern keine Ausführungslogebene angegeben ist (Standardeinstellung); In diesem Fall wird die Workflow-Logebene genutzt.
        • Nur Fehler: Alle erfassten Ausnahmen sowie das Beenden eines Aufrufs aufgrund einer Ausnahme werden protokolliert.
        • Alle Aufrufe: Alle Aufrufe von untergeordneten Workflows oder Bibliotheksfunktionen und deren Ergebnisse werden protokolliert.
        • Keine Protokolle: Es werden keine Anrufe protokolliert.

      3. Wählen Sie in der Liste Dienstkonto das zuvor erstellte Dienstkonto aus.

    8. Klicken Sie auf Erstellen.

      Wenn Sie einen vorhandenen Workflow aktualisieren, müssen Sie ihn nicht neu bereitstellen.

      Der Cloud Scheduler-Job wird jetzt auf der Seite Workflow-Details auf dem Tab Trigger aufgeführt.

    9. Wenn Sie den Job aktualisieren oder löschen möchten, müssen Sie den Workflow bearbeiten:

      1. Klicken Sie auf der Seite Workflow-Details auf Bearbeiten.
      2. Suchen Sie im Bereich Trigger nach dem Job, den Sie aktualisieren oder löschen möchten.
      3. Klicken Sie auf Ressource bearbeiten oder auf Ressource löschen.

    gcloud

    1. Öffnen Sie ein Terminal und geben Sie den folgenden Befehl ein:

      gcloud scheduler jobs create http JOB_NAME \
    --schedule="FREQUENCY" \
    --uri="https://workflowexecutions.googleapis.com/v1/projects/PROJECT_ID/locations/REGION_NAME/workflows/WORKFLOW_NAME/executions" \
    --message-body="{\"argument\": \"DOUBLE_ESCAPED_JSON_STRING\"}" \
    --time-zone="TIME_ZONE" \
    --oauth-service-account-email="SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

      Dabei gilt:

      • JOB_NAME: Der Name, den Sie dem Cloud Scheduler-Job geben.
      • FREQUENCY: Ein Zeitintervall, das Sie im unix-cron-Format definieren. Wenn Sie den Workflow beispielsweise alle 5 Minuten ausführen lassen möchten, geben Sie */5 * * * * ein.
      • PROJECT_ID ist die ID Ihres Google Cloud-Projekts.
      • REGION_NAME: Die Region, in der sich Ihr Workflow befindet, z. B. us-central1.
      • WORKFLOW_NAME: Der Name des Workflows, für den Sie die Ausführung planen möchten.
      • DOUBLE_ESCAPED_JSON_STRING: Eine JSON-Codierung aller Argumente, die Sie übergeben. Die doppelten Anführungszeichen innerhalb des Strings in Anführungszeichen werden mit Schrägstrichen (\) maskiert. Beispiel: --message-body="{\"argument\": \"{\\\"foo\\\": \\\"bar\\\"}\"}"
      • TIME_ZONE: Die Zeitzone, mit der Cloud Scheduler den von Ihnen angegebenen Zeitplan interpretieren sollte. Beispiel: America/New_York.
      • SERVICE_ACCOUNT_NAME: Name des zuvor erstellten Dienstkontos.

    2. Alle Jobs in einem Projekt auflisten:

      gcloud scheduler jobs list

    3. So löschen Sie einen Job: 

      gcloud scheduler jobs delete JOB_NAME

Ihr Workflow wird jetzt gemäß der von Ihnen festgelegten Häufigkeit ausgeführt.

Nächste Schritte