Workflows erstellen und verwalten

Sie können Workflows in der Google Cloud Console oder mit der Google Cloud CLI in Ihrem Terminal oder in Cloud Shell erstellen und verwalten. Sie können Workflows auch über die Workflows API verwalten.

Hinweise

Von Ihrer Organisation definierte Sicherheitsbeschränkungen verhindern möglicherweise, dass die folgenden Schritte ausgeführt werden. Informationen zur Fehlerbehebung finden Sie unter Anwendungen in einer eingeschränkten Google Cloud-Umgebung entwickeln.

Console

  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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

  4. Enable the Workflows API.

    Enable the API

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

    Go to project selector

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

  7. Enable the Workflows API.

    Enable the API

gcloud

  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.

    • 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. Enable the Workflows API:

    gcloud services enable workflows.googleapis.com
  7. Install the Google Cloud CLI.
  8. To initialize the gcloud CLI, run the following command:

    gcloud init
  9. Create or select a Google Cloud 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.

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

  11. Enable the Workflows API:

    gcloud services enable workflows.googleapis.com

REST

Wenn Sie Workflows mit der Workflows API verwalten möchten, empfehlen wir, den workflows.googleapis.com-Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Weitere Informationen finden Sie unter Workflows API.

Dienstkonto erstellen

Ein Dienstkonto stellt die Identität eines Workflows dar und bestimmt, welche Berechtigungen der Workflow hat und auf welche Google Cloud-Ressourcen er zugreifen kann. Erstellen Sie ein Dienstkonto, falls Sie noch keines haben. Anschließend weisen Sie ihm die Rollen zu, die zum Verwalten von Workflows und zum Erstellen von Protokollen erforderlich sind.

Wenn Sie beim Erstellen des Workflows kein Dienstkonto angeben, verwendet der Workflow für die Identität das Compute Engine-Standarddienstkonto. Weitere Informationen finden Sie unter Workflowberechtigungen für den Zugriff auf Google Cloud-Ressourcen gewähren.

Es wird dringend empfohlen, ein Dienstkonto mit den geringsten Berechtigungen zu verwenden, die für den Zugriff auf die erforderlichen Ressourcen erforderlich sind.

Um eine Ressource zu erstellen und ein Dienstkonto anzuhängen, benötigen Sie Berechtigungen zum Erstellen dieser Ressource und die Erlaubnis, sich als das Dienstkonto auszugeben, das Sie an die Ressource anhängen werden. Weitere Informationen finden Sie unter Dienstkontoberechtigungen.

Console

  1. Rufen Sie in der Google Cloud Console die Seite Dienstkonten auf:

    Zur Seite „Dienstkonten“

  2. Wählen Sie ein Projekt aus und klicken Sie auf Dienstkonto erstellen.

  3. Geben Sie im Feld Dienstkontoname einen Namen ein.

    Der Name muss zwischen 6 und 30 Zeichen lang sein und alphanumerische Zeichen in Kleinschreibung sowie Bindestriche enthalten. Nachdem Sie ein Dienstkonto erstellt haben, können Sie den Namen nicht mehr ändern.

  4. Klicken Sie auf Erstellen und fortfahren.

  5. Klicken Sie auf Rolle auswählen.

  6. Wählen Sie die folgenden Rollen aus und klicken Sie bei Bedarf auf Weitere Rolle hinzufügen:

    1. Wenn Sie Workflows erstellen, aktualisieren und ausführen möchten, wählen Sie Workflows > Workflow-Editor aus.
    2. Wenn Sie Protokolle an Cloud Logging senden möchten, wählen Sie Logging > Logautor aus.
  7. Klicken Sie auf Fertig, um das Erstellen des Dienstkontos abzuschließen.

