Comienza a usar gRPC de Cloud Endpoints para el grupo de instancias administrado con el ESPv2

OpenAPI   |  gRPC

En este instructivo, se muestra cómo implementar un ejemplo simple del servicio gRPC con el proxy de servicio extensible V2 (ESPv2) en un grupo de instancias administrado

En este instructivo, se usa la versión de Python del ejemplo bookstore-grpc. Consulta la sección Próximos pasos para ver muestras de gRPC en otros lenguajes.

Para obtener más información, consulta las secciones Acerca de Cloud Endpoints y Descripción general de la arquitectura de Cloud Endpoints.

Configura Endpoints

Clona el repositorio de muestra bookstore-grpc de GitHub.

Para configurar Endpoints, haz lo siguiente:

1. Crea un archivo descriptor protobuf autónomo desde tu archivo de servicio .proto:
   1. Guarda una copia de bookstore.proto del repositorio de ejemplo. Este archivo define la API del servicio de Bookstore.
   2. Crea el directorio siguiente: mkdir generated_pb2
   3. Crea api_descriptor.pb, el archivo descriptor, mediante el compilador de búferes de protocolo protoc. Ejecuta el comando siguiente en el directorio donde guardaste bookstore.proto:

      python -m grpc_tools.protoc \
          --include_imports \
          --include_source_info \
          --proto_path=. \
          --descriptor_set_out=api_descriptor.pb \
          --python_out=generated_pb2 \
          --grpc_python_out=generated_pb2 \
          bookstore.proto

      En el comando anterior, --proto_path se configura como el directorio de trabajo actual. En tu entorno de compilación de gRPC, si usas un directorio diferente para los archivos de entrada .proto, cambia --proto_path a fin de que el compilador busque el directorio donde guardaste bookstore.proto.

2. Crea un archivo de configuración YAML para la API de gRPC:
   1. Guarda una copia del archivo api_config.yaml. Este archivo define la configuración de la API de gRPC para el servicio de Bookstore.
   2. Reemplaza MY_PROJECT_ID en tu archivo api_config.yaml por el ID de tu Google Cloud proyecto. Por ejemplo:

      #
      # Name of the service configuration.
      #
      name: bookstore.endpoints.example-project-12345.cloud.goog
      

      Ten en cuenta que el valor del campo apis.name en este archivo coincide con exactitud con el nombre de API calificado por completo del archivo .proto; de lo contrario, la implementación no funcionará. El servicio de Bookstore se define en bookstore.proto dentro del paquete endpoints.examples.bookstore. Su nombre de API calificado por completo es endpoints.examples.bookstore.Bookstore, tal como aparece en el archivo api_config.yaml.

      apis:
        - name: endpoints.examples.bookstore.Bookstore

Consulta Configurar Endpoints para obtener más información.

Implemente la configuración de Endpoints

Para implementar la configuración de Endpoints, usa el comando gcloud endpoints services deploy. Este comando usa Service Management a fin de crear un servicio administrado.

1. Asegúrate de estar en el directorio en el que se encuentran los archivos api_descriptor.pb y api_config.yaml.
2. Confirma que el proyecto predeterminado que usa la herramienta de línea de comandos de gcloud en este momento sea el Google Cloud proyecto en el que quieres implementar la configuración de Endpoints. Valida el ID del proyecto que se muestra en el comando siguiente para asegurarte de que el servicio no se cree en el proyecto equivocado.

   gcloud config list project
   

   Si necesitas cambiar el proyecto predeterminado, ejecuta el siguiente comando:

   gcloud config set project YOUR_PROJECT_ID
   

3. Implementa el archivo proto descriptor y el archivo de configuración con Google Cloud CLI:

   gcloud endpoints services deploy api_descriptor.pb api_config.yaml
   

   Mientras se crea y configura el servicio, Service Management exporta la información a la terminal. Cuando se completa la implementación, aparece un mensaje similar al siguiente:

   Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]

   CONFIG_ID es el ID de configuración único del servicio de Endpoints que creó la implementación. Por ejemplo:

   Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
   

   En el ejemplo anterior, 2017-02-13r0 es el ID de configuración del servicio y bookstore.endpoints.example-project.cloud.goog es el nombre del servicio. El ID de configuración del servicio consiste en una marca de fecha seguida de un número de revisión. Si implementas la configuración de Endpoints otra vez el mismo día, el número de revisión aumenta en el ID de configuración del servicio.

Verifica los servicios requeridos

Como mínimo, Endpoints y ESP requieren que se habiliten los siguientes servicios de Google:

