Workflows zum Verbinden von Diensten verwenden

In dieser Anleitung erfahren Sie, wie Sie mit Workflows eine Reihe von Diensten miteinander verknüpfen. Wenn Sie zwei öffentliche HTTP-Dienste mit Cloud Functions (2. Generation), eine externe REST API und einen privaten Cloud Run-Dienst verbinden, können Sie eine flexible, serverlose Anwendung erstellen.

Lernziele

In dieser Anleitung erstellen Sie mithilfe der Google Cloud-Befehlszeile einen einzelnen Workflow und verbinden dabei jeweils einen Dienst:

Stellen Sie zwei Cloud Functions-Dienste bereit: Die erste Funktion generiert eine zufällige Zahl und übergibt sie an die zweite Funktion, die sie multipliziert.
Verbinden Sie mithilfe von Workflows die beiden HTTP-Funktionen. Führen Sie den Workflow aus und geben Sie ein Ergebnis zurück, das dann an eine externe API übergeben wird.
Verbinden Sie mithilfe von Workflows eine externe HTTP-API, die den log für eine bestimmte Nummer zurückgibt. Führen Sie den Workflow aus und geben Sie ein Ergebnis zurück, das dann an einen Cloud Run-Dienst übergeben wird.
Stellen Sie einen Cloud Run-Dienst bereit, der nur den authentifizierten Zugriff zulässt. Der Dienst gibt den math.floor für eine bestimmte Zahl zurück.
Verbinden Sie mithilfe von Workflows den Cloud Run-Dienst, führen Sie den gesamten Workflow aus und geben Sie ein Endergebnis zurück.

Das folgende Diagramm bietet sowohl einen Überblick über den Prozess als auch eine Visualisierung des endgültigen Workflows:

Kosten

In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:

Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen. Neuen Google Cloud-Nutzern steht möglicherweise eine kostenlose Testversion zur Verfügung.

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.

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.

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

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.

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

Enable the Artifact Registry, Cloud Build, Cloud Functions, Cloud Run, Cloud Storage, and Workflows APIs:

gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com cloudfunctions.googleapis.com run.googleapis.com storage.googleapis.com workflows.googleapis.com

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

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.

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

Enable the Artifact Registry, Cloud Build, Cloud Functions, Cloud Run, Cloud Storage, and Workflows APIs:

gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com cloudfunctions.googleapis.com run.googleapis.com storage.googleapis.com workflows.googleapis.com

Aktualisieren Sie die Google Cloud CLI-Komponenten:
```
gcloud components update
```

Wenn Sie Befehle in Cloud Shell ausführen, sind Sie bereits über die gcloud CLI authentifiziert. Melden Sie sich andernfalls mit Ihrem Konto an:
```
gcloud auth login
```

Legen Sie den Standardspeicherort fest, der in dieser Anleitung verwendet wird:

gcloud config set project PROJECT_ID
export REGION=REGION
gcloud config set functions/region ${REGION}
gcloud config set run/region ${REGION}
gcloud config set workflows/location ${REGION}

Ersetzen Sie REGION durch den unterstützten Workflows-Standort Ihrer Wahl.

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 Anleitung benötigen:
- Cloud Build-Bearbeiter (roles/cloudbuild.builds.editor)
- Cloud Functions Developer (roles/cloudfunctions.developer)
- Cloud Run-Administrator (roles/run.admin)
- Create Service Accounts (roles/iam.serviceAccountCreator)
- Projekt-IAM-Administrator (roles/resourcemanager.projectIamAdmin)
- Service Account User (roles/iam.serviceAccountUser)
- Service Usage Consumer (roles/serviceusage.serviceUsageConsumer)
- Storage-Administrator (roles/storage.admin)
- Workflows Editor (roles/workflows.editor)
Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.

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

Hinweis: Einfache IAM-Rollen können auch Berechtigungen zum Ausführen der Anleitung enthalten. In einer Produktionsumgebung sollten Sie keine einfachen Rollen zuweisen, Sie können sie aber in einer Entwicklungs- oder Testumgebung gewähren.

Ersten Cloud Functions-Dienst bereitstellen