gcloud

  1. Erstellen Sie das Dienstkonto.

    gcloud iam service-accounts create SERVICE_ACCOUNT
  2. Gewähren Sie dem Dienstkonto Berechtigungen, indem Sie Rollen zuweisen.

    1. Zum Erstellen, Aktualisieren und Ausführen von Workflows weisen Sie die Rolle roles/workflows.editor zu:

      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
          --role "roles/workflows.editor"
    2. Um Logs an Cloud Logging zu senden, weisen Sie die Rolle roles/logging.logWriter zu:

      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \
          --role "roles/logging.logWriter"

    Ersetzen Sie Folgendes:

    • SERVICE_ACCOUNT: der Name des Dienstkontos. Der Name des Dienstkontos muss zwischen 6 und 30 Zeichen lang sein und darf alphanumerische Zeichen in Kleinschreibung sowie Bindestriche enthalten. Nachdem Sie ein Dienstkonto erstellt haben, können Sie den Namen nicht mehr ändern.

    • PROJECT_ID: die Projekt-ID

REST

Sie können die Methode serviceAccounts.create verwenden, um ein Dienstkonto zu erstellen. Weitere Informationen finden Sie unter Dienstkonten erstellen.

Sie können programmatisch mehrere Rollen gewähren, indem Sie die Zulassungsrichtlinie für eine Ressource mit der Methode setIamPolicy ändern und festlegen. Weitere Informationen finden Sie unter Mehrere Rollen programmatisch zuweisen oder widerrufen.

Workflow erstellen

Ein Workflow besteht aus einer Reihe von Schritten, die mit der Workflows-Syntax beschrieben werden. Diese kann entweder im YAML- oder JSON-Format geschrieben werden. Nachdem Sie einen Workflow definiert haben, stellen Sie ihn bereit, um ihn für die Ausführung verfügbar zu machen. Der Bereitstellungsschritt überprüft auch, ob die Quelldatei ausgeführt werden kann. Es schlägt fehl, wenn die Quelldatei keine gültige Workflowdefinition enthält.

Das Bearbeiten von YAML-Dateien kann fehleranfällig sein. Sie können Ihren Workflow mit einer bevorzugten IDE oder einem bevorzugten Quellcode-Editor erstellen und die automatische Vervollständigung und Syntaxprüfung einrichten, um Fehler zu vermeiden.

Console

  1. Öffnen Sie in der Google Cloud Console die Seite Workflows.

    Zur Seite "Workflows"

  2. Klicken Sie auf  Erstellen.

  3. Geben Sie einen Namen für den Workflow ein, z. B. myFirstWorkflow. Der Name kann Buchstaben, Zahlen, Unterstriche und Bindestriche enthalten. Muss mit einem Buchstaben beginnen und mit einer Zahl oder einem Buchstaben enden.

  4. Optional können Sie eine Beschreibung des Workflows hinzufügen.

  5. Wählen Sie in der Liste Region einen geeigneten Speicherort für die Bereitstellung des Workflows aus, z. B. us-central1.

  6. Wählen Sie in der Liste Dienstkonto ein Dienstkonto aus, mit dem Ihr Workflow auf andere Google Cloud-Dienste zugreift. Weitere Informationen finden Sie unter Dienstkonto erstellen.

  7. Führen Sie optional die folgenden Schritte aus:

    1. Geben Sie die Ebene des Aufruf-Logging an, die Sie auf die Workflow-Definition anwenden möchten. Wählen Sie in der Liste Anrufprotokollebene eine der folgenden Optionen aus:

      • 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.
    2. Geben Sie den Cloud Key Management Service-Schlüssel an, den der Workflow für die Datenverschlüsselung verwenden soll: Wählen Sie Vom Kunden verwalteter Verschlüsselungsschlüssel (CMEK). Weitere Informationen finden Sie unter vom Kunden verwaltete Verschlüsselungsschlüssel verwenden.

    3. Geben Sie eine Umgebungsvariable an, auf die der Workflow zur Laufzeit zugreifen kann. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.

    4. Label hinzufügen: Labels sind Schlüssel/Wert-Paare, mit denen Sie Ihre Google Cloud-Instanzen organisieren können. Weitere Informationen finden Sie unter Was sind Labels? Workflowlabels werden von Workflowausführungen übernommen. Wenn Sie Ausführungslabels aufrufen möchten, verwenden Sie die Methode workflows.executions.list, um Workflowausführungen aufzulisten und zu filtern.

    5. Workflow planen: Wählen Sie Neuen Trigger hinzufügen > Cloud Scheduler aus. Weitere Informationen finden Sie unter Workflow mit Cloud Scheduler planen.

    6. Workflow über ein Ereignis oder eine Pub/Sub-Nachricht auslösen: Wählen Sie Neuen Trigger hinzufügen > Eventarc aus. Weitere Informationen finden Sie unter Workflow mit Ereignissen oder Pub/Sub-Nachrichten auslösen.

  8. Klicken Sie auf Next (Weiter).

  9. Geben Sie im Workflow-Editor die Definition für Ihren Workflow ein. Beispiel-Workflow ansehen

  10. Klicken Sie auf Bereitstellen.

