Pubblica e ricevi eventi creando un bus e una registrazione (gcloud CLI)

Questa guida rapida mostra come pubblicare e ricevere messaggi di eventi creando un bus Eventarc Advanced e una registrazione nel tuo progetto Google Cloud.

  • Un bus ti consente di centralizzare il flusso di messaggi nel sistema e funge da router. Riceve messaggi di eventi da un'origine messaggi o pubblicati da un provider e li valuta in base a una registrazione.

  • Una registrazione identifica un abbonamento a un particolare bus e definisce i criteri di corrispondenza per i messaggi, in modo che vengano instradati di conseguenza a una o più destinazioni.

In questa guida rapida:

  1. Crea un repository Artifact Registry standard.

  2. Eseguire il deployment di un servizio di ricezione di eventi in Cloud Run.

  3. Crea un bus Eventarc Advanced.

  4. Crea una registrazione Eventarc Advanced.

  5. Pubblica un messaggio di evento nel bus.

  6. Visualizza i dati sugli eventi nei log di Cloud Run.

Puoi completare questa guida rapida utilizzando gcloud CLI. Per completare i passaggi utilizzando la console Google Cloud , consulta Pubblica e ricevi eventi creando un bus e una registrazione (console).

Prima di iniziare

I vincoli di sicurezza definiti dalla tua organizzazione potrebbero impedirti di completare i passaggi seguenti. Per informazioni sulla risoluzione dei problemi, vedi Sviluppare applicazioni in un ambiente Google Cloud vincolato.

  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. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere alla gcloud CLI con la tua identità federata.

  4. Per inizializzare gcloud CLI, esegui questo comando: 

    gcloud init

  5. 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.

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs: 

    gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.googleapis.com

  8. Install the Google Cloud CLI.

  9. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere alla gcloud CLI con la tua identità federata.

  10. Per inizializzare gcloud CLI, esegui questo comando: 

    gcloud init

  11. 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.

  12. Verify that billing is enabled for your Google Cloud project.

  13. Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs: 

    gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.googleapis.com

  14. Aggiorna i componenti di gcloud: 
    gcloud components update

  15. Accedi utilizzando il tuo account: 
    gcloud auth login

  16. Imposta la variabile di configurazione utilizzata in questa guida rapida: 
    REGION=REGION

    Sostituisci REGION con una località supportata per l'autobus.

  17. Se hai creato il progetto, ti viene assegnato il ruolo di base Proprietario (roles/owner). Per impostazione predefinita, questo ruolo IAM include le autorizzazioni necessarie per l'accesso completo alla maggior parte delle risorse Google Cloud e puoi saltare questo passaggio.

    Se non sei il creatore del progetto, le autorizzazioni richieste devono essere concesse al principal appropriato. Ad esempio, un'entità può essere un Account Google (per gli utenti finali) o un account di servizio (per applicazioni e carichi di lavoro di calcolo).

    Tieni presente che per impostazione predefinita, le autorizzazioni di Cloud Build includono le autorizzazioni per caricare e scaricare gli artefatti di Artifact Registry.

    Autorizzazioni obbligatorie

    Per ottenere le autorizzazioni necessarie per completare questa guida rapida, chiedi all'amministratore di concederti i seguenti ruoli IAM nel tuo progetto:

    Per ulteriori informazioni sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

    Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

  18. Concedi i seguenti ruoli sul progetto all'account di servizio predefinito di Compute Engine. Questi ruoli sono necessari per creare ed eseguire il deployment dell'immagine container: 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/artifactregistry.writer
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/logging.logWriter
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/storage.objectUser

    Sostituisci PROJECT_NUMBER con il numero del tuo progetto Google Cloud. Puoi trovare il numero di progetto nella pagina Benvenuto della console Google Cloud o eseguendo questo comando:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'

  19. Per impostazione predefinita, solo i proprietari del progetto, gli editor del progetto e gli amministratori e gli invoker di Cloud Run possono chiamare i servizi Cloud Run. Per configurare l'autenticazione, concedi il ruolo Invoker di Cloud Run (run.invoker) nel tuo progetto Google Cloud a un account di servizio:
    1. Crea un account di servizio. A scopo di test, collegherai questo service account a una pipeline Eventarc Advanced per rappresentare l'identità della pipeline. 
      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
       Sostituisci SERVICE_ACCOUNT_NAME con un nome per il tuo account di servizio.
    2. Concedi il ruolo IAM roles/run.invoker all'account di servizioo: 
      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
    --role=roles/run.invoker

    Tieni presente che puoi configurare chi può accedere al tuo servizio Cloud Run in uno dei seguenti modi:

    • Concedi l'autorizzazione per selezionare service account o gruppi per consentire l'accesso al servizio. Tutte le richieste devono avere un'intestazione di autorizzazione HTTP contenente un token OpenID Connect firmato da Google per uno degli account di servizio autorizzati. Questo è il modo in cui viene configurato l'accesso in questa guida rapida.
    • Concedi l'autorizzazione a allUsers per consentire l'accesso non autenticato.

    Per saperne di più, consulta Controllo dell'accesso per Cloud Run.

    20. Crea un repository standard Artifact Registry

    Crea un repository standard di Artifact Registry per archiviare l'immagine container.

    gcloud artifacts repositories create REPOSITORY \
    --repository-format=docker \
    --location=$REGION

    Sostituisci REPOSITORY con un nome univoco per il repository Artifact Registry, ad esempio my-repo.

    Esegui il deployment di un servizio di ricezione di eventi in Cloud Run

    Esegui il deployment di un servizio Cloud Run che registra i contenuti di un evento. Sono supportate altre destinazioni di eventi, ad esempio un argomento Pub/Sub, Workflows o un endpoint HTTP. Per ulteriori informazioni, vedi Fornitori e destinazioni di eventi.

    1. Clona il repository GitHub:

      git clone https://github.com/GoogleCloudPlatform/eventarc-samples.git

    2. Passa alla directory che contiene il codice campione di Cloud Run:

      cd eventarc-samples/eventarc-advanced-quickstart/

    3. Crea un'immagine container Docker ed eseguine il push nel repository:

      gcloud builds submit \
    --tag $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1

    4. Esegui il deployment dell'immagine container su Cloud Run:

      gcloud run deploy SERVICE_NAME \
    --image $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1 \
    --platform managed \
    --ingress all \
    --no-allow-unauthenticated \
    --region=$REGION

      Sostituisci SERVICE_NAME con il nome del tuo servizio, ad esempio my-service.

      L'impostazione di ingresso di all consente tutte le richieste, incluse quelle direttamente da internet all'URL run.app. Per maggiori informazioni, consulta la pagina Limitare l'accesso alla rete per Cloud Run.

      Il flag --no-allow-unauthenticated configura il servizio in modo che consenta solo chiamate autenticate.

    Quando viene visualizzato l'URL del servizio Cloud Run, il deployment è completato. Prendi nota di questo URL in modo da poterlo utilizzare in un passaggio successivo.

    Crea un bus Eventarc Advanced

    Un bus riceve messaggi di eventi da un'origine di messaggi o pubblicati da un provider e funge da router di messaggi.

    Per saperne di più, consulta Creare un bus per instradare i messaggi.

    Crea un bus Eventarc Advanced nel tuo progetto utilizzando il comando gcloud eventarc message-buses create:

    gcloud eventarc message-buses create BUS_NAME \
    --location=$REGION

    Sostituisci BUS_NAME con l'ID o l'identificatore completo del bus, ad esempio my-bus.

    Crea una registrazione Eventarc Advanced

    Una registrazione determina quali messaggi vengono instradati a una destinazione e specifica anche la pipeline utilizzata per configurare una destinazione per i messaggi di evento.

    Per saperne di più, vedi Creare una registrazione per ricevere eventi.

    Quando utilizzi gcloud CLI, prima crei una pipeline e poi crei una registrazione:

    1. Crea una pipeline utilizzando il comando gcloud eventarc pipelines create:

      gcloud eventarc pipelines create PIPELINE_NAME \
    --destinations=http_endpoint_uri='CLOUD_RUN_SERVICE_URL',google_oidc_authentication_service_account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
    --location=$REGION

      Sostituisci quanto segue:

      • PIPELINE_NAME: l'ID della pipeline o un nome completo.
      • CLOUD_RUN_SERVICE_URL: l'URL completo del tuo servizio Cloud Run, ad esempio https://SERVICE_NAME-abcdef-uc.a.run.app. Questa è la destinazione dei messaggi dell'evento.

      Tieni presente che la chiave google_oidc_authentication_service_account specifica un indirizzo email del account di servizio utilizzato per generare un token OIDC.

    2. Crea una registrazione utilizzando il comando gcloud eventarc enrollments create:

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

      Sostituisci quanto segue:

      • ENROLLMENT_NAME: l'ID della registrazione o un nome completo.

      • MATCH_EXPRESSION: l'espressione di corrispondenza per questa registrazione utilizzando CEL, ad esempio:

        "message.type == 'hello-world-type'"

    Pubblica un messaggio di evento nel bus

    Per pubblicare direttamente un messaggio nel bus, puoi utilizzare il comando gcloud eventarc message-buses publish o inviare una richiesta all'API REST Eventarc Publishing. Per ulteriori informazioni, vedi Pubblicare eventi direttamente.

    Il messaggio deve essere in formato CloudEvents, una specifica per descrivere i dati degli eventi in modo comune. L'elemento data è il payload del tuo evento. In questo campo può essere inserito qualsiasi JSON ben formato. Per saperne di più sugli attributi di contesto di CloudEvents, consulta Formato dell'evento.

    Di seguito sono riportati esempi di pubblicazione diretta di un evento in un bus Eventarc Advanced:

    Esempio 1

    Puoi pubblicare un evento in un bus utilizzando gcloud CLI e un --event-data e altri flag di attributo evento:

    gcloud eventarc message-buses publish BUS_NAME \
    --event-data='{"key": "hello-world-data"}' \
    --event-id=hello-world-id-1234 \
    --event-source=hello-world-source \
    --event-type=hello-world-type \
    --event-attributes="datacontenttype=application/json" \
    --location=$REGION

    Esempio 2

    Puoi pubblicare un evento in un bus come messaggio JSON utilizzando gcloud CLI e un flag --json-message:

    gcloud eventarc message-buses publish BUS_NAME \
    --location=$REGION \
    --json-message='{"id": "hello-world-id-1234", "type":
 "hello-world-type", "source":
 "hello-world-source", "specversion": "1.0", "data":
 {"key": "hello-world-data"}}'

    Dopo aver pubblicato un evento, dovresti ricevere un messaggio "Evento pubblicato correttamente".

    Visualizzare i dati sugli eventi nei log di Cloud Run

    Dopo aver pubblicato un evento nel bus Eventarc Advanced, puoi controllare i log del servizio Cloud Run per verificare che l'evento sia stato ricevuto come previsto.

    1. Filtra le voci di log e restituisci l'output utilizzando il comando gcloud logging read:

      gcloud logging read 'textPayload: "hello-world-data"'

    2. Cerca una voce di log simile alla seguente:

      insertId: 670808e70002b5c6477709ae
