Google utiliza tecnología de IA para traducir contenido a tu idioma preferido. Las traducciones realizadas con IA pueden contener errores.

Rumpus arcoíris de microservicios

1. Introducción

Última actualización: 2021-05-06

Microservice Rainbow Rumpus

¿Alguna vez participaste en una pelea de bolas de nieve en la que te movías y les arrojabas bolas de nieve a otras personas de forma juguetona? Si no lo has hecho, ¡pruébalo algún día! Pero ahora, en lugar de arriesgarte a recibir un golpe físico, puedes crear un pequeño servicio accesible a la red (un microservicio) que participará en una batalla épica contra otros microservicios, lanzando arcoíris en lugar de bolas de nieve.

Tal vez te preguntes… Pero, ¿cómo un microservicio "lanza" un arcoíris a otros microservicios? Un microservicio puede recibir solicitudes de red (por lo general, a través de HTTP) y devolver respuestas. Hay un "administrador de la arena" que le enviará a tu microservicio el estado actual de la arena, y luego tu microservicio responderá con un comando que especifique qué hacer.

Por supuesto, el objetivo es ganar, pero, en el camino, aprenderás a compilar e implementar microservicios en Google Cloud.

Cómo funciona

Compilarás un microservicio con la tecnología que desees (o elegirás entre los iniciadores de Go, Java, Kotlin, Scala, NodeJS o Python) y, luego, implementarás el microservicio en Google Cloud. Una vez que se implemente, nos informarás la URL de tu microservicio y, luego, lo agregaremos a la arena.

La arena contiene a todos los jugadores de una batalla determinada. El evento Rainbow Rumpus tendrá sus propios estadios. Cada jugador representa un microservicio que se mueve y lanza arcoíris a los demás jugadores.

Aproximadamente una vez por segundo, nuestro administrador de la arena llamará a tu microservicio y le enviará el estado actual de la arena (dónde están los jugadores), y tu microservicio responderá con un comando sobre qué hacer. En la arena, puedes avanzar, girar a la izquierda o a la derecha, o lanzar un arcoíris. El arcoíris se desplazará hasta tres espacios en la dirección hacia la que mira el jugador. Si el arcoíris "golpea" a otro jugador, el lanzador obtiene un punto y el jugador golpeado pierde un punto. El tamaño de la arena se ajusta automáticamente según la cantidad actual de jugadores.

Así se ve una arena anterior:

Ejemplo de la arena de batalla uno

Conflictos rotativos

En la arena, es posible que varios jugadores intenten realizar acciones contradictorias. Por ejemplo, dos jugadores podrían intentar moverse al mismo espacio. En caso de conflicto, gana el microservicio con el tiempo de respuesta más rápido.

Cómo mirar la batalla

Para ver cómo le va a tu microservicio en la batalla, consulta el estadio en vivo.

API de Battle

Para trabajar con nuestro administrador de la arena, tu microservicio deberá implementar una API específica para participar en la arena. El administrador de la arena enviará el estado actual de la arena en una solicitud HTTP POST a la URL que nos proporciones, con la siguiente estructura JSON:

{
  "_links": {
    "self": {
      "href": "https://YOUR_SERVICE_URL"
    }
  },
  "arena": {
    "dims": [4,3], // width, height
    "state": {
      "https://A_PLAYERS_URL": {
        "x": 0, // zero-based x position, where 0 = left
        "y": 0, // zero-based y position, where 0 = top
        "direction": "N", // N = North, W = West, S = South, E = East
        "wasHit": false,
        "score": 0
      }
      ... // also you and the other players
    }
  }
}

Tu respuesta HTTP debe tener el código de estado 200 (OK) con un cuerpo de respuesta que contenga tu próximo movimiento, codificado como un solo carácter en mayúscula de una de las siguientes opciones:

F <- move Forward
R <- turn Right
L <- turn Left
T <- Throw

¡Esto es todo lo que hay sobre este tema! Analicemos la implementación de un microservicio en Cloud Run, un servicio de Google Cloud para ejecutar microservicios y otras aplicaciones.

2. Accede a Google Cloud