gcloud

  1. Achten Sie darauf, dass der Quellcode Ihres Workflows in einer YAML- oder JSON-Datei gespeichert ist, z. B. MY_WORKFLOW.YAML oder MY_WORKFLOW.JSON. Sehen Sie sich einen Beispielworkflow an.

  2. Öffnen Sie ein Terminalfenster.

  3. Sie können einen Workflow mit dem Befehl gcloud workflows deploy erstellen und bereitstellen:

    gcloud workflows deploy WORKFLOW_NAME \
        --location=LOCATION \
        --call-log-level=CALL_LOGGING_LEVEL \
        --description="DESCRIPTION" \
        --labels="LABEL_KEY=LABEL_VALUE" \
        --set-env-vars="ENV_KEY=ENV_VALUE" \
        --kms-key=ENCRYPT_KEY \
        --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
        --source=YAML_OR_JSON_SOURCE_FILE

    Ersetzen Sie Folgendes:

    • WORKFLOW_NAME: der Name des Workflows, z. B. myFirstWorkflow. Der Name kann Buchstaben, Zahlen, Unterstriche und Bindestriche enthalten. Sie muss mit einem Buchstaben beginnen und mit einer Ziffer oder einem Buchstaben enden.

    • LOCATION: die Region, in der Sie Ihren Workflow bereitstellen möchten, z. B. us-central1.

    • CALL_LOGGING_LEVEL: Optional. Ebene des Aufruf-Logging, die während der Ausführung angewendet werden soll. Kann einer der folgenden Werte sein:

      • none: 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.
      • log-errors-only: Es werden alle erfassten Ausnahmen sowie das Beenden eines Aufrufs aufgrund einer Ausnahme protokolliert
      • log-all-calls: Alle Aufrufe von untergeordneten Workflows oder Bibliotheksfunktionen und deren Ergebnisse werden protokolliert.
      • log-none: Kein Aufruf-Logging.
    • DESCRIPTION: Optional. Eine Beschreibung des Workflows.

    • LABEL_KEY=LABEL_VALUE: Optional. Liste von Label-Schlüssel/Wert-Paaren, mit denen Sie Ihre Google Cloud-Instanzen organisieren können, z. B. name=wrench. Weitere Informationen finden Sie unter Was sind Labels? Workflowlabels werden von Workflowausführungen übernommen. Wenn Sie Ausführungslabels aufrufen möchten, verwenden Sie die Methode workflows.executions.list, um Workflowausführungen aufzulisten und zu filtern.

    • ENV_KEY=ENV_VALUE: Optional. Liste der Schlüssel/Wert-Paare für Umgebungsvariablen, z. B. MONTH=January. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.

    • ENCRYPT_KEY: Optional. Ein Cloud KMS-Schlüssel, der vom Workflow für die Datenverschlüsselung im Format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME verwendet werden soll. Weitere Informationen finden Sie unter vom Kunden verwaltete Verschlüsselungsschlüssel verwenden.

    • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: Optional. Das Dienstkonto, mit dem Ihr Workflow auf andere Google Cloud-Dienste zugreift. Weitere Informationen finden Sie in diesem Dokument unter Dienstkonto erstellen.

    • YAML_OR_JSON_SOURCE_FILE: die Quelldatei für die Workflowdefinition. Beispiel: myFirstWorkflow.yaml

REST