labels:
instanceId: 007989f2a10a4a33c21024f2c8e06a9de65d9b4fdc2ee27697a50379b3fab2f975b9233dc357d50b06270829b9b479d5a1ee54a10fa2cb2d98c5f77a0895e2be0f9e6e4b20
logName: projects/PROJECT_ID/logs/run.googleapis.com%2Fstderr
receiveTimestamp: '2024-10-10T17:03:35.424659450Z'
resource:
labels:
...
type: cloud_run_revision
textPayload: "[2024-10-21 15:33:19,581] INFO in server: Body: b'{\"value\":\"hello-world-data\"\
  }'"
timestamp: '2024-10-10T17:03:35.177606Z'

    Hai creato correttamente un bus e una registrazione Eventarc Advanced, pubblicato un messaggio di evento nel bus e verificato il risultato previsto nei log del servizio di ricezione eventi.

    Esegui la pulizia

    Al termine delle attività descritte in questa guida rapida, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato:

    1. Elimina un repository Artifact Registry.

    2. Elimina un servizio Cloud Run.

    3. Elimina le risorse Eventarc Advanced:

      1. Eliminare una registrazione.

      2. Eliminare una pipeline.

      3. Elimina un bus.

    In alternativa, puoi eliminare il tuo progetto Google Cloud per evitare addebiti. L'eliminazione del progetto Google Cloud interrompe la fatturazione di tutte le risorse utilizzate al suo interno.

    Delete a Google Cloud project:

    gcloud projects delete PROJECT_ID

    Passaggi successivi