Publier et recevoir des événements en créant un bus et un enregistrement (gcloud CLI)

Avant de commencer

Les contraintes de sécurité définies par votre organisation peuvent vous empêcher d'effectuer les étapes suivantes. Pour en savoir plus sur la résolution des problèmes, consultez Développer des applications dans un environnement Google Cloud limité.

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.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à gcloud CLI avec votre identité fédérée.

Pour initialiser gcloudCLI, exécutez la commande suivante :

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.

Verify that billing is enabled for your Google Cloud project.

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

Install the Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à gcloud CLI avec votre identité fédérée.

Pour initialiser gcloudCLI, exécutez la commande suivante :

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.

Verify that billing is enabled for your Google Cloud project.

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

1. Mettez à jour les composants gcloud :

   gcloud components update

2. Connectez-vous à votre compte :

   gcloud auth login

3. Définissez la variable de configuration utilisée dans ce guide de démarrage rapide :

    REGION=REGION

   Remplacez REGION par un emplacement compatible pour le bus.

4. Si vous êtes le créateur du projet, vous disposez du rôle de base Propriétaire (roles/owner). Par défaut, ce rôle Identity and Access Management (IAM) inclut les autorisations nécessaires pour accéder à la plupart des ressources Google Cloud. Vous pouvez ignorer cette étape.

   Si vous n'êtes pas le créateur du projet, les autorisations requises doivent être accordées au compte principal approprié sur le projet. Par exemple, un compte principal peut être un compte Google (pour les utilisateurs finaux) ou un compte de service (pour les applications et les charges de travail de calcul).

   Notez que par défaut, les autorisations Cloud Build incluent des autorisations permettant d'importer et de télécharger des artefacts Artifact Registry.

   Autorisations requises

   Pour obtenir les autorisations nécessaires pour suivre ce guide de démarrage rapide, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

   • Éditeur Cloud Build (roles/cloudbuild.builds.editor)
   • Administrateur Cloud Run (roles/run.admin)
   • Développeur Eventarc (roles/eventarc.developer)
   • Administrateur de bus à messages Eventarc (roles/eventarc.messageBusAdmin)
   • Accesseur de vues de journaux (roles/logging.viewAccessor)
   • Administrateur de projet IAM (roles/resourcemanager.projectIamAdmin)
   • Administrateur de compte de service (roles/iam.serviceAccountAdmin)
   • Utilisateur du compte de service (roles/iam.serviceAccountUser)
   • Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin)

   Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

   Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

5. Attribuez les rôles suivants au compte de service Compute Engine par défaut du projet. Ces rôles sont nécessaires pour créer et déployer votre image de conteneur :
   • Rédacteur Artifact Registry : pour importer des artefacts Artifact Registry
   • Rédacteur de journaux : permet d'écrire des journaux dans Cloud Logging
   • Utilisateur de l'objet Storage : pour accéder aux objets Cloud Storage

   gcloud projects add-iam-policy-binding PROJECT_ID \     --member=serviceAccount:PROJECT_NUMBER[email protected] \     --role=roles/artifactregistry.writer gcloud projects add-iam-policy-binding PROJECT_ID \     --member=serviceAccount:PROJECT_NUMBER[email protected] \     --role=roles/logging.logWriter gcloud projects add-iam-policy-binding PROJECT_ID \     --member=serviceAccount:PROJECT_NUMBER[email protected] \     --role=roles/storage.objectUser

   Remplacez PROJECT_NUMBER par le numéro de votre projet Google Cloud. Vous pouvez trouver le numéro de votre projet sur la page Bienvenue de la console Google Cloud ou en exécutant la commande suivante :

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

6. Par défaut, seuls les propriétaires et les éditeurs de projets, ainsi que les administrateurs et les demandeurs Cloud Run peuvent appeler les services Cloud Run. Pour configurer l'authentification, attribuez le rôle Demandeur Cloud Run (run.invoker) sur votre projet Google Cloud à un compte de service :
   1. Créez un compte de service. À des fins de test, vous allez associer ce compte de service à un pipeline Eventarc Advanced pour représenter l'identité du pipeline.

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Remplacez SERVICE_ACCOUNT_NAME par le nom que vous souhaitez donner à votre compte de service.
   2. Attribuez le rôle IAM roles/run.invoker au compte de service :

      gcloud projects add-iam-policy-binding PROJECT_ID \     --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \     --role=roles/run.invoker

   Notez que vous pouvez configurer les utilisateurs autorisés à accéder à votre service Cloud Run de deux manières :

   • Accordez l'autorisation de sélectionner des comptes de service ou des groupes pour autoriser l'accès au service. Toutes les requêtes doivent comporter un en-tête d'autorisation HTTP contenant un jeton OpenID Connect signé par Google pour l'un des comptes de service autorisés. C'est ainsi que l'accès est configuré dans ce guide de démarrage rapide.
   • Accordez l'autorisation à allUsers pour autoriser l'accès non authentifié.

   Pour en savoir plus, consultez Contrôle des accès pour Cloud Run.

Créer un dépôt standard Artifact Registry

Créez un dépôt standard Artifact Registry pour stocker votre image de conteneur.

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

Remplacez REPOSITORY par un nom unique pour le dépôt Artifact Registry (par exemple, my-repo).

Déployer un service récepteur d'événements sur Cloud Run