Verwenden Sie die Methode projects.locations.workflows.create, um einen neuen Workflow mit einem bestimmten Namen zu erstellen, und geben Sie mit dem Abfrageparameter workflowId eine ID für den Workflow an.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • WORKFLOW_NAME: Der Name Ihres Workflows, z. B. myFirstWorkflow. Der Name kann Buchstaben, Zahlen, Unterstriche und Bindestriche enthalten. Er muss mit einem Buchstaben beginnen und mit einer Ziffer oder einem Buchstaben enden.
  • DESCRIPTION: Optional. Eine Beschreibung Ihres Workflows. Darf maximal 1.000 Unicode-Zeichen lang sein.
  • LABEL_KEY und LABEL_VALUE: Optional. Eine Zuordnung von Labelschlüsseln und ‑werten, mit der Sie Ihre Google Cloud-Instanzen organisieren können. Beispiel: {"name": "wrench", "mass": "1kg", "count": "3"} Weitere Informationen finden Sie unter Was sind Labels? Workflowlabels werden von Workflowausführungen übernommen. Wenn Sie Ausführungslabels aufrufen möchten, verwenden Sie die Methode workflows.executions.list, um Workflowausführungen aufzulisten und zu filtern.
  • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: Optional. Das Dienstkonto, mit dem Ihr Workflow auf andere Google Cloud-Dienste zugreift. Die Projekt-ID ist Ihre Google Cloud-Projekt-ID. Weitere Informationen finden Sie in diesem Dokument unter Dienstkonto erstellen.
  • ENCRYPT_KEY: Optional. Ein Cloud KMS-Schlüssel, der vom Workflow für die Datenverschlüsselung im Format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME verwendet werden soll. Weitere Informationen finden Sie unter vom Kunden verwaltete Verschlüsselungsschlüssel verwenden.
  • CALL_LOGGING_LEVEL: Optional. Die Ebene des Aufruf-Loggings, die während der Ausführung angewendet werden soll. Standardmäßig ist keine Logging-Ebene angegeben und stattdessen wird die Workflow-Logebene angewendet. Weitere Informationen finden Sie unter Logs an Logging senden. Eines der folgenden Elemente:
    • CALL_LOG_LEVEL_UNSPECIFIED: Es wird keine Logging-Ebene angegeben und stattdessen wird die Workflow-Logebene angewendet. Das ist die Standardeinstellung. Andernfalls gilt die Ausführungslogebene und hat Vorrang vor der Workflow-Logebene.
    • LOG_ERRORS_ONLY: Es werden alle erfassten Ausnahmen sowie das Beenden eines Aufrufs aufgrund einer Ausnahme protokolliert.
    • LOG_ALL_CALLS: Alle Aufrufe von untergeordneten Workflows oder Bibliotheksfunktionen und deren Ergebnisse werden protokolliert.
    • LOG_NONE: Kein Aufruf-Logging.
  • ENV_KEY und ENV_VALUE: Optional. Eine Zuordnung von Schlüssel- und Wert-Paaren für Umgebungsvariablen, z. B. { "month": "January", "day": "Monday"}. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.
  • SOURCE_CODE: die Workflowdefinition. In YAML-Dateien müssen Zeilenumbrüche mit einem Escapezeichen versehen werden. Beispiel: main:\n params:\n - input\n steps:\n - returnOutput:\n return: Hello.

    Anführungszeichen müssen in JSON mit Escapezeichen versehen werden. Beispiel: {\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}

  • LOCATION: die Region, in der der Workflow bereitgestellt werden soll, z. B. us-central1.

JSON-Text der Anfrage:

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Operation.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "create",
    "apiVersion": "v1"
  },
  "done": false
}

Wenn der Wert von "done" false ist, ist der Vorgang noch aktiv.

Workflows auflisten

Sie können Workflows auflisten oder mithilfe von Filtern einen bestimmten Workflow abrufen.

Console

  1. Öffnen Sie in der Google Cloud Console die Seite Workflows.

    Zur Seite "Workflows"

    Auf dieser Seite werden Ihre Workflows an allen Standorten aufgelistet. Außerdem enthält sie Details wie Namen, Regionen, letzte Versionen usw.

  2. So filtern Sie Ihre Workflows:

    1. Klicken Sie auf Filter oder das Feld Workflows filtern.
    2. Wählen Sie in der Liste Attribute eine Option aus, nach der die Workflows gefiltert werden sollen.

    Sie können ein einzelnes Attribut auswählen oder den logischen Operator OR verwenden, um weitere Attribute hinzuzufügen.

  3. Klicken Sie zum Sortieren der Workflows neben jeder unterstützten Spaltenüberschrift auf Sortieren.