Nach dem Empfang einer HTTP-Anfrage generiert diese HTTP-Funktion eine zufällige Zahl zwischen 1 und 100 und gibt die Zahl im JSON-Format zurück.

Erstellen Sie ein Verzeichnis mit dem Namen randomgen und rufen Sie es auf:
```
mkdir ~/randomgen
cd ~/randomgen
```

Erstellen Sie eine Textdatei mit dem Dateinamen main.py, die den folgenden Python-Code enthält:

import functions_framework
import random
from flask import jsonify

@functions_framework.http
def randomgen(request):
    randomNum = random.randint(1, 100)
    output = {"random": randomNum}
    return jsonify(output)

Erstellen Sie eine Textdatei für den pip-Paketmanager, um eine Abhängigkeit von Flask für die HTTP-Verarbeitung zu unterstützen. Geben Sie der Datei den Namen requirements.txt und fügen Sie Folgendes hinzu:
```
flask>=1.0.2
functions-framework==3.0.0
```

Erstellen Sie ein Dienstkonto für Workflows:

export SERVICE_ACCOUNT=workflows-sa
gcloud iam service-accounts create ${SERVICE_ACCOUNT}

Damit das Dienstkonto authentifizierte Cloud Run-Dienste aufrufen kann, weisen Sie dem Workflows-Dienstkonto die Rolle run.invoker zu:

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member "serviceAccount:${SERVICE_ACCOUNT}@PROJECT_ID.iam.gserviceaccount.com" \
    --role "roles/run.invoker"

Stellen Sie die Funktion mit einem HTTP-Trigger bereit und lassen Sie nicht authentifizierten Zugriff zu:
```
gcloud functions deploy randomgen-function \
    --gen2 \
    --runtime python310 \
    --entry-point=randomgen \
    --trigger-http \
    --allow-unauthenticated
```
Die Bereitstellung der Funktion kann einige Minuten dauern. Alternativ können Sie die Funktion über die Cloud Functions-Oberfläche in der Google Cloud Console bereitstellen.

Nachdem die Funktion randomgen bereitgestellt wurde, können Sie das Attribut httpsTrigger.url bestätigen:

gcloud functions describe randomgen-function \
    --gen2 \
    --format="value(serviceConfig.uri)"

Speichern Sie die URL. Sie müssen sie in späteren Übungen Ihrer Workflows-Quelldatei hinzufügen.
Sie können die Funktion mit dem folgenden curl-Befehl ausprobieren:
```
curl $(gcloud functions describe randomgen-function \
    --gen2 \
    --format="value(serviceConfig.uri)")
```
Es wird eine zufällige Zahl generiert und zurückgegeben.

Zweiten Cloud Functions-Dienst bereitstellen

Nach dem Empfangen einer HTTP-Anfrage extrahiert diese HTTP-Funktion den input aus dem JSON-Text, multipliziert ihn mit 2 und gibt das Ergebnis im JSON-Format zurück.

Gehen Sie zurück zum Basisverzeichnis:
```
cd ~
```
Erstellen Sie ein Verzeichnis mit dem Namen multiply und rufen Sie es auf:
```
mkdir ~/multiply
cd ~/multiply
```

Erstellen Sie eine Textdatei mit dem Dateinamen main.py, die den folgenden Python-Code enthält:

import functions_framework
from flask import jsonify

@functions_framework.http
def multiply(request):
    request_json = request.get_json()
    output = {"multiplied": 2 * request_json['input']}
    return jsonify(output)

Erstellen Sie eine Textdatei für den pip-Paketmanager, um eine Abhängigkeit von Flask für die HTTP-Verarbeitung zu unterstützen. Geben Sie der Datei den Namen requirements.txt und fügen Sie Folgendes hinzu:
```
flask>=1.0.2
functions-framework==3.0.0
```
Stellen Sie die Funktion mit einem HTTP-Trigger bereit und lassen Sie nicht authentifizierten Zugriff zu:
```
gcloud functions deploy multiply-function \
    --gen2 \
    --runtime python310 \
    --entry-point=multiply \
    --trigger-http \
    --allow-unauthenticated
```
Die Bereitstellung der Funktion kann einige Minuten dauern. Alternativ können Sie die Funktion über die Cloud Functions-Oberfläche in der Google Cloud Console bereitstellen.