Déployez un service Cloud Run qui consigne le contenu d'un événement. D'autres destinations d'événements sont acceptées, comme un sujet Pub/Sub, Workflows ou un point de terminaison HTTP. Pour en savoir plus, consultez Fournisseurs et destinations d'événements.

1. Clonez le dépôt GitHub.

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

2. Accédez au répertoire contenant l'exemple de code Cloud Run :

   cd eventarc-samples/eventarc-advanced-quickstart/

3. Créez une image de conteneur Docker et transférez-la vers votre dépôt :

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

4. Déployez l'image de conteneur dans 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

   Remplacez SERVICE_NAME par le nom de votre service, par exemple my-service.

   Le paramètre d'entrée all autorise toutes les requêtes, y compris celles provenant directement d'Internet vers l'URL run.app. Pour en savoir plus, consultez Restreindre l'entrée réseau pour Cloud Run.

   L'indicateur --no-allow-unauthenticated configure le service pour qu'il n'autorise que les appels authentifiés.

Lorsque l'URL du service Cloud Run s'affiche, le déploiement est terminé. Notez cette URL pour pouvoir l'utiliser lors d'une étape ultérieure.

Créer un bus Eventarc Advanced

Un bus reçoit les messages d'événement d'une source de messages ou publiés par un fournisseur, et sert de routeur de messages.

Pour en savoir plus, consultez Créer un bus pour acheminer les messages.

Créez un bus Eventarc Advanced dans votre projet à l'aide de la commande gcloud eventarc message-buses create :

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

Remplacez BUS_NAME par l'ID ou l'identifiant complet de votre bus (par exemple, my-bus).

Créer une inscription Eventarc Advanced

Un enregistrement détermine les messages à acheminer vers une destination et spécifie également le pipeline utilisé pour configurer une destination pour les messages d'événement.

Pour en savoir plus, consultez Créer un enregistrement pour recevoir des événements.

Lorsque vous utilisez la gcloud CLI, vous créez d'abord un pipeline, puis un enregistrement :

1. Créez un pipeline à l'aide de la commande 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

   Remplacez les éléments suivants :

   • PIPELINE_NAME : l'ID du pipeline ou un nom complet.
   • CLOUD_RUN_SERVICE_URL : URL complète de votre service Cloud Run (par exemple, https://SERVICE_NAME-abcdef-uc.a.run.app). Il s'agit de la destination de vos messages d'événement.

   Notez que la clé google_oidc_authentication_service_account spécifie une adresse e-mail de compte de service utilisée pour générer un jeton OIDC.

2. Créez un enregistrement à l'aide de la commande 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

   Remplacez les éléments suivants :

   • ENROLLMENT_NAME : l'ID de l'inscription ou un nom complet.

   • MATCH_EXPRESSION : expression de correspondance pour cet enregistrement à l'aide de CEL, par exemple :

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

Publier un message d'événement sur le bus

Pour publier directement un message dans votre bus, vous pouvez utiliser la commande gcloud eventarc message-buses publish ou envoyer une requête à l'API REST Eventarc Publishing. Pour en savoir plus, consultez Publier des événements directement.

Le message doit être au format CloudEvents, qui est une spécification permettant de décrire les données d'événement de manière courante. L'élément data correspond à la charge utile de votre événement. Tout fichier JSON bien formé peut être inséré dans ce champ. Pour en savoir plus sur les attributs de contexte CloudEvents, consultez Format d'événement.

Voici des exemples de publication directe d'un événement sur un bus Eventarc Advanced :

Exemple 1

Vous pouvez publier un événement dans un bus à l'aide de la gcloud CLI et d'un --event-data ainsi que d'autres indicateurs d'attributs d'événement :

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 

Exemple 2

Vous pouvez publier un événement dans un bus sous forme de message JSON à l'aide de gcloud CLI et d'un indicateur --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"}}' 

Une fois l'événement publié, vous devriez recevoir le message "Événement publié".

Afficher les données d'événement dans les journaux Cloud Run

Après avoir publié un événement sur votre bus Eventarc Advanced, vous pouvez consulter les journaux de votre service Cloud Run pour vérifier que l'événement a été reçu comme prévu.

1. Filtrez les entrées de journal et renvoyez la sortie à l'aide de la commande gcloud logging read :

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

2. Recherchez une entrée de journal semblable à ceci :

    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' 

Vous avez créé un bus et un enregistrement Eventarc Advanced, publié un message d'événement dans le bus et vérifié le résultat attendu dans les journaux du service récepteur d'événements.

Effectuer un nettoyage

Une fois que vous avez terminé les tâches décrites dans ce guide de démarrage rapide, vous pouvez éviter de continuer à payer des frais en supprimant les ressources que vous avez créées :

1. Supprimez un dépôt Artifact Registry.

2. Supprimez un service Cloud Run.

3. Supprimez les ressources Eventarc Advanced :

   1. Supprimer un enregistrement

   2. Supprimez un pipeline.

   3. Supprimer un bus

Vous pouvez également supprimer votre projet Google Cloud pour éviter des frais. La suppression de votre projet Google Cloud arrête la facturation de toutes les ressources utilisées dans ce projet.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Étapes suivantes

• Publier des événements provenant de sources Google
• Publier des événements directement
• Transformer les événements reçus
• Mettre en forme les événements reçus