gcloud

Mit dem Befehl gcloud workflows list Workflows auflisten:

gcloud workflows list --location=LOCATION

Ersetzen Sie LOCATION durch die ID oder die vollständig qualifizierte Kennzeichnung des Speicherorts Ihres Workflows.

Mit diesem Befehl werden Ihre Workflows am angegebenen Speicherort aufgelistet. Außerdem werden Details wie NAME, STATE, REVISION_ID und UPDATE_TIME eines Workflows angezeigt.

REST

Verwenden Sie die Methode projects.locations.workflows.list, um Workflows in einem bestimmten Projekt und an einem bestimmten Standort aufzulisten.

Alternativ können Sie die Details eines einzelnen Workflows mit der Methode projects.locations.workflows.get abrufen.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID.
  • LOCATION: die Region, in der die Workflows bereitgestellt werden, z. B. us-central1.

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Instanzen von Workflow und die Antwort sollte in etwa so aussehen:

{
  "workflows": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
      "state": "ACTIVE",
      "revisionId": "000001-0ce",
      "createTime": "2023-12-08T13:56:59.306770745Z",
      "updateTime": "2023-12-08T13:56:59.547021939Z",
      "revisionCreateTime": "2023-12-08T13:56:59.340161044Z",
      "serviceAccount": "projects/PROJECT_ID/serviceAccounts/PROJECT_NUMBER-compute@developer.gserviceaccount.com",
      "sourceContents": "main:\n    params: [input]\n [...] return: '${wikiResult.body[1]}'\n"
    },
    {
      object (Workflow)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}

Workflow aktualisieren

Sie können einen vorhandenen Workflow aktualisieren. Sie müssen den Namen des zu aktualisierenden Workflows und seine Quelle angeben. Sie können den Namen oder Speicherort eines Workflows nicht ändern.

Das Aktualisieren eines Workflows wirkt sich nicht auf laufende Ausführungen aus. Nur die zukünftigen Ausführungen des Workflows verwenden die aktualisierte Konfiguration.

Jedes Mal, wenn Sie einen Workflow aktualisieren, wird dessen versionID aktualisiert. Der versionID besteht aus zwei Teilen, die durch einen Bindestrich getrennt sind:

  • Eine Zahl, die mit 1 beginnt und jedes Mal um eins erhöht wird, wenn Sie einen Workflow aktualisieren.

  • Ein zufälliger, dreistelliger alphanumerischer String.

Beispiel: 000001-27f gibt die ursprüngliche Version eines Workflows an und 000002-d52 einen Workflow, der einmal aktualisiert wurde.