Para poder implementar tu microservicio en Cloud Run, deberás acceder a Google Cloud. Aplicaremos un crédito a tu cuenta y no necesitarás ingresar una tarjeta de crédito. Por lo general, es menos problemático usar una cuenta personal (p.ej., gmail.com) en lugar de una cuenta de G Suite, ya que, a veces, los administradores de G Suite impiden que sus usuarios usen ciertas funciones de Google Cloud. Además, la consola web que usaremos debería funcionar bien con Chrome o Firefox, pero podría tener problemas en Safari.

3. Implementa tu microservicio

Puedes compilar tu microservicio con cualquier tecnología y, luego, implementarlo en cualquier lugar, siempre y cuando sea accesible de forma pública y cumpla con los requisitos de la API de Battle. Sin embargo, para que todo sea más fácil, te ayudaremos a comenzar con un servicio de muestra y a implementarlo en Cloud Run.

Elige la muestra con la que quieres comenzar

Hay numerosos ejemplos de microservicios de batalla con los que puedes comenzar:

Kotlin y Spring Boot	Origen
Kotlin y Micronaut	Origen
Kotlin y Quarkus	Origen
Java y Spring Boot	Origen
Java y Quarkus	Origen
Go	Origen
Node.js y Express	Origen
Python y Flask	Origen

Después de decidir con qué muestra comenzar, haz clic en el botón "Implementar en Cloud Run" que aparece arriba. Se iniciará Cloud Shell (una consola basada en la Web para una máquina virtual en la nube) en la que se clonará el código fuente y, luego, se compilará en un paquete implementable (una imagen de contenedor de Docker), que se subirá a Google Container Registry y, luego, se implementará en Cloud Run.

Cuando se te solicite, especifica la región us-central1.

La siguiente captura de pantalla muestra el resultado de Cloud Shell para la compilación y la implementación de microservicios

Verifica que el microservicio funcione

En Cloud Shell, puedes realizar una solicitud a tu microservicio recién implementado. Para ello, reemplaza YOUR_SERVICE_URL por la URL de tu servicio (que se encuentra en Cloud Shell después de la línea "Your application is now live here"):

curl -d '{
  "_links": {
    "self": {
      "href": "https://foo.com"
    }
  },
  "arena": {
    "dims": [4,3],
    "state": {
      "https://foo.com": {
        "x": 0,
        "y": 0,
        "direction": "N",
        "wasHit": false,
        "score": 0
      }
    }
  }
}' -H "Content-Type: application/json" -X POST -w "\n" \
  https://YOUR_SERVICE_URL

Deberías ver la cadena de respuesta de F, L, R o T.

4. Solicita la inclusión en el estadio

Para unirte al Rainbow Rumpus, deberás unirte a un estadio. Abre rainbowrumpus.dev y haz clic en unirse a un estadio en el que proporcionarás la URL de tu microservicio.

5. Realiza e implementa cambios

Antes de realizar cambios, debes configurar cierta información en Cloud Shell sobre el proyecto de GCP y la muestra que usaste. Primero, enumera tus proyectos de GCP:

gcloud projects list

Es probable que solo tengas un proyecto. Copia el PROJECT_ID de la primera columna y pégalo en el siguiente comando (reemplaza YOUR_PROJECT_ID por tu ID del proyecto real) para establecer una variable de entorno que usaremos en comandos posteriores:

export PROJECT_ID=YOUR_PROJECT_ID

Ahora, configura otra variable de entorno para la muestra que usaste, de modo que, en comandos posteriores, podamos especificar el directorio y el nombre del servicio correctos:

# Copy and paste ONLY ONE of these
export SAMPLE=kotlin-micronaut
export SAMPLE=kotlin-quarkus
export SAMPLE=kotlin-springboot
export SAMPLE=java-quarkus
export SAMPLE=java-springboot
export SAMPLE=go
export SAMPLE=nodejs
export SAMPLE=python

Ahora puedes editar el código fuente de tu microservicio desde Cloud Shell. Para abrir el editor basado en la Web de Cloud Shell, ejecuta este comando:

cloudshell edit cloudbowl-microservice-game/samples/$SAMPLE/README.md

Luego, verás más instrucciones para realizar cambios.