Nachdem die Funktion multiply bereitgestellt wurde, können Sie das Attribut httpsTrigger.url bestätigen:

gcloud functions describe multiply-function \
    --gen2\
    --format="value(serviceConfig.uri)"

Speichern Sie die URL. Sie müssen sie in späteren Übungen Ihrer Workflows-Quelldatei hinzufügen.

Sie können die Funktion mit dem folgenden curl-Befehl ausprobieren:

curl -X POST MULTIPLY_FUNCTION_URL \
    -H "Authorization: Bearer $(gcloud auth print-identity-token)" \
    -H "Content-Type: application/json" \
    -d '{"input": 5}'

Es sollte die Zahl 10 zurückgegeben werden.

Die beiden Cloud Functions-Dienste in einem Workflow verbinden

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. Dies ist die Definition des Workflows. Eine ausführliche Erläuterung finden Sie auf der Seite Syntaxreferenz.

Gehen Sie zurück zum Basisverzeichnis:
```
cd ~
```
Erstellen Sie eine Textdatei mit dem Dateinamen workflow.yaml, die den folgenden Inhalt enthält:
```
- randomgen_function:
    call: http.get
    args:
        url: RANDOMGEN_FUNCTION_URL
    result: randomgen_result
- multiply_function:
    call: http.post
    args:
        url: MULTIPLY_FUNCTION_URL
        body:
            input: ${randomgen_result.body.random}
    result: multiply_result
- return_result:
    return: ${multiply_result}
```
- Ersetzen Sie RANDOMGEN_FUNCTION_URL durch die URL Ihrer randomgen-Funktion.
- Ersetzen Sie MULTIPLY_FUNCTION_URL durch die URL Ihrer multiply-Funktion.
Diese Quelldatei verknüpft die beiden HTTP-Funktionen und gibt ein Endergebnis zurück.

Hinweis: Verwenden Sie OIDC zur Authentifizierung, um eine Anfrage an eine Cloud Functions-Funktion zu senden, die nur authentifizierte Aufrufe akzeptiert. Weitere Informationen finden Sie unter Authentifizierte Anfragen von einem Workflow aus ausführen.
Nachdem Sie den Workflow erstellt haben, können Sie ihn bereitstellen, wodurch er für die Ausführung bereit ist.
```
gcloud workflows deploy WORKFLOW_NAME \
    --source=workflow.yaml
```
Ersetzen Sie WORKFLOW_NAME mit einem Namen für Ihren Workflow.
Führen Sie den Workflow aus:
```
gcloud workflows run WORKFLOW_NAME
```
Eine Ausführung ist ein einzelner Durchlauf der Logik, die in der Definition eines Workflows enthalten ist. Alle Workflowausführungen sind unabhängig und die schnelle Skalierung von Workflows ermöglicht eine hohe Anzahl gleichzeitiger Ausführungen.

Nachdem der Workflow ausgeführt wurde, sollte die Ausgabe in etwa so aussehen:
```
result: '{"body":{"multiplied":120},"code":200,"headers":{"Alt-Svc":"h3-29=\":443\";
...
startTime: '2021-05-05T14:17:39.135251700Z'
state: SUCCEEDED
...
```

Öffentlichen REST-Dienst mit dem Workflow verbinden

Aktualisieren Sie Ihren vorhandenen Workflow und verbinden Sie eine öffentliche REST API (math.js), die mathematische Ausdrücke auswerten kann. Beispiel: curl https://api.mathjs.org/v4/?'expr=log(56)'

Da Sie Ihren Workflow bereitgestellt haben, können Sie ihn auch auf der Seite „Workflows in der Google Cloud Console“ bearbeiten.

Bearbeiten Sie die Quelldatei für Ihren Workflow und ersetzen Sie sie durch folgenden Inhalt:

- randomgen_function:
    call: http.get
    args:
        url: RANDOMGEN_FUNCTION_URL
    result: randomgen_result
- multiply_function:
    call: http.post
    args:
        url: MULTIPLY_FUNCTION_URL
        body:
            input: ${randomgen_result.body.random}
    result: multiply_result