Name	Título
servicemanagement.googleapis.com	API de Administración de servicios
servicecontrol.googleapis.com	Service Control API

En la mayoría de los casos, el comando de gcloud endpoints services deploy habilita estos servicios obligatorios. Sin embargo, el comando gcloud se completa de manera correcta sin habilitar los servicios requeridos en las circunstancias siguientes:

• Usaste una aplicación de terceros, como Terraform, y no incluiste estos servicios.

• Implementaste la configuración de Endpoints en un proyecto deGoogle Cloud existente en el que estos servicios se inhabilitaron de forma explícita.

Usa el siguiente comando para confirmar que los servicios requeridos están habilitados:

gcloud services list

Si no ves los servicios necesarios que se incluyeron en la lista, habilítalos:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

También habilita el servicio de Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Para determinar la variable ENDPOINTS_SERVICE_NAME, puedes hacer lo siguiente:

• Después de implementar la configuración de Endpoints, ve a la página Endpoints en la consola de Cloud. La lista de posibles ENDPOINTS_SERVICE_NAME se muestra en la columna Nombre del servicio.

• Para OpenAPI, el ENDPOINTS_SERVICE_NAME es lo que especificaste en el campo host de tu especificación de OpenAPI. Para gRPC, el ENDPOINTS_SERVICE_NAME es lo que especificaste en el campo name de tu configuración de Endpoints de gRPC.

Para obtener más información sobre los comandos gcloud, consulta servicios de gcloud.

Si recibes un mensaje de error, consulta Solucionar problemas con la implementación de la configuración de Cloud Endpoints. Consulta Cómo implementar la configuración de Endpoints para obtener información adicional.

Implementar el backend de la API

Hasta ahora, implementaste la configuración de API en Service Management, pero aún no implementaste el código que entrega el backend de la API. En esta sección, aprenderás a configurar Docker en tu grupo de instancias administrado y a ejecutar el código del backend de la API y el ESPv2 en un contenedor de Docker.

Crea una plantilla de instancias

Crea una plantilla que usarás para crear un grupo de instancias de VM. Cada instancia que se crea a partir de la plantilla inicia un ESPv2 y un servidor de aplicaciones de backend.

1. En la consola de Google Cloud , ve a la página Plantillas de instancias.

   Ir a Plantillas de instancia

2. Haga clic en Crear plantilla de instancias.

3. En Nombre, ingresa load-balancing-espv2-template.

4. En Configuración de máquina, establece el Tipo de máquina en e2-micro.

5. En Disco de arranque, configura la Imagen como Container Optimized OS stable version.

6. En Firewall, selecciona Permitir tráfico HTTP.

7. Haz clic en Administración, seguridad, discos, redes, instancia única para ver la configuración avanzada.

8. Haz clic en la pestaña Administración. En Automatización, ingresa la siguiente secuencia de comandos de inicio. Recuerda actualizar ENDPOINTS_SERVICE_NAME.

   sudo docker network create --driver bridge esp_net
   sudo docker run \
     --detach \
     --name=bookstore \
     --net=esp_net \
     gcr.io/endpointsv2/python-grpc-bookstore-server:1
   sudo docker run \
     --detach \
     --name=esp \
     --publish=80:9000 \
     --net=esp_net \
     gcr.io/endpoints-release/endpoints-runtime:2 \
     --service=ENDPOINTS_SERVICE_NAME \
     --rollout_strategy=managed \
     --listener_port=9000 \
     --healthz=/healthz \
     --backend=grpc://bookstore:8000
   

   La secuencia de comandos obtiene, instala y, luego, inicia el servidor de aplicaciones Echo y el servidor proxy ESPv2 cuando se inicia la instancia.

9. Haga clic en Crear.

Espera hasta que se haya creado la plantilla antes de continuar.

Crea un grupo de instancias administrado regional.

Para ejecutar la aplicación, usa la plantilla de instancias a fin de crear un grupo de instancias administrado regional:

1. En la consola de Google Cloud , ve a la página Grupos de instancias.

   Ir a Grupos de instancias

2. Haga clic en Crear grupo de instancias.

3. En Nombre, ingresa load-balancing-espv2-group.

4. En Ubicación, selecciona Varias zonas.

   Sugerencia profesional: Para garantizar que tu aplicación esté disponible durante eventos extremos, como interrupciones zonales, Compute Engine recomienda que distribuyas tu aplicación en varias zonas.

5. En Región, selecciona us-central1.

