Crear un sistema Pub/Sub de uno a muchos

En este tutorial se explica cómo configurar un conjunto de aplicaciones que se comunican enviando mensajes a través de Pub/Sub en lugar de RPCs síncronas. Al desacoplar las aplicaciones, la mensajería:

• Hace que las aplicaciones sean más sólidas
• Puede simplificar el desarrollo

Por ejemplo, el llamante (editor) no necesita que el receptor (suscriptor) esté disponible. El editor envía un mensaje a Pub/Sub. El editor no necesita saber qué aplicaciones de suscriptor ni cuántas deben recibir el mensaje. Por lo tanto, se puede confiar en el servicio para enviar el mensaje a una o varias aplicaciones suscriptoras cuando estén disponibles.

Descripción general del sistema

En este tutorial, iniciará una aplicación de editor que envía el mensaje "Hello, World!" a dos suscriptores mediante la comunicación de uno a muchos, como se muestra en el siguiente diagrama:

Las dos aplicaciones de suscriptor usan el mismo código, pero las inicias en momentos diferentes. Este proceso muestra cómo Pub/Sub habilita la comunicación asíncrona. Para crear este sistema, sigue estos pasos:

1. Crea una cuenta de servicio de IAM que las aplicaciones utilicen para la autenticación.
2. Configura los permisos de gestión de identidades y accesos.
3. Crea un tema y una suscripción de Pub/Sub.
4. Inicia tres aplicaciones independientes: un editor y dos suscriptores.

Antes de empezar

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 utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.
Para inicializar gcloud CLI, ejecuta el siguiente comando:
gcloud init
Create or select a Google Cloud project.
Roles required to select or create a project
• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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 Pub/Sub API:
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
gcloud services enable pubsub.googleapis.com
Create local authentication credentials for your user account:
gcloud auth application-default login
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Grant roles to your user account. Run the following command once for each of the following IAM roles: roles/pubsub.publisher, roles/pubsub.subscriber
gcloud projects add-iam-policy-binding PROJECT_ID --member="user:USER_IDENTIFIER" --role=ROLE
Replace the following:
• PROJECT_ID: your project ID.
• USER_IDENTIFIER: the identifier for your user account—for example, [e-mail].
• ROLE: the IAM role that you grant to your user account.

Install the Google Cloud CLI.

Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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 Pub/Sub API:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable pubsub.googleapis.com

Create local authentication credentials for your user account:

gcloud auth application-default login

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Grant roles to your user account. Run the following command once for each of the following IAM roles: roles/pubsub.publisher, roles/pubsub.subscriber

gcloud projects add-iam-policy-binding PROJECT_ID --member="user:USER_IDENTIFIER" --role=ROLE

Replace the following:

• PROJECT_ID: your project ID.
• USER_IDENTIFIER: the identifier for your user account—for example, [e-mail].
• ROLE: the IAM role that you grant to your user account.

Instalar Python

En este tutorial se usan las bibliotecas de cliente de Pub/Sub, que requieren Python 3.7 o una versión posterior. Sigue las instrucciones para instalar Python.

Configurar el proyecto de Pub/Sub

Para gestionar el flujo de mensajes entre las aplicaciones de publicación y suscripción, crea un tema y dos suscripciones diferentes.

Crear un tema de Pub/Sub

Crea un tema con el ID hello_topic:

gcloud pubsub topics create hello_topic

Crear suscripciones de Pub/Sub

Crea dos suscripciones y adjúntalas a tu tema.

Estas suscripciones son de tipo StreamingPull, que es un tipo de suscripción pull.

Suscripción 1

Crea una suscripción con el ID sub_one y adjúntala a hello_topic.

gcloud pubsub subscriptions create sub_one --topic=hello_topic

Suscripción 2

Crea una suscripción con el ID sub_two y adjúntala a hello_topic.

gcloud pubsub subscriptions create sub_two --topic=hello_topic

Crear el sistema de uno a muchos

Descargar el código del editor y del suscriptor

1. Descarga los archivos de Python de Pub/Sub necesarios para este tutorial.

    git clone https://github.com/googleapis/python-pubsub.git

2. Cierra los terminales que tengas abiertos antes de continuar.

Configurar tres terminales

1. Inicia una terminal para cada aplicación del tutorial (un editor y dos suscriptores). Para mayor comodidad, en este tutorial se denominan de la siguiente manera:

   • Terminal publisher
   • Terminal sub_one
   • Terminal sub_two
   Nota: Asegúrate de que los tres terminales estén en el mismo directorio relativo a la ubicación en la que descargaste los archivos de Python de Pub/Sub en el paso anterior.

2. En la terminal publisher, crea y activa un entorno virtual de Python llamado pyenv-qs.

   Bash

   python -m venv pyenv-qs
   source pyenv-qs/bin/activate

   PowerShell

   py -m venv pyenv-qs
   .\pyenv-qs\Scripts\activate

   En los terminales sub_one y sub_two, ejecuta el siguiente comando:

   Bash

   source pyenv-qs/bin/activate

   PowerShell

   .\pyenv-qs\Scripts\activate

   Después de ejecutar el comando de activación, el símbolo del sistema incluye el siguiente valor: (pyenv-qs) $.