- log_function:
    call: http.get
    args:
        url: https://api.mathjs.org/v4/
        query:
            expr: ${"log(" + string(multiply_result.body.multiplied) + ")"}
    result: log_result
- return_result:
    return: ${log_result}

Ersetzen Sie RANDOMGEN_FUNCTION_URL durch die URL Ihrer randomgen-Funktion.
Ersetzen Sie MULTIPLY_FUNCTION_URL durch die URL Ihrer multiply-Funktion.

Dadurch wird der externe REST-Dienst mit den Cloud Functions-Diensten verknüpft und ein Endergebnis zurückgegeben.

Stellen Sie den geänderten Workflow bereit:

gcloud workflows deploy WORKFLOW_NAME \
    --source=workflow.yaml

Cloud Run-Dienst bereitstellen

Stellen Sie einen Cloud Run-Dienst bereit, der nach dem Erhalt einer HTTP-Anfrage den input aus dem JSON-Text extrahiert, den math.floor berechnet und das Ergebnis zurückgibt.

Erstellen Sie ein Verzeichnis mit dem Namen floor und rufen Sie es auf:
```
mkdir ~/floor
cd ~/floor
```

Erstellen Sie eine Textdatei mit dem Dateinamen app.py, die den folgenden Python-Code enthält:

import json
import logging
import os
import math

from flask import Flask, request

app = Flask(__name__)

@app.route('/', methods=['POST'])
def handle_post():
    content = json.loads(request.data)
    input = float(content['input'])
    return f"{math.floor(input)}", 200

if __name__ != '__main__':
    # Redirect Flask logs to Gunicorn logs
    gunicorn_logger = logging.getLogger('gunicorn.error')
    app.logger.handlers = gunicorn_logger.handlers
    app.logger.setLevel(gunicorn_logger.level)
    app.logger.info('Service started...')
else:
    app.run(debug=True, host='0.0.0.0', port=int(os.environ.get('PORT', 8080)))

Erstellen Sie im selben Verzeichnis eine Dockerfile mit folgendem Inhalt:

# Use an official lightweight Python image.
# https://hub.docker.com/_/python
FROM python:3.7-slim

# Install production dependencies.
RUN pip install Flask gunicorn

# Copy local code to the container image.
WORKDIR /app
COPY . .

# Run the web service on container startup. Here we use the gunicorn
# webserver, with one worker process and 8 threads.
# For environments with multiple CPU cores, increase the number of workers
# to be equal to the cores available.
CMD exec gunicorn --bind 0.0.0.0:8080 --workers 1 --threads 8 app:app

Erstellen Sie ein Artifact Registry-Standard-Repository, in dem Sie Ihr Docker-Container-Image speichern können:
```
gcloud artifacts repositories create REPOSITORY \
    --repository-format=docker \
    --location=${REGION}
```
Ersetzen Sie REPOSITORY durch einen eindeutigen Namen für das Repository.

Erstellen Sie das Container-Image:

export SERVICE_NAME=floor
gcloud builds submit --tag ${REGION}-docker.pkg.dev/PROJECT_ID/REPOSITORY/${SERVICE_NAME}

Stellen Sie das Container-Image in Cloud Run bereit und achten Sie darauf, dass nur authentifizierte Aufrufe akzeptiert werden:

gcloud run deploy ${SERVICE_NAME} \
    --image ${REGION}-docker.pkg.dev/PROJECT_ID/REPOSITORY/${SERVICE_NAME}:latest \
    --no-allow-unauthenticated

Wenn die Dienst-URL angezeigt wird, wurde sie erfolgreich bereitgestellt. Sie müssen diese URL beim Aktualisieren der Workflow-Definition angeben.

Cloud Run-Dienst mit dem Workflow verbinden

Aktualisieren Sie Ihren vorhandenen Workflow und geben Sie die URL für den Cloud Run-Dienst an.

Bearbeiten Sie die Quelldatei für Ihren Workflow und ersetzen Sie sie durch folgenden Inhalt:

- randomgen_function:
    call: http.get
    args:
        url: RANDOMGEN_FUNCTION_URL
    result: randomgen_result
