In diesem Dokument wird beschrieben, wie Sie mit Terraform und der Ressource google_eventarc_trigger
Eventarc-Trigger für die folgenden Google CloudZiele erstellen:
Weitere Informationen zur Verwendung von Terraform finden Sie in der Terraform-Dokumentation für Google Cloud.
Die Codebeispiele in diesem Leitfaden leiten direkte Ereignisse von Cloud Storage weiter, können aber für jeden Ereignisanbieter angepasst werden. Wie Sie direkte Ereignisse beispielsweise von Pub/Sub an Cloud Run weiterleiten, erfahren Sie in der Terraform-Kurzanleitung.
Hinweis
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Resource Manager and Identity and Access Management (IAM) APIs.
-
In the Google Cloud console, 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.
Terraform ist in die Cloud Shell-Umgebung integriert. Sie können Ihre Terraform-Ressourcen also mit Cloud Shell bereitstellen, ohne Terraform installieren zu müssen.
Terraform-Bereitstellung vorbereiten
Bevor Sie Terraform-Ressourcen bereitstellen können, müssen Sie eine Terraform-Konfigurationsdatei erstellen. In einer Terraform-Konfigurationsdatei können Sie den gewünschten Endzustand Ihrer Infrastruktur mithilfe der Terraform-Syntax definieren.
Cloud Shell vorbereiten
Legen Sie in Cloud Shell das Google Cloud-Standardprojekt fest, auf das Sie Ihre Terraform-Konfigurationen anwenden möchten. Sie müssen diesen Befehl nur einmal pro Projekt und in einem beliebigen Verzeichnis ausführen:
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
Ersetzen Sie PROJECT_ID
durch die ID Ihres Google Cloud-Projekts.
Umgebungsvariablen werden überschrieben, wenn Sie in der Terraform-Konfigurationsdatei explizite Werte festlegen.
Verzeichnis vorbereiten
Jede Terraform-Konfigurationsdatei muss ein eigenes Verzeichnis haben (auch als Stammmodul bezeichnet). Erstellen Sie in Cloud Shell ein Verzeichnis und eine neue Datei in diesem Verzeichnis:
mkdir DIRECTORY && cd DIRECTORY && touch main.tf
Der Dateiname muss die Erweiterung .tf
haben. In diesem Dokument wird die Datei beispielsweise als main.tf
bezeichnet.
Terraform-Konfiguration definieren
Kopieren Sie die entsprechenden Terraform-Codebeispiele in die neu erstellte main.tf
-Datei. Sie können den Code auch aus GitHub kopieren. Dies wird empfohlen, wenn das Terraform-Snippet Teil einer End-to-End-Lösung ist.
Normalerweise wenden Sie die gesamte Konfiguration auf einmal an. Sie können jedoch auch eine bestimmte Ressource anvisieren. Beispiel:
terraform apply -target="google_eventarc_trigger.default"
In den Terraform-Codebeispielen wird Interpolation für Substitutionen wie Referenzvariablen, Attribute von Ressourcen und Aufruffunktionen verwendet.
APIs aktivieren
Bei Terraform-Beispielen wird in der Regel davon ausgegangen, dass die erforderlichen APIs in Ihrem Google Cloud-Projekt aktiviert sind. Verwenden Sie den folgenden Code, um die APIs zu aktivieren:
Cloud Run
GKE
Workflows
Dienstkonto erstellen und Zugriff konfigurieren
Jeder Eventarc-Trigger ist zum Zeitpunkt der Erstellung des Triggers mit einem IAM-Dienstkonto verknüpft. Verwenden Sie den folgenden Code, um ein spezielles Dienstkonto zu erstellen und dem nutzerverwalteten Dienstkonto bestimmte Rollen für die Identitäts- und Zugriffsverwaltung zum Verwalten von Ereignissen zuzuweisen:
Cloud Run
Der Pub/Sub-Dienst-Agent wird automatisch erstellt, wenn die Pub/Sub API aktiviert ist. Wenn der Pub/Sub-Dienst-Agent am oder vor dem 8. April 2021 erstellt wurde und das Dienstkonto nicht die Rolle Cloud Pub/Sub-Dienst-Agent (roles/pubsub.serviceAgent
) hat, weisen Sie dem Dienst-Agent die Rolle Ersteller von Dienstkonto-Tokens (roles/iam.serviceAccountTokenCreator
) zu. Weitere Informationen finden Sie unter Rollen erstellen und ihnen Dienst-Agents zuweisen.
resource "google_project_iam_member" "tokencreator" { project = data.google_project.project.id role = "roles/iam.serviceAccountTokenCreator" member = "serviceAccount:service-${data.google_project.project.number}@gcp-sa-pubsub.iam.gserviceaccount.com" }
GKE
Aktivieren Sie Eventarc, bevor Sie das Dienstkonto erstellen, um GKE-Cluster zu verwalten:
Erstellen Sie das Dienstkonto:
Workflows
Der Pub/Sub-Dienst-Agent wird automatisch erstellt, wenn die Pub/Sub API aktiviert ist. Wenn der Pub/Sub-Dienst-Agent am oder vor dem 8. April 2021 erstellt wurde und das Dienstkonto nicht die Rolle „Cloud Pub/Sub-Dienst-Agent“ (roles/pubsub.serviceAgent
) hat, weisen Sie dem Dienst-Agenten die Rolle Ersteller von Dienstkonto-Tokens (roles/iam.serviceAccountTokenCreator
) zu. Weitere Informationen finden Sie unter Rollen erstellen und ihnen Dienst-Agents zuweisen.
resource "google_project_iam_member" "tokencreator" { project = data.google_project.project.id role = "roles/iam.serviceAccountTokenCreator" member = "serviceAccount:service-${data.google_project.project.number}@gcp-sa-pubsub.iam.gserviceaccount.com" }
Cloud Storage-Bucket als Ereignisanbieter erstellen
Erstellen Sie mit dem folgenden Code einen Cloud Storage-Bucket und weisen Sie dem Cloud Storage-Dienst-Agent die Pub/Sub-Publisher-Rolle (roles/pubsub.publisher
) zu.
Cloud Run
GKE
Workflows
Ereignisempfänger als Ereignisziel erstellen
Erstellen Sie einen Ereignisempfänger mit einer der folgenden Terraform-Ressourcen:
Cloud Run
Erstellen Sie einen Cloud Run-Dienst als Ereignisziel für den Eventarc-Trigger:
GKE
Um diesen Leitfaden zu vereinfachen, erstellen Sie einen Google Kubernetes Engine-Dienst als Ereignisziel außerhalb von Terraform, zwischen dem Anwenden von Terraform-Konfigurationen.
Wenn Sie in diesem Google Cloud-Projekt noch keinen Trigger erstellt haben, führen Sie den folgenden Befehl aus, um den Eventarc-Dienst-Agenten zu erstellen:
gcloud beta services identity create --service eventarc.googleapis.com
Erstellen Sie einen GKE-Cluster.
Kubernetes-Dienst in GKE bereitstellen, der HTTP-Anfragen und Log-Ereignisse mit einem vordefinierten Cloud Run-Image empfängt:
us-docker.pkg.dev/cloudrun/container/hello
:Rufen Sie die Anmeldedaten für die Authentifizierung ab, um mit dem Cluster zu interagieren:
gcloud container clusters get-credentials eventarc-cluster \ --region=us-central1
Erstellen Sie ein Deployment mit dem Namen
hello-gke
:kubectl create deployment hello-gke \ --image=us-docker.pkg.dev/cloudrun/container/hello
Stellen Sie das Deployment als Kubernetes-Dienst bereit:
kubectl expose deployment hello-gke \ --type ClusterIP --port 80 --target-port 8080
Prüfen Sie, ob der Pod ausgeführt wird:
kubectl get pods
Die Ausgabe sollte in etwa so aussehen:
NAME READY STATUS RESTARTS AGE hello-gke-5b6574b4db-rzzcr 1/1 Running 0 2m45s
Wenn
STATUS
Pending
oderContainerCreating
ist, wird der Pod bereitgestellt. Warten Sie eine Minute, bis die Bereitstellung abgeschlossen ist, und prüfen Sie den Status noch einmal.Prüfen Sie, ob der Dienst ausgeführt wird:
kubectl get svc
Die Ausgabe sollte in etwa so aussehen:
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE hello-gke ClusterIP 34.118.230.123 <none> 80/TCP 4m46s kubernetes ClusterIP 34.118.224.1 <none> 443/TCP 14m
Workflows
Stellen Sie einen Workflow bereit, der ausgeführt wird, wenn ein Objekt im Cloud Storage-Bucket aktualisiert wird:
Eventarc-Trigger definieren
Ein Eventarc-Trigger leitet Ereignisse von einem Ereignisanbieter an ein Ereignisziel weiter. Verwenden Sie die Ressource google_eventarc_trigger
, um CloudEvents-Attribute in matching_criteria
anzugeben und die Ereignisse zu filtern. Weitere Informationen finden Sie in der Anleitung zum Erstellen eines Triggers für einen bestimmten Anbieter und Ereignistyp und ein bestimmtes Ziel.
Ereignisse, die mit allen Filtern übereinstimmen, werden an das Ziel gesendet.
Cloud Run
Erstellen Sie einen Eventarc-Trigger, der Cloud Storage-Ereignisse an den hello-event
Cloud Run-Dienst weiterleitet.
GKE
Erstellen Sie einen Eventarc-Trigger, der Cloud Storage-Ereignisse an den GKE-Dienst hello-gke
weiterleitet.
Workflows
Erstellen Sie einen Eventarc-Trigger, der Cloud Storage-Ereignisse an den Workflow mit dem Namen storage-workflow-tf
weiterleitet.
Terraform anwenden
Verwenden Sie die Terraform-Befehlszeile, um die Infrastruktur basierend auf der Konfigurationsdatei bereitzustellen.
Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.
Initialisieren Sie Terraform. Dies ist nur einmal für jedes Verzeichnis erforderlich.
terraform init
Fügen Sie optional die Option
-upgrade
ein, um die neueste Google-Anbieterversion zu verwenden:terraform init -upgrade
Prüfen Sie die Konfiguration und prüfen Sie, ob die Ressourcen, die Terraform erstellen oder aktualisieren wird, Ihren Erwartungen entsprechen:
terraform plan
Korrigieren Sie die Konfiguration nach Bedarf.
Wenden Sie die Terraform-Konfiguration an. Führen Sie dazu den folgenden Befehl aus und geben Sie
yes
an der Eingabeaufforderung ein:terraform apply
Warten Sie, bis Terraform die Meldung „Apply complete“ anzeigt.
Erstellung von Ressourcen prüfen
Cloud Run
Prüfen Sie, ob der Dienst erstellt wurde:
gcloud run services list --region us-central1
Prüfen Sie, ob der Trigger erstellt wurde:
gcloud eventarc triggers list --location us-central1
Die Ausgabe sollte in etwa so aussehen:
NAME: trigger-storage-cloudrun-tf TYPE: google.cloud.storage.object.v1.finalized DESTINATION: Cloud Run service: hello-events ACTIVE: Yes LOCATION: us-central1
GKE
Prüfen Sie, ob der Dienst erstellt wurde:
kubectl get service hello-gke
Prüfen Sie, ob der Trigger erstellt wurde:
gcloud eventarc triggers list --location us-central1
Die Ausgabe sollte in etwa so aussehen:
NAME: trigger-storage-gke-tf TYPE: google.cloud.storage.object.v1.finalized DESTINATION: GKE: hello-gke ACTIVE: Yes LOCATION: us-central1
Workflows
Prüfen Sie, ob der Workflow erstellt wurde:
gcloud workflows list --location us-central1
Prüfen Sie, ob der Eventarc-Trigger erstellt wurde:
gcloud eventarc triggers list --location us-central1
Die Ausgabe sollte in etwa so aussehen:
NAME: trigger-storage-workflows-tf TYPE: google.cloud.storage.object.v1.finalized DESTINATION: Workflows: storage-workflow-tf ACTIVE: Yes LOCATION: us-central1
Ereignis erstellen und abrufen
Sie können ein Ereignis generieren und prüfen, ob der Eventarc-Trigger wie erwartet funktioniert.
Rufen Sie den Namen des zuvor erstellten Cloud Storage-Buckets ab:
gcloud storage ls
Laden Sie eine Textdatei in den Cloud Storage-Bucket hoch:
echo "Hello World" > random.txt gcloud storage cp random.txt gs://BUCKET_NAME/random.txt
Ersetzen Sie
BUCKET_NAME
durch den Namen des Cloud Storage-Buckets, den Sie im vorherigen Schritt abgerufen haben. Beispiel:gcloud storage cp random.txt gs://BUCKET_NAME/random.txt
Beim Upload wird ein Ereignis erstellt und der Ereignisempfängerdienst protokolliert die Nachricht des Ereignisses.
Prüfen, ob ein Ereignis empfangen wird:
Cloud Run
So filtern Sie die von Ihrem Dienst erstellten Logeinträge:
gcloud logging read 'jsonPayload.message: "Received event of type google.cloud.storage.object.v1.finalized."'
Suchen Sie nach einem Logeintrag wie dem Folgenden:
Received event of type google.cloud.storage.object.v1.finalized. Event data: { "kind": "storage#object", "id": "trigger-cloudrun-BUCKET_NAME/random.txt", ...}
GKE
Suchen Sie die Pod-ID:
POD_NAME=$(kubectl get pods -o custom-columns=":metadata.name" --no-headers)
Hier wird die formatierte Ausgabe von
kubectl
verwendet.Prüfen Sie die Logs des Pods:
kubectl logs $POD_NAME
Suchen Sie nach einem Logeintrag wie dem Folgenden:
{"severity":"INFO","eventType":"google.cloud.storage.object.v1.finalized","message": "Received event of type google.cloud.storage.object.v1.finalized. Event data: ...}
Workflows
Prüfen Sie, ob eine Workflowausführung ausgelöst wird, indem Sie die letzten fünf Ausführungen auflisten lassen:
gcloud workflows executions list storage-workflow-tf --limit=5
Die Ausgabe sollte eine Liste der Ausführungen mit
NAME
,STATE
,START_TIME
undEND_TIME
enthalten.So rufen Sie die Ergebnisse der letzten Ausführung ab:
EXECUTION_NAME=$(gcloud workflows executions list storage-workflow-tf --limit=1 --format "value(name)") gcloud workflows executions describe $EXECUTION_NAME
Die Ausgabe sollte in etwa so aussehen:
... result: '"Received event google.cloud.storage.object.v1.finalized - BUCKET_NAME, random.txt"' startTime: '2024-12-13T17:23:50.451316533Z' state: SUCCEEDED ...
Bereinigen
Entfernen Sie Ressourcen, die zuvor mit Ihrer Terraform-Konfiguration angewendet wurden, indem Sie den folgenden Befehl ausführen und yes
an der Eingabeaufforderung eingeben:
terraform destroy
Sie können auch 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.
- In the Google Cloud console, go to the Manage resources page.
- 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.