Comienza a usar Cloud Endpoints para grupos de instancias administrados (MIG) con el ESPv2

OpenAPI   |  gRPC

En este instructivo, se muestra cómo configurar e implementar una API de muestra y el proxy de servicio extensible V2 (ESPv2) en contenedores de Docker precompilados en grupos de instancias administrados (MIG) .

La API de REST del código de muestra se describe mediante la especificación de OpenAPI. En el instructivo, también se muestra cómo crear una clave de API y usarla en solicitudes a la API.

Para obtener una descripción general de Cloud Endpoints, consulta Acerca de Endpoints y la descripción de la arquitectura de Cloud Endpoints.

Objetivos

Usa la siguiente lista de tareas de alto nivel a medida que avanzas en el instructivo. Todas las tareas son necesarias para enviar solicitudes a la API con éxito.

1. Configurar un proyecto de Google Cloud Consulta Antes de comenzar.
2. Descarga el código de muestra. Consulta Cómo descargar el código de muestra.
3. Configura el archivo openapi.yaml, que se usa para configurar Endpoints. Consulta Cómo configurar Endpoints.
4. Implementa la configuración de Endpoints para crear un servicio de Endpoints. Consulta Cómo configurar Endpoints.
5. Implementa la API y el ESPv2 en el backend del grupo de instancias administrado (MIG). Consulta Cómo implementar el backend de la API.
6. Envía una solicitud a la API mediante una dirección IP. Consulta Enviar una solicitud mediante la dirección IP.
7. Configura un registro DNS para la API de muestra. Consulta la sección sobre cómo configurar el DNS para Endpoints.
8. Envía una solicitud a la API con el nombre de dominio calificado por completo. Consulta Cómo enviar una solicitud mediante FQDN.
9. Realiza un seguimiento de la actividad de la API. Consulta Cómo realizar un seguimiento de la actividad de la API.
10. Evita que se apliquen cargos a tu cuenta de Google Cloud . Consulta Limpieza.

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

• Compute Engine
• Endpoints

Para obtener una estimación de costos en función del uso previsto, usa la calculadora de precios.

Es posible que los usuarios de Google Cloud nuevos cumplan con los requisitos para acceder a una prueba gratuita.

Cuando completes las tareas que se describen en este documento, podrás borrar los recursos que creaste para evitar que se te siga facturando. Para obtener más información, consulta Realiza una limpieza.

Antes de comenzar

Antes de comenzar

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.