- multiply_function:
    call: http.post
    args:
        url: MULTIPLY_FUNCTION_URL
        body:
            input: ${randomgen_result.body.random}
    result: multiply_result
- log_function:
    call: http.get
    args:
        url: https://api.mathjs.org/v4/
        query:
            expr: ${"log(" + string(multiply_result.body.multiplied) + ")"}
    result: log_result
- floor_function:
    call: http.post
    args:
        url: CLOUD_RUN_SERVICE_URL
        auth:
            type: OIDC
        body:
            input: ${log_result.body}
    result: floor_result
- create_output_map:
    assign:
      - outputMap:
          randomResult: ${randomgen_result}
          multiplyResult: ${multiply_result}
          logResult: ${log_result}
          floorResult: ${floor_result}
- return_output:
    return: ${outputMap}

Ersetzen Sie RANDOMGEN_FUNCTION_URL durch die URL Ihrer randomgen-Funktion.
Ersetzen Sie MULTIPLY_FUNCTION_URL durch die URL Ihrer multiply-Funktion.
Ersetzen Sie CLOUD_RUN_SERVICE_URL durch die URL des Cloud Run-Dienstes.

Dadurch wird der Cloud Run-Dienst im Workflow verbunden. Der Schlüssel auth sorgt dafür, dass ein Authentifizierungstoken an den Aufruf des Cloud Run-Dienstes übergeben wird. Weitere Informationen finden Sie unter Authentifizierte Anfragen von einem Workflow aus ausführen.

Stellen Sie den geänderten Workflow bereit:

gcloud workflows deploy WORKFLOW_NAME \
    --source=workflow.yaml

Abschließenden Workflow ausführen:

gcloud workflows run WORKFLOW_NAME

Die Ausgabe sollte in etwa so aussehen:

result: '{"Floor":{"body":"4","code":200
  ...
  "Log":{"body":"4.02535169073515","code":200
  ...
  "Multiply":{"body":{"multiplied":56},"code":200
  ...
  "Random":{"body":{"random":28},"code":200
  ...
startTime: '2023-11-13T21:22:56.782669001Z'
state: SUCCEEDED

Das war's auch schon! Sie haben einen Workflow bereitgestellt und ausgeführt, der eine Reihe von Diensten miteinander verbindet.

Weitere Informationen zur Erstellung komplexerer Workflows mit Ausdrücken, bedingten Sprüngen, Base64-Codierung/-Decodierung, Subworkflows und mehr finden Sie in der Workflow-Syntaxreferenz und in der Standardbibliothek – Übersicht.

Bereinigen

Wenn Sie ein neues Projekt für diese Anleitung erstellt haben, löschen Sie das Projekt. Wenn Sie ein vorhandenes Projekt verwendet haben und es beibehalten möchten, ohne die Änderungen in dieser Anleitung hinzuzufügen, löschen Sie die für die Anleitung erstellten Ressourcen.

Projekt löschen

Am einfachsten vermeiden Sie weitere Kosten durch Löschen des für die Anleitung erstellten Projekts.

So löschen Sie das Projekt:

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.

Wenn Sie mehrere Architekturen, Anleitungen und Kurzanleitungen durcharbeiten möchten, können Sie die Überschreitung von Projektkontingenten verhindern, indem Sie Projekte wiederverwenden.

In the Google Cloud console, go to the Manage resources page.
Go to Manage resources
In the project list, select the project that you want to delete, and then click Delete.
In the dialog, type the project ID, and then click Shut down to delete the project.

Anleitungsressourcen löschen

Löschen Sie den Cloud Run-Dienst, den Sie in dieser Anleitung bereitgestellt haben:
Löschen Sie den Workflow, den Sie in dieser Anleitung erstellt haben.
Löschen Sie das Container-Image aus Artifact Registry.
Löschen Sie das Artifact Registry-Repository.

Entfernen Sie die Standardkonfigurationen der Google Cloud CLI, die Sie während der Einrichtung der Anleitung hinzugefügt haben.

gcloud config unset functions/region
gcloud config unset run/region
gcloud config unset workflows/location
gcloud config unset project