Cloud Shell con el editor y el proyecto de muestra abierto

Después de guardar los cambios, inicia la aplicación en Cloud Shell con el comando del archivo README.md, pero primero asegúrate de estar en el directorio de muestra correcto en Cloud Shell:

cd cloudbowl-microservice-game/samples/$SAMPLE

Una vez que la aplicación esté en ejecución, abre una nueva pestaña de Cloud Shell y prueba el servicio con curl:

curl -d '{
  "_links": {
    "self": {
      "href": "https://foo.com"
    }
  },
  "arena": {
    "dims": [4,3],
    "state": {
      "https://foo.com": {
        "x": 0,
        "y": 0,
        "direction": "N",
        "wasHit": false,
        "score": 0
      }
    }
  }
}' -H "Content-Type: application/json" -X POST -w "\n" \
  http://localhost:8080

Cuando esté todo listo para implementar los cambios, compila el proyecto en Cloud Shell con el comando pack. Este comando usa paquetes de compilación para detectar el tipo de proyecto, compilarlo y crear el artefacto implementable (una imagen de contenedor de Docker).

# Make sure you are in a Cloud Shell tab where you set the PROJECT_ID
# and SAMPLE env vars. Otherwise, set them again.
pack build gcr.io/$PROJECT_ID/$SAMPLE \
  --path ~/cloudbowl-microservice-game/samples/$SAMPLE \
  --builder gcr.io/buildpacks/builder

Ahora que se creó la imagen de contenedor, usa el comando docker (en Cloud Shell) para enviar la imagen de contenedor a Google Container Registry, de modo que Cloud Run pueda acceder a ella:

docker push gcr.io/$PROJECT_ID/$SAMPLE

Ahora implementa la versión nueva en Cloud Run:

gcloud run deploy $SAMPLE \
          --project=$PROJECT_ID \
          --platform=managed \
          --region=us-central1 \
          --image=gcr.io/$PROJECT_ID/$SAMPLE \
          --allow-unauthenticated

Ahora, el estadio usará tu nueva versión.

6. Desarrollo local (opcional)

Para trabajar en tu proyecto de forma local con tu propio IDE, sigue estos pasos:

[En Cloud Shell] Comprime la muestra:

# Make sure the SAMPLE env var is still set. If not, re-set it.
cd ~/cloudbowl-microservice-game/samples
zip -r cloudbowl-sample.zip $SAMPLE

[En Cloud Shell] Descarga el archivo ZIP en tu máquina:

cloudshell download-file cloudbowl-sample.zip

[En tu máquina] Descomprime el archivo y, luego, realiza y prueba los cambios
[En tu máquina] Instala gcloud CLI
[En tu máquina] Accede a Google Cloud:

gcloud auth login

[En tu máquina] Establece las variables de entorno PROJECT_ID y SAMPLE con los mismos valores que en Cloud Shell.
[En tu máquina] Usa Cloud Build para compilar el contenedor (desde el directorio raíz del proyecto):

gcloud alpha builds submit . \
  --pack=image=gcr.io/$PROJECT_ID/$SAMPLE \
  --project=$PROJECT_ID

[En tu máquina] Implementa el nuevo contenedor:

gcloud run deploy $SAMPLE \
  --project=$PROJECT_ID \
  --platform=managed \
  --region=us-central1 \
  --image=gcr.io/$PROJECT_ID/$SAMPLE \
  --allow-unauthenticated

7. Entrega continua

Configura el SCM

Configura GitHub para que puedas colaborar con tu equipo en tu microservicio:

Accede a GitHub
Crea un repo nuevo
Si trabajas en tu máquina local, puedes usar la interfaz de línea de comandos (CLI) de git o la aplicación de GUI de GitHub Desktop (Windows o Mac). Si usas Cloud Shell, deberás usar la CLI de Git. Para obtener el código de tu microservicio en GitHub, sigue las instrucciones de la CLI o de GitHub Desktop.

Envía tu código con la CLI de Git

Sigue las instrucciones para usar git a través de HTTPS con un token de acceso personal.
Elige el alcance "repo".
Configura Git:

git config --global credential.helper \
  'cache --timeout=172800'
git config --global push.default current
git config --global user.email "YOUR@EMAIL"
git config --global user.name "YOUR NAME"

Configura las variables de entorno para la organización y el repositorio de GitHub (https://github.com/ORG/REPO).

export GITHUB_ORG=YOUR_GITHUB_ORG
export GITHUB_REPO=YOUR_GITHUB_REPO

Envía tu código al nuevo repo

# Make sure the SAMPLE env var is still set. If not, re-set it.
cd ~/cloudbowl-microservice-game/samples/$SAMPLE
git init
git add .
git commit -m init
git remote add origin https://github.com/$GITHUB_ORG/$GITHUB_REPO.git
git branch -M main

# This will now ask for your GitHub username & password
# for the password use the personal access token
git push -u origin main

Después de realizar los cambios, puedes confirmarlos y enviarlos a GitHub:

git add .
git status
git diff --staged
git commit -am "my changes"
git push

Envía tu código con GitHub Desktop

Descarga tu código siguiendo las instrucciones del lab anterior "Desarrolla de forma local".
Instala GitHub Desktop, ejecútalo y accede.
Clona el repositorio que acabas de crear

Abre el explorador de archivos y copia tu proyecto en el nuevo repositorio.
Confirma tus cambios

Publica tu rama principal en GitHub

Configura la implementación continua de Cloud Run

Con tu configuración de SCM en GitHub, ahora puedes configurar la entrega continua para que, cada vez que se envíen confirmaciones nuevas a la rama main, Cloud Build compile e implemente los cambios de forma automática. También puedes agregar la integración continua, que ejecuta tus pruebas antes de la implementación, pero ese paso se dejó como ejercicio para ti, ya que las muestras listas para usar no contienen ninguna prueba.

En la consola de Cloud, ve a tu servicio de Cloud Run.
Haz clic en el botón "CONFIGURAR LA IMPLEMENTACIÓN CONTINUA".
Autentícate con GitHub y selecciona el repositorio de tu microservicio

Selecciona tu repo de GitHub y configura la rama en ^main$.

Configura el tipo de compilación para usar Buildpacks
Haz clic en Guardar para configurar la implementación continua.

8. Observabilidad

Las cosas se rompen. La observabilidad nos permite saber cuándo sucede eso y diagnosticar el motivo. Las métricas nos muestran datos sobre el estado y el uso de nuestro servicio. Los registros nos muestran la información instrumentada manualmente que emite nuestro servicio. Las alertas nos permiten recibir notificaciones cuando algo sale mal. Exploremos cada uno de ellos con mayor detalle.

Métricas

Busca tu servicio en la lista de servicios de Cloud Run.
Haz clic en el nombre de tu servicio para visitar su panel de métricas.

Haz clic en el menú ⋮ de una métrica y, luego, selecciona "Ver en el Explorador de métricas".
Ahora puedes cambiar las métricas de recursos, los filtros, la agrupación y otras opciones. Por ejemplo, puedes ver las latencias promedio del servicio para todos los servicios:

Registros

La salida de STDOUT de los servicios se envía al sistema de Cloud Logging de Google Cloud. Puedes acceder a una vista de registro básica desde la página de administrador del servicio de Cloud Run, como la siguiente:

En los registros de Cloud Run, puedes filtrar por gravedad y filtrar los registros. Para obtener más flexibilidad, haz clic en:

Alertas

Crea una URL de verificación de estado para tu servicio.
Para Spring Boot, solo agrega la siguiente dependencia:

org.springframework.boot:spring-boot-starter-actuator

Crea o actualiza el archivo src/main/resources/application.properties y, luego, inhabilita la verificación de espacio en disco:

management.health.diskspace.enabled=false

Crea una alerta de tiempo de actividad y especifica tu protocolo, nombre de host y ruta de acceso. En Spring Boot, la ruta es /actuator/health.
Prueba la alerta

Cómo crear la alerta

9. Felicitaciones

¡Felicitaciones! Compilaste e implementaste correctamente un microservicio que puede luchar con otros microservicios. ¡Buena suerte!

Documentos de referencia

Documentación de Cloud Run