In the Google Cloud console, on the project selector page, select or create 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 role (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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create 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 role (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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. Toma nota del ID del proyecto, ya que será necesario más tarde.

2. Necesitas una aplicación para enviar solicitudes a la API de muestra.

   • Usuarios de Linux y macOS: En este instructivo se proporciona un ejemplo del uso de curl, que suele venir preinstalado en el sistema operativo. Si no tienen curl, pueden descargarlo de la curl página de actualizaciones y descargas.
   • Usuarios de Windows: En este instructivo se proporciona un ejemplo del uso de Invoke-WebRequest, que es compatible con PowerShell 3.0 y versiones posteriores.
3. Descarga Google Cloud CLI.
4. Actualiza gcloud CLI y, luego, instala los componentes de Endpoints.

   gcloud components update

5. Asegúrate de que Google Cloud CLI (gcloud) esté autorizada para acceder a tus datos y servicios en Google Cloud:

   gcloud auth login

   En la nueva pestaña del navegador que se abre, selecciona una cuenta.
6. Configura el proyecto predeterminado con tu ID del proyecto.

   gcloud config set project YOUR_PROJECT_ID

   Reemplaza YOUR_PROJECT_ID con el ID del proyecto. Si tienes otros proyectos de Google Cloud y deseas usar gcloud para administrarlos, consulta Cómo gcloud CLI de gcloud.

Cuando completes las tareas que se describen en este documento, podrás borrar los recursos que creaste para evitar que se te siga facturando. Para obtener más información, consulta Realiza una limpieza.

Descarga el código de muestra

Descarga el código de muestra en tu máquina local.

Java

Para clonar o descargar la API de muestra, haz lo siguiente:

1. Clona el repositorio de la aplicación de muestra en tu máquina local:

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

   Como alternativa, descarga la muestra como un archivo zip y extráelo.

2. Ve al directorio que contiene el código de muestra:

   cd java-docs-samples/endpoints/getting-started

Python

Para clonar o descargar la API de muestra, haz lo siguiente:

1. Clona el repositorio de la aplicación de muestra en tu máquina local:

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

   Como alternativa, descarga la muestra como un archivo zip y extráelo.

2. Ve al directorio que contiene el código de muestra:

   cd python-docs-samples/endpoints/getting-started

Go

Para clonar o descargar la API de muestra, haz lo siguiente:

1. Asegúrate de que esté configurada tu variable de entorno de GOPATH.
2. Clona el repositorio de la aplicación de muestra en tu máquina local de la siguiente forma:

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. Ve al directorio que contiene el código de muestra:

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

Para clonar o descargar la API de muestra, haz lo siguiente:

1. Clona el repositorio de la aplicación de muestra en tu máquina local:

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

   Como alternativa, descarga la muestra como un archivo zip y extráelo.

2. Ve al directorio que contiene el código de muestra:

   cd php-docs-samples/endpoints/getting-started

Ruby

Para clonar o descargar la API de muestra, haz lo siguiente:

1. Clona el repositorio de la aplicación de muestra en tu máquina local:

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

   Como alternativa, descarga la muestra como un archivo zip y extráelo.

2. Ve al directorio que contiene el código de muestra:

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

Para clonar o descargar la API de muestra, haz lo siguiente:

1. Clona el repositorio de la aplicación de muestra en tu máquina local:

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

   Como alternativa, descarga la muestra como un archivo zip y extráelo.

2. Ve al directorio que contiene el código de muestra:

   cd nodejs-docs-samples/endpoints/getting-started

Configura Endpoints

Debes tener un documento de OpenAPI basado en OpenAPI 2.0 o OpenAPI 3.x que describa la superficie de tus apps y cualquier requisito de autenticación. Para obtener más información, consulta Versiones compatibles de OpenAPI.

También debes agregar un campo específico de Google que contenga la URL de cada app para que ESPv2 tenga la información necesaria para invocar una app. Si es la primera vez que usas OpenAPI, consulta la descripción general de OpenAPI para obtener más información.

OpenAPI 2.0

Para configurar Endpoints con una especificación de OpenAPI 2.0, puedes usar el archivo openapi.yaml disponible en el directorio endpoints/getting-started del código de muestra descargado.

El contenido de la especificación de OpenAPI 2.0 debería ser similar al siguiente:

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"

host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

consumes:
  - "application/json"
produces:
  - "application/json"

schemes:
# Uncomment the next line if you configure SSL for this API.
# - "https"
  - "http"

paths:
  /echo:
    post:
      description: "Echo back a given message."
      operationId: "echo"
      produces:
        - "application/json"
      responses:
        200:
          description: "Echo"
          schema:
            $ref: "#/definitions/echoMessage"
      parameters:
        -
          description: "Message to echo"
          in: body
          name: message
          required: true
          schema:
            $ref: "#/definitions/echoMessage"
      security:
        - api_key: []
  /auth/info/googlejwt:
    get:
      description: "Returns the requests' authentication information."
      operationId: "auth_info_google_jwt"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authenication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_jwt: []
  /auth/info/googleidtoken:
    get:
      description: "Returns the requests' authentication information."
      operationId: "authInfoGoogleIdToken"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authentication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_id_token: []

definitions:
  echoMessage:
    type: "object"
    properties:
      message:
        type: "string"
  authInfoResponse:
    properties:
      id:
        type: "string"
      email:
        type: "string"

securityDefinitions:
  # This section configures basic authentication with an API key.
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"

  # This section configures authentication using Google API Service Accounts
  # to sign a json web token. This is mostly used for server-to-server
  # communication.
  google_jwt:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    # This must match the 'iss' field in the JWT.
    x-google-issuer: "jwt-client.endpoints.sample.google.com"
    # Update this with your service account's email address.
    x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
    # This must match the "aud" field in the JWT. You can add multiple
    # audiences to accept JWTs from multiple clients.
    x-google-audiences: "echo.endpoints.sample.google.com"
  # This section configures authentication using Google OAuth2 ID Tokens.
  # ID Tokens can be obtained using OAuth2 clients, and can be used to access
  # your API on behalf of a particular user.

  google_id_token:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    x-google-issuer: "https://accounts.google.com"
    x-google-jwks_uri: "https://www.googleapis.com/oauth2/v3/certs"
    # Your OAuth2 client's Client ID must be added here. You can add
    # multiple client IDs to accept tokens from multiple clients.
    x-google-audiences: "YOUR_CLIENT_ID"

OpenAPI 3.x

Para configurar Endpoints con una especificación de OpenAPI 3.x, puedes reemplazar el contenido del archivo openapi.yaml disponible en el directorio endpoints/getting-started del código de muestra descargado:

1. Abre openapi.yaml en tu editor de texto y reemplaza el contenido por lo siguiente:

   openapi: 3.0.4
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   servers:
     - url: "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint: {}
   
   paths:
     "/echo":
       post:
         description: "Echo back a given message."
         operationId: "echo"
         requestBody:
           description: "Message to echo"
           required: true
           content:
             "application/json":
               schema:
                 $ref: "#/components/schemas/echoMessage"
         responses:
           '200':
             description: "Echo"
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/echoMessage"
         security:
           - api_key: []
   
     "/auth/info/googlejwt":
       get:
         description: "Returns the requests' authentication information."
         operationId: "auth_info_google_jwt"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_jwt: []
   
     "/auth/info/googleidtoken":
       get:
         description: "Returns the requests' authentication information."
         operationId: "authInfoGoogleIdToken"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_id_token: []
   
   components:
     schemas:
       echoMessage:
         type: "object"
         properties:
           message:
             type: "string"
       authInfoResponse:
         properties:
           id:
             type: "string"
           email:
             type: "string"
   
     securitySchemes:
       api_key:
         type: "apiKey"
         name: "key"
         in: "query"
   
       google_jwt:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "jwt-client.endpoints.sample.google.com"
           jwksUri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
           audiences: "echo.endpoints.sample.google.com"
   
       google_id_token:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "https://accounts.google.com"
           jwksUri: "https://www.googleapis.com/oauth2/v3/certs"
           audiences:
             - "YOUR_CLIENT_ID"

2. Guarda el contenido nuevo de openapi.yaml.

Nota: El archivo openapi.yaml de ejemplo contiene una sección para configurar la autenticación que no se necesita para este instructivo. No necesitas configurar las líneas con YOUR_SERVICE_ACCOUNT_EMAIL y YOUR_CLIENT_ID.

En este instructivo, se usa una extensión específica de Google para la especificación de OpenAPI que te permite configurar el nombre del servicio. El método para especificar el nombre del servicio depende de la versión de la especificación de OpenAPI que uses.

OpenAPI 2.0

Usa el campo host para especificar el nombre del servicio:

host: echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog

Para configurar Endpoints, haz lo siguiente:

1. Abre el archivo openapi.yaml.
2. En el campo host, reemplaza YOUR_PROJECT_ID por el ID de tu proyecto Google Cloud .
3. Guarda el archivo openapi.yaml.

OpenAPI 3.x

Usa el campo url en el objeto servers para especificar el nombre del servicio:

servers:
- url: https://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
  x-google-endpoint: {}

Para configurar Endpoints, haz lo siguiente:

1. Abre el archivo openapi.yaml.
2. Si tu archivo openapi.yaml tiene un campo host, quítalo.
3. Agrega un objeto servers como se muestra.
4. En el campo url, reemplaza YOUR_PROJECT_ID por el ID de tu proyecto Google Cloud .
5. Guarda el archivo openapi.yaml.

Después de completar todos los pasos de configuración de modo que puedas enviar con éxito solicitudes a la API de muestra mediante una dirección IP, consulta Configurar DNS para Endpoints si quieres obtener información sobre cómo configurar echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog para que sea el nombre de dominio calificado por completo (FQDN).

Implementa la configuración de Endpoints

Para implementar la configuración de Endpoints, usa el comando gcloud endpoints services deploy. Este comando usa la Administración de servicios para crear un servicio administrado.

Para implementar la configuración de Endpoints, haz lo siguiente:

1. Asegúrate de estar en el directorio en el que se encuentra tu archivo de configuración openapi.yaml.
2. Sube la configuración y crea un servicio administrado.

   gcloud endpoints services deploy openapi.yaml
   

Entonces, el comando gcloud llama a la API de Service Management para crear un servicio administrado con el nombre que especificaste en el campo host o servers.url del archivo openapi.yaml. La Administración de servicios configura el servicio de acuerdo con la configuración del archivo openapi.yaml. Cuando realizas cambios en openapi.yaml, debes volver a implementar el archivo para actualizar el servicio de Endpoints.

Mientras se crea y configura el servicio, la Administración de servicios exporta la información a la terminal. Puedes ignorar sin riesgo las advertencias que indican que las rutas de acceso en el archivo openapi.yaml no requieren una clave de API. Cuando termina de configurarse el servicio, la Administración de servicios muestra un mensaje con el ID de configuración del servicio y el nombre del servicio, de manera similar a este ejemplo:

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

En el ejemplo anterior, 2017-02-13r0 es el ID de configuración del servicio y echo-api.endpoints.example-project-12345.cloud.goog es el servicio de Endpoints. El ID de configuración de servicio consiste en una marca de fecha seguida de un número de revisión. Si implementas el archivo openapi.yaml otra vez el mismo día, el número de revisión aumenta en el ID de configuración del servicio. Puedes ver la configuración del servicio de Endpoints en la página Endpoints > Servicios de la Google Cloud consola.

Si recibes un mensaje de error, consulta Cómo solucionar problemas en la implementación de la configuración de Endpoints.

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.

Implementar el backend de la API

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=echo \
     --net=esp_net \
     gcr.io/google-samples/echo-python:1.0
   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=echo:8080
   

   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 HTTP a tu grupo de instancias.

Este balanceador de cargas usa un frontend para recibir tráfico entrante y un backend a fin de distribuir este tráfico a instancias en buen estado. Debido a que el balanceador de cargas tiene múltiples componentes, esta tarea se divide en las siguientes partes:

• Configuración de backend
• Configuración de frontend
• Revisión y finalización

Completa todos los pasos para crear el balanceador de cargas.

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 la sección Balanceador de cargas de aplicaciones (HTTP/S), haz clic en Iniciar configuración.

3. En Orientado a Internet o solo interno, selecciona De Internet a mis VMs. Luego, haz clic en Continuar.

4. Para el Nombre del balanceador de cargas, ingresa espv2-load-balancer.

Configuración de backend

1. En el panel izquierdo de la página Crear balanceador de cargas de aplicaciones externo global, haz clic en Configuración de backend.
2. Haz clic en Crear o seleccionar servicios y bucket de backend para abrir un menú desplegable. Haz clic en Servicios de backend y, luego, en Crear un servicio de backend.
3. En la ventana nueva, para el Nombre de la aplicación de backend, ingresa espv2-backend.
4. Establece Grupo de instancias en load-balancing-espv2-group.
5. Establece Números de puerto en 80. Esto permite el tráfico HTTP entre el balanceador de cargas y el grupo de instancias.
6. En Modo de balanceo, selecciona Utilización.
7. Haz clic en Listo para crear el backend.

8. Crea la verificación de estado para el backend del balanceador de cargas:

   Sugerencia profesional: Las verificaciones de estado se usan para el balanceo de cargas y la reparación automática, pero con diferentes propósitos:

   • Las verificaciones de estado para el balanceo de cargas se usan a fin de detectar instancias que no responden y alejar el tráfico de ellas.
   • Las verificaciones de estado para la reparación automática se usan a fin de detectar y vovler a crear instancias fallidas.

   Usa verificaciones de estado diferentes para el balanceo de cargas y la reparación automática. El uso de la misma verificación de estado para estos servicios quitaría la distinción entre las instancias que no responden y las instancias fallidas, lo que causaría latencia innecesaria o falta de disponibilidad para tus usuarios. Para obtener más información, consulta Conceptos de verificación de estado.

   1. En Verificación de estado, selecciona Crear una verificación de estado (o Crear otra verificación de estado) del menú desplegable. Se abre una ventana nueva.
   2. En la ventana nueva debajo de Nombre, ingresa espv2-load-balancer-check.
   3. Establece el Protocolo en HTTP.
   4. En Puerto, ingresa 80.
   5. Para este instructivo, configura la ruta de solicitud como /healthz, que es una ruta a la que el ESPv2 está configurado para responder.

   6. Establece los siguientes Criterios de estado:

      1. Establece el Intervalo de verificación en 3 segundos. Esto define la cantidad de tiempo desde el inicio de un sondeo hasta el inicio del siguiente.
      2. Establece el Tiempo de espera en 3 segundos. Esto define la cantidad de tiempo que Google Cloud espera una respuesta a un sondeo. Su valor debe ser menor o igual que el intervalo de verificación.
      3. Establece Umbral de buen estado en 2 sondeos exitosos consecutivos. Esto define la cantidad de sondeos secuenciales que deben tener éxito para que la instancia se considere en buen estado.
      4. Establece Umbral de mal estado en 2 fallas consecutivas. Esto define la cantidad de sondeos secuenciales que deben fallar para que la instancia se considere en mal estado.

      Sugerencia profesional: A fin de obtener información sobre cómo definir mejor el Intervalo de verificación y los valores de Tiempo de espera para tu aplicación, consulta Cómo funcionan las verificaciones de estado. A fin de definir mejor los valores del Umbral de buen estado y el Umbral de mal estado para tu aplicación, usa los siguientes criterios:

      • Si el tráfico se dirige a instancias con alta latencia, incluso cuando hay instancias más rápidas disponibles, haz que la verificación de estado sea más agresiva para que disminuya el umbral de tráfico.
      • Si el tráfico se dirige fuera de instancias con baja latencia, haz que la verificación de estado sea más conservadora para aumentar el límite de tráfico.

      Para obtener información detallada sobre cómo optimizar y medir la latencia, consulta esta página sobre cómo optimizar la latencia de la aplicación con el balanceo de cargas.

   7. Haz clic en Guardar y continuar para crear la verificación de estado.

9. Haz clic en Crear para crear el servicio de backend.

Configuración de frontend

1. En el panel izquierdo de la página Crear balanceador de cargas de aplicaciones externo global, haz clic en Configuración de frontend.
2. En la página Configuración de frontend, debajo de Nombre, ingresa espv2-ipv4-frontend.
3. Configura el Protocolo en HTTP.
4. Configura el Puerto en 80.
5. Haz clic en Listo para crear el frontend.

Revisión y finalización

1. Para verificar la configuración del balanceo de cargas antes de crear el balanceador de cargas, sigue estos pasos:

   1. En el panel izquierdo de la página Crear balanceador de cargas de aplicaciones externo global, haz clic en Revisar y finalizar.

   2. En la página Revisar y finalizar, verifica la siguiente configuración de Backend:

      • El Servicio de backend debe ser espv2-backend.
      • El Protocolo de extremo es HTTP.
      • La Verificación de estado es espv2-load-balancer-check.
      • El Grupo de instancias debe ser load-balancing-espv2-group.

   3. En la misma página, verifica que Frontend use una dirección IP con un Protocolo de HTTP.

2. En el panel izquierdo de la página Crear balanceador de cargas de aplicaciones externo global, haz clic en Crear para terminar de crear el balanceador de cargas.

   Es posible que debas esperar unos minutos para que se complete la creación del balanceador de cargas.

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

   Ir a Balanceador de cargas

Envía una solicitud mediante una dirección IP

Una vez que la API de muestra y el ESPv2 estén en ejecución en el backend implementado, podrás enviar solicitudes a la API desde tu máquina local.

Crea una clave de API y configura una variable del entorno

El código de muestra requiere una clave de API. La solicitud es más simple si configuras una variable de entorno para la clave de API.

1. En el mismo proyecto Google Cloud que usaste para tu API, crea una clave de API en la página de credenciales de la API. Si quieres crear una clave de API en otro proyecto de Google Cloud , consulta Cómo habilitar una API en tu proyecto de Google Cloud .

   Ir a la página Credenciales

2. Haz clic en Crear credenciales y selecciona Clave de API.
3. Copia la clave al portapapeles.
4. Haz clic en Cerrar.
5. En tu computadora local, pega la clave de API para asignarla a una variable de entorno:
   • En Linux o macOS: export ENDPOINTS_KEY=AIza...
   • En Windows PowerShell, haz lo siguiente: $Env:ENDPOINTS_KEY="AIza..."

Envía la solicitud

Linux o macOS

Usa curl para enviar una solicitud HTTP con la variable de entorno ENDPOINTS_KEY que configuraste antes. Reemplaza IP_ADDRESS por la dirección IP externa de la instancia.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

En el curl anterior, sucede lo siguiente:

• La opción --data especifica los datos que se publicarán en la API.
• La opción --header especifica que los datos están en formato JSON.

PowerShell

Usa Invoke-WebRequest para enviar una solicitud HTTP con la variable de entorno ENDPOINTS_KEY que configuraste antes. Reemplaza IP_ADDRESS por la dirección IP externa de la instancia.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

En el ejemplo anterior, las dos primeras líneas terminan en un acento grave. Cuando pegues el ejemplo en PowerShell, asegúrate de que no quede un espacio después de los acentos graves. Para obtener más información sobre las opciones usadas en la solicitud de ejemplo, consulta Invoke-WebRequest en la documentación de Microsoft.

App de terceros

Puedes usar una aplicación de terceros, como la extensión del navegador Chrome Postman, para enviar la solicitud:

• Selecciona POST como el verbo HTTP.
• Para el encabezado, selecciona la clave content-type y el valor application/json.
• Para el cuerpo, ingresa lo siguiente:
  {"message":"hello world"}
• En la URL, usa la clave de API real en lugar de la variable de entorno. Por ejemplo:
  http://192.0.2.0:80/echo?key=AIza...

La API repite el mensaje que le enviaste y responde lo siguiente:

{
  "message": "hello world"
}

Si no obtuviste una respuesta correcta, consulta Soluciona errores de respuesta.

¡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 hay respuestas de otros usuarios de Endpoints y de los ingenieros de Google, quienes supervisan el grupo.

Configurar DNS para Endpoints

Debido a que el nombre del servicio de Endpoints para la API se encuentra en el dominio .endpoints.YOUR_PROJECT_ID.cloud.goog, puedes usarlo como el nombre de dominio calificado por completo (FQDN) mediante un pequeño cambio de configuración en el archivo openapi.yaml. De este modo, puedes enviar solicitudes a la API de muestra si usas echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog en lugar de la dirección IP.

Para configurar DNS de Endpoints, sigue estos pasos:

OpenAPI 2.0

1. Abre tu archivo de configuración de OpenAPI, openapi.yaml, y agrega la propiedad x-google-endpoints en el nivel superior del archivo (sin sangría ni anidado) como se muestra en el siguiente fragmento:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"

2. En la propiedad name, reemplaza YOUR_PROJECT_ID por el ID del proyecto.
3. En la propiedad target, reemplaza IP_ADDRESS por la dirección IP que usaste cuando enviaste una solicitud a la API de muestra.
4. Implementa tu archivo de configuración de OpenAPI actualizado en la Administración de servicios:

   gcloud endpoints services deploy openapi.yaml
   

OpenAPI 3.x

1. Abre tu archivo de configuración de OpenAPI, openapi.yaml, y agrega la propiedad servers.url en el nivel superior del archivo (sin sangría ni anidado) como se muestra en el siguiente fragmento:

   servers:
     - url: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint:
         target: "IP_ADDRESS"

2. En la propiedad name, reemplaza YOUR_PROJECT_ID por el ID del proyecto.
3. En la propiedad target, reemplaza IP_ADDRESS por la dirección IP que usaste cuando enviaste una solicitud a la API de muestra.
4. Implementa tu archivo de configuración de OpenAPI actualizado en la Administración de servicios:

   gcloud endpoints services deploy openapi.yaml
   

Por ejemplo, supongamos que el archivo openapi.yaml está configurado de esta manera:

OpenAPI 2.0

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

OpenAPI 3.x

servers:
  - url: "echo-api.endpoints.example-project-12345.cloud.goog"
    x-google-endpoint:
      target: "192.0.2.1"

Cuando implementas el archivo openapi.yaml con el comando gcloud anterior, la Administración de servicios crea un registro A de DNS, echo-api.endpoints.my-project-id.cloud.goog, que se resuelve en la dirección IP de destino, 192.0.2.1. Es posible que la nueva configuración de DNS tarde algunos minutos en propagarse.

Configura SSL

Para obtener más detalles sobre cómo configurar DNS y SSL, consulta Cómo habilitar SSL para Endpoints.

Enviar una solicitud mediante el FQDN

Ahora que tienes el registro DNS configurado para la API de muestra, envíale una solicitud con el FQDN (reemplaza YOUR_PROJECT_ID por el ID de tu proyecto) y la variable de entorno ENDPOINTS_KEY que configuraste antes:

• En Linux o macOS:

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• En Windows PowerShell:

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

Realizar un seguimiento de la actividad de la API

Para realizar un seguimiento de la actividad de la API, sigue estos pasos:

1. 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 momentos en reflejarse en los grafos.
2. Revisa los registros de solicitud de tu API en la página del visor de registros.
   

   Ir a la página Explorador de registros

Realiza una limpieza

Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos usados en este instructivo, borra el proyecto que contiene los recursos o conserva el proyecto y borra los recursos individuales.

1. Asegúrate de que gcloud CLI (gcloud) esté autorizada para acceder a tus datos y servicios en Google Cloud:

   gcloud auth login
   

2. Ingresa lo siguiente para mostrar los IDs de tus proyectos de Google Cloud:

   gcloud projects list
   

3. Con el ID del proyecto aplicable del paso anterior, establece el proyecto predeterminado deGoogle Cloud en el que se encuentra tu aplicación:

   gcloud config set project [YOUR_PROJECT_ID]
   

4. Obtén el nombre de todos los servicios administrados en tu proyecto Google Cloud :

   gcloud endpoints services list
   

5. Borra el servicio de Administración de servicios. Reemplaza SERVICE_NAME por el nombre del servicio que deseas quitar.

   gcloud endpoints services delete SERVICE_NAME
   

   La ejecución de gcloud endpoints services delete no borra de inmediato el servicio administrado. La Administración de servicios inhabilita el servicio administrado durante 30 días, lo que te da tiempo para restablecerlo si es necesario. Luego de 30 días, la Administración de servicios borra el servicio administrado de forma permanente.

6. Ve a la página Balanceador de cargas.

   Ir a Balanceador de cargas

   Borra el balanceador de cargas espv2-load-balancer con el servicio de backend espv2-backend y la verificación de estado espv2-load-balancer-check.

7. Ir a la página Grupos de instancias.

   IR A GRUPOS DE INSTANCIAS

   Borra load-balancing-espv2-group

8. Ve a la página Plantilla de instancias.

   Ir a Plantillas de instancias

   Borrar load-balancing-espv2-template.

¿Qué sigue?

• Compartir API protegidas por claves de API
• Obtener más información sobre la autenticación
• Obtener más información sobre las opciones del servicio de asistencia de la comunidad