Console

  1. Öffnen Sie in der Google Cloud Console die Seite Workflows.

    Zur Seite "Workflows"

  2. Klicken Sie auf den Namen des Workflows, den Sie aktualisieren möchten. Sie können den Namen des Workflows nicht ändern.

    Die Seite Workflow-Details wird angezeigt.

  3. Sie haben folgende Möglichkeiten, den Workflow zu bearbeiten:

    • So bearbeiten Sie die Quelle:

      1. Klicken Sie auf den Tab Quelle.
      2. Klicken Sie auf Bearbeiten.
      3. Um die Änderungen zu speichern, klicken Sie auf Speichern. Der aktualisierte Workflow wird bereitgestellt.
    • So aktualisieren Sie die Beschreibung, das Dienstkonto, das der Workflow zur Authentifizierung verwendet, die Anrufprotokollebene, Umgebungsvariablen, Labels oder den Verschlüsselungsschlüssel:

      1. Klicken Sie auf den Tab Details.
      2. Klicken Sie auf das entsprechende Symbol .
      3. Wenn Sie die Ebene des Anrufprotokolls aktualisieren, wählen Sie eine der folgenden Optionen aus:
        • 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.
      4. Wenn Sie ein vorhandenes Label aktualisieren oder ein neues hinzufügen, kann es bis zu 10 Minuten dauern, bis das neue Label wirksam wird. Workflowlabels werden von den Ausführungen des Workflows übernommen. Wenn Sie Ausführungslabels aufrufen möchten, verwenden Sie die Methode workflows.executions.list, um Workflowausführungen aufzulisten und zu filtern.
      5. Um die Änderungen zu speichern, klicken Sie auf Speichern. Der aktualisierte Workflow wird bereitgestellt.
    • So bearbeiten Sie die vorherigen Felder gleichzeitig oder fügen einen Trigger hinzu oder aktualisieren ihn:

      1. Klicken Sie auf Bearbeiten.
      2. Klicken Sie auf Weiter, um die Quelle zu bearbeiten.
      3. Klicken Sie auf Bereitstellen, um die Änderungen zu speichern und den aktualisierten Workflow bereitzustellen.
  4. Wenn Sie die Rollen für Ihr Dienstkonto aktualisieren möchten, klicken Sie auf den Tab Berechtigungen.

    1. Hauptkonten sind Nutzer, Gruppen, Domains oder Dienstkonten. So aktualisieren Sie ein vorhandenes Hauptkonto:

      1. Suchen Sie die Zeile mit dem Hauptkonto.
      2. Klicken Sie in dieser Zeile auf Hauptkonto bearbeiten.
      3. Klicken Sie auf Weitere Rolle hinzufügen oder auf Rolle löschen.
    2. Wenn Sie eine Rolle hinzufügen, wählen Sie in der Liste Rolle auswählen eine geeignete Rolle aus.

    3. Klicken Sie auf Weitere Rolle hinzufügen, um eine Rolle hinzuzufügen.

    4. Klicken Sie auf Speichern.

gcloud

  1. Öffnen Sie ein Terminalfenster.

  2. Suchen Sie den Namen des Workflows, den Sie aktualisieren möchten. Wenn Sie den Namen des Workflows nicht kennen, können Sie den folgenden Befehl eingeben, um alle Workflows aufzulisten:

    gcloud workflows list
  3. Suchen Sie die YAML- oder JSON-Datei, in der die Workflowquelle gespeichert ist, z. B. WORKFLOW_NAME.YAML oder WORKFLOW_NAME.JSON.

  4. Mit dem Befehl gcloud workflows deploy können Sie einen vorhandenen Workflow aktualisieren, um die Quelle, die Beschreibung, die Labels, die Umgebungsvariablen, die Anrufprotokollebene, den Verschlüsselungsschlüssel oder das zugehörige Dienstkonto zu ändern.

    Sie müssen den Namen des zu aktualisierenden Workflows und seine Quelle angeben. Die restlichen Flags sind jedoch optional. Verwenden Sie das Flag --clear-kms-key, um einen vom Kunden verwalteten Verschlüsselungsschlüssel zu entfernen.

    gcloud workflows deploy WORKFLOW_NAME \
        --call-log-level=CALL_LOGGING_LEVEL \
        --description="DESCRIPTION" \
        --labels="LABEL_KEY=LABEL_VALUE" \
        --set-env-vars="ENV_KEY=ENV_VALUE" \
        --kms-key=ENCRYPT_KEY \
        --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \
        --source=YAML_OR_JSON_SOURCE_FILE

    Ersetzen Sie Folgendes:

    • WORKFLOW_NAME: erforderlich. Der Name Ihres Workflows.

    • CALL_LOGGING_LEVEL: Optional. Ebene des Aufruf-Loggings, die auf den Workflow angewendet werden soll. Kann einer der folgenden Werte sein:

      • none: 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.
      • log-errors-only: Es werden alle erfassten Ausnahmen sowie das Beenden eines Aufrufs aufgrund einer Ausnahme protokolliert
      • log-all-calls: Alle Aufrufe von untergeordneten Workflows oder Bibliotheksfunktionen und deren Ergebnisse werden protokolliert.
      • log-none: Kein Aufruf-Logging.
    • DESCRIPTION: Optional. Eine Beschreibung des Workflows.

    • LABEL_KEY=LABEL_VALUE: Optional. Liste von Label-Schlüssel/Wert-Paaren, mit denen Sie Ihre Google Cloud-Instanzen organisieren können, z. B. name=wrench. Weitere Informationen finden Sie unter Was sind Labels? Workflowlabels werden von Workflowausführungen übernommen. Wenn Sie Ausführungslabels aufrufen möchten, verwenden Sie die Methode workflows.executions.list, um Workflowausführungen aufzulisten und zu filtern.

    • ENV_KEY=ENV_VALUE: Optional. Liste der Schlüssel/Wert-Paare für Umgebungsvariablen, z. B. MONTH=January. Weitere Informationen finden Sie unter Umgebungsvariablen verwenden.

    • ENCRYPT_KEY: Optional. Ein Cloud KMS-Schlüssel, der vom Workflow für die Datenverschlüsselung im Format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME verwendet werden soll. Weitere Informationen finden Sie unter vom Kunden verwaltete Verschlüsselungsschlüssel verwenden.

    • SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com: Optional. Das Dienstkonto, mit dem Ihr Workflow auf andere Google Cloud-Dienste zugreift. Wenn Sie die Rollen für Ihr Dienstkonto aktualisieren möchten, lesen Sie die Hilfeartikel Zugriff auf Google Cloud-Ressourcen für einen Workflow gewähren und Zugriff auf Projekte, Ordner und Organisationen verwalten.

    • YAML_OR_JSON_SOURCE_FILE: erforderlich. Die Quelldatei für den Workflow im YAML- oder JSON-Format. Beispiel: myFirstWorkflow.yaml.

