Registrierung zum Empfang von Ereignissen erstellen

Pipeline

1. Öffnen Sie ein Terminalfenster.

2. Erstellen Sie mit dem Befehl gcloud beta eventarc pipelines create eine Pipeline:

   gcloud beta eventarc pipelines create PIPELINE_NAME \
       --destinations=DESTINATION_KEY \
       --location=LOCATION

   Ersetzen Sie Folgendes:

   • PIPELINE_NAME: die ID der Pipeline oder ein voll qualifizierter Name

   • DESTINATION_KEY: ein oder mehrere Schlüssel/Wert-Paare zum Konfigurieren eines Ziels für die Pipeline

     Sie müssen nur einen der folgenden Schlüssel festlegen:

     • http_endpoint_uri: ein Ziel-URI. Der Host kann entweder eine statische IP-Adresse sein, die über ein VPC-Netzwerk (Virtual Private Cloud) erreichbar ist, oder der interne DNS-Hostname (Domain Name System) eines Dienstes, der mit Cloud DNS aufgelöst werden kann. Optional können Sie auch http_endpoint_message_binding_template festlegen, um eine Nachrichtenbindung anzugeben.

       Mit diesem Schlüssel können Sie eine Cloud Run-Funktion, einen Cloud Run-Job oder einen Cloud Run-Dienst als Ziel festlegen, der Ereignisse als HTTP-POST-Anfragen empfängt.

     • message_bus – die ID eines Eventarc Advanced-Busses.

     • pubsub_topic: die ID eines Pub/Sub-Themas.

     • workflow: die ID eines Workflows-Workflows.

     Für http_endpoint_uri (einschließlich Cloud Run-URLs) müssen Sie den folgenden Schlüssel festlegen:

     • network_attachment: Eine Ressource, mit der ein Produzenten-VPC-Netzwerk Verbindungen zu einem Nutzer-VPC-Netzwerk initiieren kann. Eventarc Advanced verwendet zum Veröffentlichen von Ereignissen den Netzwerkanhang, um eine Verbindung zum Endpunkt herzustellen, der in einem VPC-Netzwerk gehostet wird.

       Sie können einen Netzwerkanhang erstellen, der automatisch Verbindungen von jeder Private Service Connect-Schnittstelle akzeptiert, die auf den Netzwerkanhang verweist. Erstellen Sie den Netzwerkanhang im selben Netzwerk und in derselben Region wie die Zielressource.

       Wenn Sie Nachrichten mithilfe einer DNS-Adresse an ein Google-Ziel weiterleiten, z. B. Cloud Run, muss der private Google-Zugriff in dem im Netzwerkanhang verwendeten Subnetz aktiviert sein; ansonsten kann die DNS-Adresse nicht aufgelöst werden.

     Zum Aktivieren der Authentifizierung können Sie einen der folgenden Schlüssel festlegen:

     • google_oidc_authentication_service_account: Die E-Mail-Adresse des Dienstkontos, mit der ein OIDC-Token generiert wird, das für viele Szenarien verwendet werden kann, einschließlich Endpunkten, an denen Sie das Token selbst validieren möchten. Optional können Sie google_oidc_authentication_audience festlegen, um die Zielgruppe anzugeben, für die dieses Token vorgesehen ist. Im Allgemeinen sollte sie mit der URL der Zielpipeline übereinstimmen. Falls nichts angegeben wurde, wird die gesamte URL einschließlich aller Anfrageparameter verwendet.

       Cloud Run führt für jede Anfrage eine IAM-Prüfung durch. Mit der Berechtigung run.routes.invoke können Sie so konfigurieren, wer auf Ihren Cloud Run-Dienst zugreifen kann:

       • Erteilen Sie die Berechtigung zum Auswählen von Dienstkonten oder Gruppen, um den Zugriff auf den Dienst zu ermöglichen. Alle Anfragen müssen einen HTTP-Autorisierungs-Header enthalten, der ein von Google für ein autorisiertes Dienstkonto signiertes OpenID Connect-Token enthält.

       • Erteilen Sie allUsers die Berechtigung, den nicht authentifizierten Zugriff zuzulassen.

       Weitere Informationen finden Sie unter Zugriffssteuerung für Cloud Run .

     • oauth_token_authentication_service_account: Die E-Mail-Adresse des Dienstkontos, mit der ein OAuth-Token generiert wird, das in der Regel nur beim Aufrufen von Google APIs verwendet werden sollte, die auf *.googleapis.com gehostet werden. Optional können Sie oauth_token_authentication_scope festlegen, um den Bereich dieses Tokens anzugeben. Andernfalls wird standardmäßig https://www.googleapis.com/auth/cloud-platform verwendet. FürGoogle Cloud -Dienste empfiehlt es sich, den Bereich https://www.googleapis.com/auth/cloud-platform zu verwenden. Dieser enthält alle Google Cloud -APIs zusammen mit Identitäts- und Zugriffsverwaltung (Identity and Access Management, IAM), die eine detaillierte Zugriffssteuerung bietet.

       Alle Anfragen an einen anderen Eventarc Advanced-Bus, Pub/Sub oder Workflows müssen einen HTTP-Autorisierungs-Header mit einem von Google für eines der autorisierten Dienstkonten signierten OAuth-Token enthalten.

       Weitere Informationen zu Tokentypen

     Optional: Sie können einen der folgenden Schlüssel festlegen:

     • output_payload_format_avro_schema_definition
     • output_payload_format_json

     • output_payload_format_protobuf_schema_definition

       Wenn Sie ein Ausgabeformat festlegen, müssen Sie auch ein Eingabeformat angeben (siehe die folgenden input-payload-format-*-Flags).

     Optional: Wenn http_endpoint_uri nicht als Zielschlüssel verwendet wird, können Sie die folgenden Schlüssel festlegen:

     • project: Die Google Cloud Projekt-ID der Zielressource. Standardmäßig wird die Projekt-ID für die Pipeline verwendet.
     • location: Der Speicherort der Zielressource. Standardmäßig wird der Speicherort für die Pipeline verwendet.

   • LOCATION: eine unterstützte Eventarc Advanced-Region

     Alternativ können Sie das Attribut für den Speicherort der gcloud CLI festlegen:

     gcloud config set eventarc/location LOCATION
     

   Optional können Sie die folgenden Flags verwenden:

   • --async, um sofort vom Befehl zurückzukehren, ohne auf den Abschluss des Vorgangs zu warten.
   • --crypto-key, um den voll qualifizierten Namen eines vom Kunden verwalteten Verschlüsselungsschlüssels anzugeben. Wenn nicht angegeben, werden Google-owned and managed keys verwendet.
   • --logging-config zum Konfigurieren der Protokollierungsebene, die eine der folgenden sein muss: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.

   • --mediations, um eine Transformation anzuwenden; transformation_template ist die einzige unterstützte Vorlage und pro Pipeline wird nur eine Vermittlung unterstützt, z. B.:

     --mediations=transformation_template='message.removeFields(["id\ ","credit_card_number","age"])'

     Wenn Sie eine Transformation anwenden, müssen Sie eines der folgenden Flags verwenden, um ein Eingabeformat anzugeben.

   • Eine der folgenden Optionen zum Angeben eines Eingabeformats:

     • --input-payload-format-avro-schema-definition
     • --input-payload-format-json
     • --input-payload-format-protobuf-schema-definition

   • --max-retry-attempts, --max-retry-delay und --min-retry-delay bis zu Wiederholungsereignissen

   Beispiel:

   gcloud beta eventarc pipelines create my-pipeline \
       --destinations=http_endpoint_uri='https://example-endpoint.com',network_attachment=my-network-attachment,oauth_token_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com,oauth_token_authentication_scope='https://www.googleapis.com/auth/cloud-platform',output_payload_format_avro_schema_definition='{"type": "record","name": "my_record", "fields": [{"name": "my_field", "type":"string"}]}' \
       --input-payload-format-avro-schema-definition='{"type":"record", "name": "my_record", "fields": [{"name": "my_field","type": "string"}]}' \
       --location=us-central1 \
       --async
   

   Weitere Informationen und Beispiele finden Sie in der Dokumentation zur gcloud CLI.