3. En el terminal del editor, instala la biblioteca de cliente de Python de Pub/Sub con pip:

   python -m pip install --upgrade google-cloud-pubsub

4. En los tres terminales, configura una variable de entorno con el ID de tu proyecto. Este comando de gcloud determina el ID del proyecto seleccionado y lo define como una variable:

   Bash

   export PROJECT=`gcloud config get-value project`

   PowerShell

   $env:PROJECT=$(gcloud config get-value project)

5. En los tres terminales, cambia a la ruta del proyecto que contiene el código de ejemplo.

   cd python-pubsub/samples/snippets/quickstart/

Inicia las aplicaciones y observa el flujo de mensajes

Inicia la aplicación del suscriptor 1

En la terminal sub_one, inicia Subscriber 1:

Bash

python sub.py $PROJECT sub_one

PowerShell

py sub.py $env:PROJECT sub_one

Una vez iniciada, esta aplicación abre una conexión de streaming bidireccional con el servidor. Pub/Sub envía los mensajes a través del flujo.



Iniciar la aplicación Publisher

En la terminal publisher, inicia la aplicación Publisher:

Bash

python pub.py $PROJECT hello_topic

PowerShell

py pub.py $env:PROJECT hello_topic

Una vez que se inicia la aplicación del editor, el sistema Pub/Sub hace lo siguiente:

• La aplicación Publisher envía el mensaje "Hello, World!" a Pub/Sub sin saber si hay suscripciones. El servidor también asigna un ID de mensaje.

• La aplicación Suscriptor 1 recibe el mensaje "Hello World", lo imprime y envía una confirmación a Pub/Sub.

• La aplicación Publisher imprime la confirmación. La confirmación indica a Pub/Sub que el mensaje se ha procesado correctamente y que no es necesario volver a enviarlo a este suscriptor (sub_one) ni a ningún otro.

Pub/Sub elimina el mensaje de sub_one.



Iniciar la aplicación Suscriptor 2

En la terminal sub_two, inicia Subscriber 2:

Bash

python sub.py $PROJECT sub_two

PowerShell

py sub.py $env:PROJECT sub_two

Este suscriptor recibe los mensajes enviados a la suscripción sub_two. Subscriber 2 reutiliza la secuencia de comandos sub.py. La diferencia es que Subscriber 2 no se inicia hasta que el editor ha enviado el mensaje al tema y a las suscripciones. Si Publisher llamara directamente a Subscriber 2, la aplicación de publicación tendría que esperar a que Subscriber 2 se conectara o se agotaría el tiempo de espera. Pub/Sub gestiona este proceso guardando el mensaje de forma eficaz para el suscriptor 2.



Ya puedes empezar a desarrollar con Pub/Sub.

¿Cómo ha ido?

¡Ha funcionado!
¡Genial! ¿Qué es lo que más te ha gustado de la guía de inicio rápido? ¿Qué podríamos haber hecho mejor? ¡Cuéntanoslo!
No he sabido seguir.
Sentimos que sea por eso. Cuéntanos qué problema has tenido. Queremos solucionarlo.

Puedes consultar más recursos y enlaces en la página de asistencia de Pub/Sub.

Limpieza

1. Detén todas las aplicaciones en ejecución.
2. Elimina el directorio de código de ejemplo de tu entorno local.

3. Elimina el tema.

   gcloud pubsub topics delete hello_topic

4. Elimina las suscripciones.

   gcloud pubsub subscriptions delete sub_one

   gcloud pubsub subscriptions delete sub_two

5. Cierra el proyecto del tutorial en la sección IAM y administración de la Google Cloud consola.

6. Optional: Revoke the authentication credentials that you created, and delete the local credential file.

   gcloud auth application-default revoke

7. Optional: Revoke credentials from the gcloud CLI.

   gcloud auth revoke

Siguientes pasos

Aquí tienes algunas cosas que puedes probar:

• Consulta el código de pub.py y sub.py del tutorial, y echa un vistazo a otros ejemplos de Pub/Sub en GitHub. Como ejercicio, crea una versión de pub.py que publique la hora local cada segundo.

• Consulta cómo enviar mensajes en lote.

• Con las suscripciones Push, recibe mensajes que activan endpoints de App Engine o Cloud Functions.

• Recupera los mensajes que ya has confirmado con replay. De forma predeterminada, Pub/Sub elimina los mensajes confirmados de las suscripciones. Por ejemplo, en este tutorial no podrás volver a ejecutar sub.py para recibir el mensaje "Hello, World!". La función de repetición te permite configurar suscripciones para recibir mensajes después de que se hayan confirmado.

• Consulta cómo empezar a usar las bibliotecas de cliente en otros lenguajes.