En este tutorial se explica cómo configurar y desplegar una API de ejemplo y Extensible Service Proxy V2 (ESPv2) que se ejecuta en contenedores Docker prediseñados en grupos de instancias gestionadas (MIGs) .
La API REST del código de ejemplo se describe mediante la especificación de OpenAPI. En el tutorial también se explica cómo crear una clave de API y usarla en las solicitudes a la API.
Para obtener una descripción general de Cloud Endpoints, consulta Acerca de Endpoints y Arquitectura de Endpoints.
Descargar el código de ejemplo
Descarga el código de ejemplo en tu máquina local.
Para clonar o descargar la API de ejemplo, sigue estos pasos:
- Clona el repositorio de aplicaciones de muestra en la máquina local:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.
- Accede al directorio que contiene el código de muestra:
cd java-docs-samples/endpoints/getting-started
Para clonar o descargar la API de ejemplo, sigue estos pasos:
- Clona el repositorio de aplicaciones de muestra en la máquina local:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples
También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.
- Accede al directorio que contiene el código de muestra:
cd python-docs-samples/endpoints/getting-started
Para clonar o descargar la API de ejemplo, sigue estos pasos:
- Asegúrate de que la
variable de entorno
GOPATH
esté definida. - Clona el repositorio de aplicaciones de muestra en la máquina local:
go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
- Accede al directorio que contiene el código de muestra:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
Para clonar o descargar la API de ejemplo, sigue estos pasos:
- Clona el repositorio de aplicaciones de muestra en la máquina local:
git clone https://github.com/GoogleCloudPlatform/php-docs-samples
También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.
- Accede al directorio que contiene el código de muestra:
cd php-docs-samples/endpoints/getting-started
Para clonar o descargar la API de ejemplo, sigue estos pasos:
- Clona el repositorio de aplicaciones de muestra en la máquina local:
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.
- Accede al directorio que contiene el código de muestra:
cd ruby-docs-samples/endpoints/getting-started
Para clonar o descargar la API de ejemplo, sigue estos pasos:
- Clona el repositorio de aplicaciones de muestra en la máquina local:
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.
- Accede al directorio que contiene el código de muestra:
cd nodejs-docs-samples/endpoints/getting-started
Configurar Endpoints
El código de ejemplo incluye el archivo de configuración de OpenAPI, openapi.yaml
, que se basa en la especificación de OpenAPI v2.0.
Configuras e implementas openapi.yaml
en tu máquina local.
Para configurar Endpoints, haz lo siguiente:
- En el directorio de código de ejemplo, abre el archivo de configuración
openapi.yaml
.Java Python Ir PHP Ruby NodeJS Ten en cuenta lo siguiente:
- En el ejemplo de configuración se muestran las líneas cercanas al campo
host
, que debe modificar. Para desplegar el archivoopenapi.yaml
en Endpoints, se necesita el documento OpenAPI completo. - El archivo de ejemplo
openapi.yaml
contiene una sección para configurar la autenticación que no es necesaria en este tutorial. No es necesario configurar las líneas con YOUR-SERVICE-ACCOUNT-EMAIL y YOUR-CLIENT-ID. - OpenAPI es una especificación independiente del lenguaje. El mismo archivo
openapi.yaml
se encuentra en el ejemplogetting-started
de cada repositorio de GitHub de idioma para mayor comodidad.
- En el ejemplo de configuración se muestran las líneas cercanas al campo
- En el campo
host
, sustituye el texto por el nombre del servicio Endpoints, que debe tener el siguiente formato:host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
Sustituye YOUR_PROJECT_ID por el ID de tu proyecto. Google Cloud Por ejemplo:
host: "echo-api.endpoints.example-project-12345.cloud.goog"
Ten en cuenta que echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
es el nombre del servicio Endpoints. No es el nombre de dominio completo (FQDN) que usas para enviar solicitudes a la API.
Para obtener información sobre los campos del documento OpenAPI que requiere Endpoints, consulta Configurar Endpoints.
Una vez que hayas completado todos los pasos de configuración que se indican a continuación para poder enviar solicitudes a la API de ejemplo mediante una dirección IP, consulta Configurar el DNS de los endpoints para obtener información sobre cómo configurar echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
para que sea el FQDN.
Desplegar la configuración de Endpoints
Para desplegar la configuración de Endpoints, usa el comando gcloud endpoints
services deploy
. Este comando usa Gestión de servicios para crear un servicio gestionado.
Para desplegar la configuración de Endpoints, sigue estos pasos:
- Asegúrate de que estás en el directorio
endpoints/getting-started
. - Sube la configuración y crea un servicio gestionado:
gcloud endpoints services deploy openapi.yaml
El comando gcloud
llama a la API Service Management para crear un servicio gestionado con el nombre que has especificado en el campo host
del archivo openapi.yaml
.
Gestión de servicios configura el servicio según los ajustes del archivo openapi.yaml
. Cuando hagas cambios en openapi.yaml
, debes volver a implementar el archivo para actualizar el servicio Endpoints.
Mientras crea y configura el servicio, Gestión de servicios muestra información en la terminal. Puedes ignorar las advertencias sobre las rutas del archivo openapi.yaml
que no requieren una clave de API.
Cuando termine de configurar el servicio, Service Management mostrará un mensaje con el ID de configuración del servicio y el nombre del servicio, similar al siguiente:
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 Endpoints. El ID de configuración del servicio consta de una marca de fecha seguida de un número de revisión. Si vuelves a implementar el archivo openapi.yaml
el mismo día, el número de revisión se incrementará en el ID de configuración del servicio. Puedes ver la configuración del servicio Endpoints en la página Endpoints > Services (Servicios) de la consola de Google Cloud .
Si aparece un mensaje de error, consulta Solucionar problemas de despliegue de la configuración de Endpoints.
Comprobando los servicios necesarios
Como mínimo, Endpoints y ESP requieren que los siguientes servicios de Google estén habilitados:Nombre | Título |
---|---|
servicemanagement.googleapis.com |
API Service Management |
servicecontrol.googleapis.com |
API Service Control |
En la mayoría de los casos, el comando gcloud endpoints services deploy
habilita estos servicios obligatorios. Sin embargo, el comando gcloud
se completa correctamente, pero no habilita los servicios necesarios en las siguientes circunstancias:
Si has usado una aplicación de terceros, como Terraform, y no incluyes estos servicios.
Has desplegado la configuración de Endpoints en unGoogle Cloud proyecto en el que estos servicios se han inhabilitado explícitamente.
Usa el siguiente comando para confirmar que los servicios necesarios están habilitados:
gcloud services list
Si no ves los servicios necesarios, habilítalos:
gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
También debes habilitar el servicio Endpoints:
gcloud services enable ENDPOINTS_SERVICE_NAME
Para determinar el ENDPOINTS_SERVICE_NAME, puedes hacer lo siguiente:
Después de desplegar la configuración de Endpoints, ve a la página Endpoints de la consola de Cloud. La lista de posibles ENDPOINTS_SERVICE_NAME se muestra en la columna Nombre del servicio.
En OpenAPI, ENDPOINTS_SERVICE_NAME es el valor que has especificado en el campo
host
de tu especificación de OpenAPI. En gRPC, ENDPOINTS_SERVICE_NAME es el valor que has especificado en el camponame
de tu configuración de endpoints de gRPC.
Para obtener más información sobre los comandos de gcloud
, consulta los servicios de gcloud
.
Desplegar el backend de la API
Crear una plantilla de instancia
Crea una plantilla que usarás para crear un grupo de instancias de máquina virtual. Cada instancia creada a partir de la plantilla inicia un ESPv2 y un servidor de aplicaciones backend.
En la consola, ve a la página Plantillas de instancia. Google Cloud
Haz clic en Crear plantilla de instancia.
En Name (Nombre), introduce
load-balancing-espv2-template
.En Configuración de la máquina, selecciona
e2-micro
en Tipo de máquina.En Disco de arranque, define Imagen como
Container Optimized OS stable version
.En Cortafuegos, selecciona Permitir el tráfico HTTP.
Haz clic en Gestión, seguridad, discos, redes, único cliente para ver la configuración avanzada.
Haga clic en la pestaña Gestión. En Automatización, introduce la siguiente secuencia de comandos de inicio. No olvides 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 e inicia el servidor de aplicaciones de eco y el servidor proxy ESPv2 al iniciar la instancia.
Haz clic en Crear.
Espera a que se cree la plantilla antes de continuar.
Crear un grupo de instancias gestionado regional
Para ejecutar la aplicación, usa la plantilla de instancia para crear un grupo de instancias gestionado regional:
En la consola, ve a la página Grupos de instancias. Google Cloud
Haz clic en Crear grupo de instancias.
En Name (Nombre), introduce
load-balancing-espv2-group
.En Ubicación, selecciona Varias zonas.
En Región, selecciona us-central1.
Haz clic en el menú desplegable Configurar zonas para ver Zonas. Selecciona las siguientes zonas:
- us-central1-b
- us-central1-c
- us-central1-f
En Plantilla de instancia, selecciona
load-balancing-espv2-template
.En Autoescalado, selecciona No autoescalar.
Define Número de instancias en
3
.En Redistribución de instancias, selecciona Activada.
En Autorreparación y Comprobación del estado, selecciona Ninguna comprobación del estado.
Haz clic en Crear. Se te redirigirá a la página Grupos de instancias.
Crear un balanceador de carga
En esta sección se explican los pasos necesarios para crear un balanceador de carga global que dirija el tráfico HTTP a tu grupo de instancias.Este balanceador de carga usa un frontend para recibir el tráfico entrante y un backend para distribuir este tráfico a instancias en buen estado. Como el balanceador de carga está formado por varios componentes, esta tarea se divide en varias partes:
- Configuración de backend
- Configuración de frontend
- Revisar y finalizar
Completa todos los pasos para crear el balanceador de carga.
En la Google Cloud consola, ve a la página Crear un balanceador de carga.
En la sección Balanceador de carga de aplicación (HTTP/S), haz clic en Iniciar configuración.
En Orientado a Internet o solo de uso interno, selecciona De Internet a mis máquinas virtuales. A continuación, haz clic en Continuar.
En Name (Nombre) del balanceador de carga, introduce
espv2-load-balancer
.
Configuración de backend
- En el panel de la izquierda de la página Create global external Application Load Balancer (Crear balanceador de carga de aplicación externo global), haga clic en Backend configuration (Configuración de backend).
- Haz clic en Crear o seleccionar servicios de backend y segmentos de backend para abrir un menú desplegable. Haz clic en Servicios de backend y, a continuación, en Crear un servicio de backend.
- En la nueva ventana, en Nombre de la aplicación backend, introduce
espv2-backend
. - Define Grupo de instancias como
load-balancing-espv2-group
. - Define Port numbers (Transferir números) en
80
. Esto permite el tráfico HTTP entre el balanceador de carga y el grupo de instancias. - En Modo de equilibrio, selecciona Utilización.
- Haz clic en Hecho para crear el backend.
Crea la comprobación del estado del backend del balanceador de carga:
- En Comprobación del estado, selecciona Crear una comprobación del estado (o Crear otra comprobación del estado) en el menú desplegable. Se abrirá una ventana.
- En la nueva ventana, en Nombre, introduce
espv2-load-balancer-check
. - En Protocolo, selecciona HTTP.
- En Puerto, introduce
80
. - En este tutorial, defina la ruta de solicitud como
/healthz
, que es una ruta que ESPv2 está configurado para responder. Define los siguientes criterios de estado:
- Define Intervalo de comprobación en
3
segundos. Define el tiempo que transcurre desde el inicio de una comprobación hasta el inicio de la siguiente. - Define el tiempo de espera en
3
segundos. Define el tiempo que Google Cloud espera una respuesta a una petición de sondeo. Su valor debe ser inferior o igual al intervalo de comprobación. - Define el umbral correcto en
2
éxitos consecutivos. Define el número de comprobaciones secuenciales que deben completarse correctamente para que la instancia se considere en buen estado. - Define Umbral de estado incorrecto en
2
errores consecutivos. Define el número de sondeos secuenciales que deben fallar para que la instancia se considere en mal estado.
- Define Intervalo de comprobación en
Haga clic en Guardar y continuar para crear la comprobación del estado.
Haz clic en Crear para crear el servicio de backend.
Configuración de frontend
- En el panel de la izquierda de la página Crear balanceador de carga de aplicación externo global, haga clic en Configuración de frontend.
- En la página Configuración de frontend, en Nombre, introduce
espv2-ipv4-frontend
. - Define Protocol (Protocolo) como
HTTP
. - Asigna el valor
80
a Port. - Haga clic en Hecho para crear el frontend.
Revisar y finalizar
Verifica la configuración del balanceo de carga antes de crear el balanceador de carga:
- En el panel de la izquierda de la página Crear balanceador de carga de aplicaciones externo global, haz clic en Revisar y finalizar.
En la página Revisar y finalizar, compruebe los siguientes ajustes de Backend:
- El servicio de backend es
espv2-backend
. - El protocolo de punto final es
HTTP
. - La comprobación del estado es
espv2-load-balancer-check
. - El grupo de instancias es
load-balancing-espv2-group
.
- El servicio de backend es
En la misma página, comprueba que Frontend usa una dirección IP con el Protocol
HTTP
.
En el panel de la izquierda de la página Crear balanceador de carga de aplicación externo global, haz clic en Crear para terminar de crear el balanceador de carga.
Es posible que tengas que esperar unos minutos a que se cree el balanceador de carga.
Una vez creado el balanceador de carga, busca la dirección IP en la página Balanceador de carga.
Enviar una solicitud mediante una dirección IP
Una vez que la API de ejemplo y ESPv2 se estén ejecutando en el backend implementado, podrás enviar solicitudes a la API desde tu máquina local.
Crear una clave de API y definir una variable de entorno
El código de ejemplo requiere una clave de API. Para simplificar la solicitud, puedes definir una variable de entorno para la clave de API.
En el mismo Google Cloud proyecto 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 Google Cloud proyecto, consulta el artículo sobre cómo habilitar una API en tu Google Cloud proyecto.
- Haz clic en Crear credenciales y, a continuación, selecciona Clave de API.
- Copia la clave en el portapapeles.
- Haz clic en Cerrar.
- En tu ordenador local, pega la clave de API para asignarla a una variable de entorno:
- En Linux o macOS:
export ENDPOINTS_KEY=AIza...
- En Windows PowerShell:
$Env:ENDPOINTS_KEY="AIza..."
- En Linux o macOS:
Enviar la solicitud
Linux o macOS
Usa curl
para enviar una solicitud HTTP mediante la variable de entorno ENDPOINTS_KEY que has definido anteriormente. Sustituye IP_ADDRESS por la dirección IP externa de tu instancia.
curl --request POST \ --header "content-type:application/json" \ --data '{"message":"hello world"}' \ "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"
En los curl
anteriores:
- La opción
--data
especifica los datos que se van a enviar a la API. - La opción
--header
especifica que los datos están en formato JSON.
PowerShell
Usa Invoke-WebRequest
para enviar una solicitud HTTP mediante la variable de entorno ENDPOINTS_KEY
que has definido anteriormente. Sustituye IP_ADDRESS por la dirección IP externa de tu 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 una comilla inversa. Cuando pegues el ejemplo en PowerShell, asegúrate de que no haya ningún espacio después de las comillas inversas. Para obtener información sobre las opciones que se usan en la solicitud de ejemplo, consulta Invoke-WebRequest en la documentación de Microsoft.
Aplicación de terceros
Puedes usar una aplicación de terceros, como la extensión Postman del navegador Chrome, para enviar la solicitud:
- Selecciona
POST
como verbo HTTP. - En el encabezado, selecciona la clave
content-type
y el valorapplication/json
. - En el cuerpo, introduce 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 devuelve el mensaje que envías y responde con lo siguiente:
{
"message": "hello world"
}
Si no has recibido una respuesta correcta, consulta el artículo Solucionar problemas de errores de respuesta.
Acabas de desplegar y probar una API en Endpoints.
Configurar DNS para Endpoints
Como el nombre del servicio Endpoints de la API está en el dominio .endpoints.YOUR_PROJECT_ID.cloud.goog
, puedes usarlo como nombre de dominio completo (FQDN) haciendo un pequeño cambio de configuración en el archivo openapi.yaml
. De esta forma, puedes enviar solicitudes a la API de ejemplo mediante echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
en lugar de la dirección IP.
Para configurar el DNS de Endpoints, sigue estos pasos:
- Abre el archivo de configuración de OpenAPI,
openapi.yaml
, y añade la propiedadx-google-endpoints
en el nivel superior del archivo (sin sangría ni anidación), 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"
- En la propiedad
name
, sustituye YOUR_PROJECT_ID por el ID de tu proyecto. - En la propiedad
target
, sustituya IP_ADDRESS por la dirección IP que usó cuando envió una solicitud a la API de ejemplo. - Despliega el archivo de configuración de OpenAPI actualizado en Service Management:
gcloud endpoints services deploy openapi.yaml
Por ejemplo, supongamos que el archivo openapi.yaml
tiene la siguiente configuración:
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"
Cuando implementas el archivo openapi.yaml
con el comando gcloud
anterior, Service Management 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
. La nueva configuración de DNS puede tardar unos minutos en propagarse.
Configurar SSL
Para obtener más información sobre cómo configurar DNS y SSL, consulta Habilitar SSL para endpoints.
Enviar una solicitud mediante el FQDN
Ahora que has configurado el registro DNS de la API de ejemplo, envíale una solicitud mediante el FQDN (sustituye YOUR_PROJECT_ID por el ID de tu proyecto) y la variable de entorno ENDPOINTS_KEY que has definido anteriormente:- 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
Monitorizar la actividad de la API
Para monitorizar la actividad de la API, siga estos pasos:
- Consulta los gráficos de actividad de tu API en la página Endpoints > Services (Endpoints > Servicios).
Ir a la página Servicios de Endpoints
La solicitud puede tardar unos instantes en reflejarse en los gráficos. - Consulta los registros de solicitudes de tu API en la página Explorador de registros.