Registrierung

1. Öffnen Sie ein Terminalfenster.

2. Erstellen Sie mit dem Befehl gcloud beta eventarc enrollments create eine Registrierung:

   gcloud beta eventarc enrollments create ENROLLMENT_NAME \
       --cel-match=MATCH_EXPRESSION \
       --destination-pipeline=PIPELINE_NAME \
       --message-bus=BUS_NAME \
       --message-bus-project=PROJECT_ID \
       --location=LOCATION

   Ersetzen Sie Folgendes:

   • ENROLLMENT_NAME: die ID der Registrierung oder ein voll qualifizierter Name
   • MATCH_EXPRESSION: Der Abgleichsausdruck für diese Registrierung mit CEL, z. B. "message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'"
   • PIPELINE_NAME: die ID der Zielpipeline oder ihr vollständig qualifizierter Name für diese Registrierung
   • BUS_NAME: die ID des Eventarc Advanced-Busses oder sein voll qualifizierter Name
   • PROJECT_ID: die Google Cloud Projekt-ID für den Bus

   • LOCATION: eine unterstützte Eventarc Advanced-Region

     Alternativ können Sie das Attribut für den Speicherort der gcloud CLI festlegen:

     gcloud config set eventarc/location LOCATION
     

   Optional können Sie das folgende Flag verwenden:

   • --async, um sofort vom Befehl zurückzukehren, ohne auf den Abschluss des Vorgangs zu warten

   Beispiel:

   gcloud beta eventarc enrollments create my-enrollment \
       --cel-match="message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'" \
       --destination-pipeline=my-pipeline \
       --message-bus=my-message-bus \
       --message-bus-project=another-google-cloud-project \
       --location=us-central1 \
       --async
   