6. Haz clic en el menú desplegable Configurar zonas para mostrar las Zonas. Selecciona las siguientes zonas:

   • us-central1-b
   • us-central1-c
   • us-central1-f

7. En Plantilla de instancias, selecciona load-balancing-espv2-template.

8. En Ajuste de escala automático, selecciona No ajustar la escala de forma automática.

9. En Número de instancias, ingresa 3.

   Sugerencia profesional: Cuando se crea un grupo de instancias administrado regional, Compute Engine recomienda aprovisionar suficientes instancias para que, si todas las instancias de una zona dejan de estar disponibles, las instancias restantes puedan satisfacer la cantidad mínima de instancias que necesitas. Sin embargo, el aprovisionamiento de más instancias que las necesarias podría generar costos adicionales. Si deseas obtener más información, consulta Aprovisiona el tamaño correcto del grupo de instancias administrado para garantizar la disponibilidad.

10. En Redistribución de instancias, selecciona Activada.

11. En Reparación automática y Verificación de estado, selecciona Sin verificación de estado.

12. Haz clic en Crear. Esto te redirecciona a la página Grupos de instancias.

    Nota: Es posible que debas esperar unos minutos hasta que todas las instancias del grupo estén listas para mostrar la aplicación web.

Crea un balanceador de cargas

En esta sección, se explican los pasos necesarios para crear un balanceador de cargas regional que dirija el tráfico de TCP a tu grupo de instancias.

1. En la consola de Google Cloud , ve a la página Crea un balanceador de cargas.

   Ir a Crea un balanceador de cargas

2. En Balanceo de cargas TCP, haga clic en Iniciar configuración.

3. En Orientado a Internet o solo interno, selecciona De Internet a mis VM.

4. En Varias regiones o una sola región, selecciona Solo en una región.

5. En Tipo de backend, selecciona Servicio de backend.

6. Haga clic en Continuar.

7. En Nombre, ingresa espv2-load-balancer.

8. En Configuración de backend, selecciona la región us-central1.

9. Selecciona el grupo de instancias load-balancing-espv2-group.

10. En Verificación de estado, crea una verificación de estado nueva.

    • En Nombre, ingresa espv2-load-balancer-check.
    • Confirme que el Protocolo sea TCP, que el Puerto sea 80.

11. En Configuración de frontend, ingresa el número de puerto 80.

12. En Revisar y finalizar, verifica lo siguiente:

    • El Grupo de instancias es load-balancing-espv2-group.
    • La región es us-central1.
    • El Protocolo es TCP.
    • El IP:Puerto es EPHEMERAL:80.

13. Después de crear el balanceador de cargas, busca la dirección IP de la página Balanceador de cargas.

    Ir al balanceador de cargas

Envía una solicitud a la API

Si envías la solicitud desde la misma instancia en la que se ejecutan los contenedores de Docker, puedes reemplazar SERVER_IP por localhost. De lo contrario, reemplaza SERVER_IP por la IP externa de la instancia.

Para buscar la dirección IP externa, ejecuta el comando siguiente:

gcloud compute instances list

Para enviar solicitudes a la API de muestra, puedes usar un cliente gRPC de muestra escrito en Python.

1. Clona el repositorio de Git donde se aloja el código del cliente gRPC:

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
      

2. Cambia tu directorio de trabajo:

   cd python-docs-samples/endpoints/bookstore-grpc/
     

3. Instala las dependencias:

   pip install virtualenv
   virtualenv env
   source env/bin/activate
   python -m pip install -r requirements.txt

4. Envía una solicitud a la API de muestra:

   python bookstore_client.py --host SERVER_IP --port 80
   

   • Para ver los grafos de actividad de tu API, ve a la página Endpoints > Servicios.
     

     Ir a la página Servicios de Endpoints

     La solicitud puede tardar unos minutos en reflejarse en los gráficos.

   • Revisa los registros de solicitud de tu API en la página del visor de registros.
     

     Ir a la página Explorador de registros

Si no obtienes una respuesta correcta, consulta Solucionar errores en las respuestas.

¡Acabas de implementar y probar una API en Endpoints!

Nota: Si quieres contarnos qué te gustó de este instructivo, envíanos tus comentarios al final de esta página. Tus comentarios nos ayudarán a mejorar estos instructivos.
Si recibiste un error, únete al grupo de Google google-cloud-endpoints y cuéntanos cuál fue el problema. En este grupo encontrarás respuestas de otros usuarios de Endpoints y de los ingenieros de Google que supervisan el grupo.