REST

Verwenden Sie zum Aktualisieren eines vorhandenen Workflows die Methode projects.locations.workflows.patch und optional den Abfrageparameter updateMask, um eine Liste der zu aktualisierenden Felder anzugeben.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

JSON-Text der Anfrage:

{
  "name": "WORKFLOW_NAME",
  "description": "DESCRIPTION",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com",
  "cryptoKeyName": "ENCRYPT_KEY",
  "callLogLevel": "CALL_LOGGING_LEVEL",
  "userEnvVars": {"ENV_KEY":"ENV_VALUE"},
  "sourceContents": "SOURCE_CODE"
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Operation.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "update",
    "apiVersion": "v1"
  },
  "done": false
}

Wenn der Wert von "done" false ist, ist der Vorgang noch aktiv.

Workflow löschen

Sie können einen vorhandenen Workflow löschen. Wenn Sie einen Workflow löschen, werden auch seine Ausführungen gelöscht und alle aktiven Ausführungen für den Workflow abgebrochen.

Console

  1. Öffnen Sie in der Google Cloud Console die Seite Workflows.

    Zur Seite "Workflows"

  2. Klicken Sie auf den Namen des Workflows, den Sie löschen möchten, und dann auf Löschen.

  3. Geben Sie in der Eingabeaufforderung zum Bestätigen des Löschvorgangs den Namen des Workflows ein.

  4. Klicken Sie auf Bestätigen.

gcloud

  1. Öffnen Sie ein Terminalfenster.

  2. Suchen Sie den Namen des Workflows, den Sie löschen möchten. Wenn Sie den Namen des Workflows nicht kennen, können Sie den folgenden Befehl eingeben, um alle Workflows aufzulisten:

    gcloud workflows list
  3. So löschen Sie einen Workflow mit dem Befehl gcloud workflows delete:

    gcloud workflows delete WORKFLOW_NAME

    Ersetzen Sie WORKFLOW_NAME durch den Namen Ihres Workflows.

REST

Wenn Sie einen Workflow mit einem bestimmten Namen löschen möchten, verwenden Sie die Methode projects.locations.workflows.delete.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • WORKFLOW_NAME: Der Name des Workflows, den Sie löschen möchten.
  • PROJECT_ID: Ihre Google Cloud-Projekt-ID.
  • LOCATION: die Region, in der der Workflow bereitgestellt wird, z. B. us-central1.

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata",
    "createTime": "2023-12-05T14:06:06.338390918Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME",
    "verb": "delete",
    "apiVersion": "v1"
  },
  "done": false
}

Wenn der Wert von "done" false ist, ist der Vorgang noch aktiv.

Nächste Schritte