Pipeline

Verwenden Sie zum Erstellen einer Pipeline die Methode projects.locations.pipelines.create.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

• name: Der vollständige Ressourcenname der Pipeline im Format projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME.

  Ersetzen Sie Folgendes:

  • PROJECT_ID: die Google CloudProjekt-ID für das Pipeline-Projekt
  • LOCATION: die Region, in der die Pipeline bereitgestellt werden soll, z. B. us-central1
  • PIPELINE_NAME: der Name der Pipeline
• LABEL_KEY und LABEL_VALUE: Optional. Eine Zuordnung von Label-Schlüssel/Wert-Paaren, mit denen Sie Ihre Google Cloud Ressourcen organisieren können. Weitere Informationen finden Sie unter Was sind Labels?
• ANNOTATION_KEY und ANNOTATION_VALUE: Optional. Eine Zuordnung von Schlüssel/Wert-Paaren für Anmerkungen mit Freiformtext. Sie können sie verwenden, um beliebige Informationen anzuhängen, die mit der Ressource verknüpft sind. Weitere Informationen finden Sie unter Annotationen.
• LOG_SEVERITY: Optional. Der Mindestschweregrad des im Logeintrag beschriebenen Ereignisses. Eine der folgenden Möglichkeiten: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Der Standardwert ist NONE. Weitere Informationen finden Sie unter LogSeverity.
• destinations: Das Ziel, an das Nachrichten weitergeleitet werden. Es wird nur ein Ziel unterstützt: httpEndpoint, messageBus, topic oder workflow. Weitere Informationen finden Sie unter Destination-Ziel. Ersetzen Sie beispielsweise Folgendes:
  • HTTP_URI: Ein Ziel-URI. Der Host kann entweder eine statische IP-Adresse sein, die über ein VPC-Netzwerk (Virtual Private Cloud) adressiert werden kann, oder der interne DNS-Hostname (Domain Name System) eines Dienstes, der mit Cloud DNS aufgelöst werden kann. Optional können Sie auch messageBindingTemplate festlegen, um eine Nachrichtenbindung anzugeben.
  • networkAttachment: Gilt nur für httpEndpoint (einschließlich Cloud Run-URLs). Der vollständige Ressourcenname eines Netzwerkanhangs in diesem Format: projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION /networkAttachments/NETWORK_ATTACHMENT_NAME. Ein Netzwerkanhang ist eine Ressource, mit der ein VPC-Netzwerk (Virtual Private Cloud) eines Erstellers Verbindungen zu einem Nutzer-VPC-Netzwerk initiieren kann. Er muss angegeben werden. Eventarc Advanced verwendet zum Veröffentlichen von Ereignissen den Netzwerkanhang, um eine Verbindung zum Endpunkt herzustellen, der in einem VPC-Netzwerk gehostet wird.

    Sie können einen Netzwerkanhang erstellen, der automatisch Verbindungen von jeder Private Service Connect-Schnittstelle akzeptiert, die auf den Netzwerkanhang verweist. Erstellen Sie den Netzwerkanhang im selben Netzwerk und in derselben Region wie die Zielressource.

    Wenn Sie Nachrichten mithilfe einer DNS-Adresse an ein Google-Ziel weiterleiten, z. B. Cloud Run, muss der private Google-Zugriff in dem im Netzwerkanhang verwendeten Subnetz aktiviert sein; ansonsten kann die DNS-Adresse nicht aufgelöst werden.

  • SERVICE_ACCOUNT_EMAIL: Der Name der E-Mail-Adresse des Dienstkontos, die zum Generieren eines OIDC-Tokens verwendet wird. Dieses kann für viele Szenarien verwendet werden, einschließlich Endpunkten, an denen Sie das Token selbst validieren möchten. Optional können Sie audience festlegen, um die Zielgruppe anzugeben, für die dieses Token vorgesehen ist. In der Regel sollte sie mit der URL der Zielpipeline übereinstimmen. Falls nichts angegeben wurde, wird die gesamte URL verwendet, einschließlich aller Anfrageparameter.

    Alternativ können Sie oauthToken verwenden, um die E-Mail-Adresse des Dienstkontos anzugeben, mit der ein OAuth-Token generiert wird. Dieses sollte in der Regel nur beim Aufrufen von Google APIs verwendet werden, die auf *.googleapis.com gehostet werden. Optional können Sie scope festlegen, um den Bereich dieses Tokens anzugeben. Andernfalls wird standardmäßig https://www.googleapis.com/auth/cloud-platform verwendet. Für Google Cloud-Dienste empfiehlt es sich, den Bereich https://www.googleapis.com/auth/cloud-platform zu verwenden. Dieser enthält alle Google Cloud APIs zusammen mit Identity and Access Management (IAM), die eine detaillierte Zugriffssteuerung bietet.

    Alle Anfragen an einen anderen Eventarc Advanced-Bus, Pub/Sub oder Workflows müssen einen HTTP-Autorisierungs-Header mit einem von Google für eines der autorisierten Dienstkonten signierten OAuth-Token enthalten.

    Weitere Informationen zu Tokentypen

JSON-Text der Anfrage:

{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}

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

cat > request.json << 'EOF'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
EOF

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelines?pipeline_id=PIPELINE_NAME"

@'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
'@  | Out-File -FilePath request.json -Encoding utf8

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelines?pipeline_id=PIPELINE_NAME" | Select-Object -Expand Content

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.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Registrierung

Verwenden Sie zum Erstellen einer Registrierung die Methode projects.locations.enrollments.create.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

• ENROLLMENT_NAME: Der Anzeigename Ihrer Registrierung, z. B. my_enrollment.
• MATCH_EXPRESSION: ein CEL-Ausdruck, der angibt, auf welche Nachrichten diese Registrierung angewendet wird. Beispiel: message.type == 'hello-world-type'
• destination: Der vollständige Ressourcenname der Zielpipeline im Format projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME.

  Ersetzen Sie Folgendes:

  • PROJECT_ID: die Google CloudProjekt-ID für das Pipeline-Projekt
  • LOCATION: die Region, in der die Pipeline bereitgestellt wird, z. B. us-central1.
  • PIPELINE_NAME: der Name der Pipeline
• message_bus: Der vollständige Ressourcenname des Busses, der die Quelle der Nachrichten im Format projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME identifiziert.

  Ersetzen Sie Folgendes:

  • BUS_PROJECT_ID: die Google Cloud Projekt-ID des Busprojekts
  • BUS_LOCATION: die Region, in der der Bus bereitgestellt wird, z. B. us-central1
  • BUS_NAME: der Name des Message-Bus

JSON-Text der Anfrage:

{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}

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

cat > request.json << 'EOF'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
EOF

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/enrollments?enrollment_id=ENROLLMENT_NAME"

@'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
'@  | Out-File -FilePath request.json -Encoding utf8

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/enrollments?enrollment_id=ENROLLMENT_NAME" | Select-Object -Expand Content

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.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/enrollments/ENROLLMENT_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}