Descripción general

En este lab, implementarás la API de la aplicación de Quiz en Google Compute Engine y usarás Cloud Endpoints para proporcionar funcionalidad de supervisión.

Objetivos

En este lab, aprenderás a realizar las siguientes tareas:

• Crear una especificación de Open API desde la API de REST existente de la aplicación de Quiz
• Implementar la especificación como un extremo de la nube
• Aprovisionar una instancia de Compute Engine con el proxy de servicio extensible para alojar la API de Cloud Endpoints

Configuración y requisitos

En cada lab, recibirá un proyecto de Google Cloud y un conjunto de recursos nuevos por tiempo limitado y sin costo adicional.

1. Accede a Qwiklabs desde una ventana de incógnito.

2. Ten en cuenta el tiempo de acceso del lab (por ejemplo, 1:15:00) y asegúrate de finalizarlo en el plazo asignado.
   No existe una función de pausa. Si lo necesita, puede reiniciar el lab, pero deberá hacerlo desde el comienzo.

3. Cuando esté listo, haga clic en Comenzar lab.

4. Anote las credenciales del lab (el nombre de usuario y la contraseña). Las usarás para acceder a la consola de Google Cloud.

5. Haga clic en Abrir Google Console.

6. Haga clic en Usar otra cuenta, copie las credenciales para este lab y péguelas en el mensaje emergente que aparece.
   Si usa otras credenciales, se generarán errores o incurrirá en cargos.

7. Acepta las condiciones y omite la página de recursos de recuperación.

Activa Google Cloud Shell

Google Cloud Shell es una máquina virtual que cuenta con herramientas para desarrolladores. Ofrece un directorio principal persistente de 5 GB y se ejecuta en Google Cloud.

Google Cloud Shell proporciona acceso de línea de comandos a tus recursos de Google Cloud.

1. En la consola de Cloud, en la barra de herramientas superior derecha, haz clic en el botón Abrir Cloud Shell.

   

2. Haz clic en Continuar.

El aprovisionamiento y la conexión al entorno demorarán unos minutos. Cuando te conectes, habrás completado la autenticación, y el proyecto estará configurado con tu PROJECT_ID. Por ejemplo:

gcloud es la herramienta de línea de comandos de Google Cloud. Viene preinstalada en Cloud Shell y es compatible con el completado de línea de comando.

• Puedes solicitar el nombre de la cuenta activa con este comando:

gcloud auth list

Resultado:

Credentialed accounts: - @.com (active)

Resultado de ejemplo:

Credentialed accounts: - google1623327_student@qwiklabs.net

• Puedes solicitar el ID del proyecto con este comando:

gcloud config list project

Resultado:

[core] project =

Resultado de ejemplo:

[core] project = qwiklabs-gcp-44776a13dea667a6 Nota: La documentación completa de gcloud está disponible en la guía de descripción general de gcloud CLI .

Tarea 1. Prepara la aplicación del caso de éxito

En esta sección, accederás a Cloud Shell, clonarás el repositorio de Git que contiene la aplicación de Quiz, configurarás las variables de entorno y ejecutarás la aplicación.

Clona el código fuente en Cloud Shell

1. Para clonar el repositorio para la clase, ejecuta el siguiente comando:

git clone --depth=1 https://github.com/GoogleCloudPlatform/training-data-analyst

2. Crea un vínculo simbólico como un acceso directo al directorio de trabajo:

ln -s ~/training-data-analyst/courses/developingapps/v1.3/nodejs/cloudendpoints ~/cloudendpoints

Configura y ejecuta la aplicación del caso de éxito

1. Cambia al directorio que contenga los archivos de muestra de este lab:

cd ~/cloudendpoints/start

2. Para reemplazar la región predeterminada de un archivo por la región asignada por un lab, ejecuta los siguientes comandos:

export APP_REGION={{{project_0.startup_script.app_gcp_region | APP_REGION}}} export REGION={{{project_0.default_region | REGION}}} sed -i 's/us-central1/'"$REGION"'/g' prepare_environment.sh sed -i 's/us-central/'"$APP_REGION"'/g' prepare_environment.sh

3. Para configurar la aplicación de Quiz, ejecuta el siguiente comando:

. prepare_environment.sh

Si ves el mensaje Bind the role to service account? (Y/n)?, ingresa n.

Nota: Este archivo de secuencia de comandos hace lo siguiente:

• Crea una aplicación de App Engine.
• Crea la base de datos de Datastore.
• Exporta las variables de entorno GCLOUD_PROJECT y GCLOUD_BUCKET.
• Ejecuta npm install.
• Crea entidades en Cloud Datastore.
• Instala una herramienta de Open API generator, api2swagger.
• Imprime el ID del proyecto de Google Cloud.

Si ves ERROR: (gcloud.functions.deploy), vuelve a intentar el comando gcloud functions deploy completo que se ve luego de ejecutar cat ./prepare_environment.sh.

Puedes ejecutar gcloud functions list para verificar que la función se creó y que está disponible.

Nota: Las advertencias generadas por la instalación de Open API generator se pueden ignorar de forma segura en este lab.

3. Para ejecutar la aplicación web, usa el siguiente comando:

npm start

Ahora la aplicación se está ejecutando en Cloud Shell.

4. En Cloud Shell, haz clic en Vista previa en la Web > Vista previa en el puerto 8080 para obtener una vista previa de la aplicación de Quiz.
5. Modifica la URL agregando /api/quizzes/places al final del nombre de host. Reemplaza /?authuser=0 con /api/quizzes/places.

Nota: Deberías ver que se devuelven datos JSON de la API de la aplicación de Quiz que corresponden a las preguntas sobre lugares del cuestionario "places".

6. Toma nota de la URL de API completa para usarla más adelante en este lab y guarda la URL para poder pegarla en un comando de la siguiente sección.

Nota: la URL tendrá un aspecto similar al siguiente: https://8080-cs-***.cloudshell.dev/api/quizzes/places

Haz clic en Revisar mi progreso para verificar el objetivo.

Configurar y ejecutar la aplicación del caso de éxito

Tarea 2. Genera una especificación de Open API

En esta sección, generarás una especificación de Open API que formará la base para implementar tu extremo de nube.

Crea una especificación de Open API

1. Abre una segunda ventana de Cloud Shell.

2. Haz clic en el signo más para abrir una nueva pestaña en la terminal.

3. Para cambiar el directorio de la carpeta de trabajo de Cloud Endpoints usa el comando siguiente:

cd ~/cloudendpoints/start/endpoint

4. Actualiza la variable de entorno PATH con el objetivo de establecer la ruta de acceso para el comando api2swagger:

export PATH=$PATH:`npm root -g`/api2swagger/bin

5. Para instalar el paquete de Python api2swagger, usa el siguiente comando:

npm install -g api2swagger

6. Para generar la especificación de Open API, ejecuta el comando siguiente, reemplazando [API_URL_FROM_CLIPBOARD] por la URL de API guardada del paso anterior del formulario https://8080-cs-.../api/quizzes/places:

api2swagger -e [API_URL_FROM_CLIPBOARD] -o ./quiz-api.json Nota: La herramientaapi2swagger realizará la solicitud a la API y mostrará una serie de instrucciones. Si no completas el reemplazo adecuado, se mostrará el error Nombre de host no válido.

6. Ingresa las respuestas a las instrucciones de api2swagger con la siguiente tabla:

Instrucción	Respuesta
¿Título de Swagger Spec?	API de Quite Interesting Quiz
¿Descripción de Swagger Spec?	Una API para Quite Interesting Quiz
URL de las Condiciones del Servicio	(Presiona la tecla Intro)
¿Versión de tu programa API?	(Presiona la tecla Intro)
¿Nombre de contacto?	(Presiona la tecla Intro)
¿URL de contacto?	(Presiona la tecla Intro)
¿Correo electrónico de contacto?	(Presiona la tecla Intro)
¿Nombre de la licencia?	(Presiona la tecla Intro)
¿URL de la licencia?	(Presiona la tecla Intro)
¿Tu API admite http?	Y
¿Elegir Ruta base de tu API?	Usa las flechas hacia arriba y hacia abajo para elegir: ❯ /api/quizzes (Presiona la tecla Intro)
¿Explicación detallada del comportamiento de la operación?	Obtiene preguntas de un cuestionario
¿Breve resumen de lo que hace la operación?	Obtén preguntas de cuestionario
¿Documentación externa adicional para esta operación?	(Presiona la tecla Intro)
¿Cadena única para identificar la operación?	getQuizQuestions
¿Lista de etiquetas para el control de la documentación de la API?	(Presiona la tecla Intro)
¿La ruta de acceso a la API tiene algún parámetro dinámico?	Y (Presiona la tecla Intro)
¿Elige parámetros dinámicos en la URL?	Usa las flechas hacia arriba y hacia abajo para moverte a: ❯◉ places Luego presiona la barra espaciadora para elegir lugares y, luego, Intro
¿Nombre del parámetro URL?	quizName
¿Descripción del parámetro URL?	El nombre del cuestionario
¿Tipo del parámetro de la consulta?	Usa las flechas hacia arriba y hacia abajo para elegir: ❯ cadena (Presiona la tecla Intro)

Nota: La herramienta api2swagger mostrará el resultado de la especificación de Open API.

Edita la especificación de Open API

1. En Cloud Shell, haz clic en Abrir editor.

Quizás debas hacer clic en Abrir en una ventana nueva si el bloqueo de cookies de terceros está habilitado.

2. Navega a cloudendpoints/start/endpoint.
3. En el Editor de código de Cloud Shell, abre quiz-api.json.
4. Reemplaza el valor de la clave “host” por un nombre de host con una cadena de forma quiz-api.endpoints.[Project-ID].cloud.goog.

Nota: En el siguiente ejemplo se muestra la modificación en la línea host.

Asegúrate de reemplazar [GCP-Project-ID] con tu ID del proyecto de Google Cloud.

El ID del proyecto de Google Cloud se puede encontrar en el panel izquierdo de las instrucciones de lab debajo de tus credenciales.

endpoint/quiz-api.json

{ "swagger": "2.0", "host": "quiz-api.endpoints.qwiklabs-gcp-XX-XXXX.cloud.goog", "schemes": [ "https", "http" ], Nota: Cuando implementes tu especificación de Open API en la siguiente sección, la API de Service Management usará el valor host de tu archivo de configuración de implementación para crear un servicio de Cloud Endpoints nuevo con el nombre quiz-api.endpoints.[PROJECT-ID].cloud.goog (si no existe) y luego configurará el servicio según tu archivo de configuración de OpenAPI.

Cloud Endpoints usa nombres compatibles con DNS para identificar servicios de manera inequívoca. Debido a que se garantiza que los proyectos en Google Cloud tengan un nombre global único, puedes usar el nombre de tu proyecto para crear un nombre de servicio de API único. También puedes asignar tu propio nombre de DNS a tu API.

5. Guarda el archivo.

Implementa la especificación de API en Cloud Endpoints

1. Haz clic en Abrir terminal para volver a Cloud Shell.

2. Para implementar la especificación de Open API como un extremo de la nube, ejecuta el siguiente comando en la ventana de Cloud Shell:

gcloud endpoints services deploy quiz-api.json

Si ves un error como el siguiente: PERMISSION_DENIED: Ownership for domain name, asegúrate de que tu host en el archivo quiz-api.json coincida con el formato sugerido, incluido tu ID del proyecto correcto.

Nota: La definición de service toma unos minutos en implementarse. Verás una advertencia sobre que la API está disponible para todos los clientes sin proporcionar una clave.

3. Para ver el nombre de configuración de Open API, ejecuta el siguiente comando:

gcloud endpoints configs list --service="quiz-api.endpoints.$GOOGLE_CLOUD_PROJECT.cloud.goog"

Observa que se insertó el ID del proyecto. Puedes copiar el service del resultado de tu comando deploy.

Nota: Se devolverá la configuración del servicio, incluido CONFIG_ID y SERVICE_NAME. Necesitarás ambos valores en la próxima sección.

Tarea 3: Implementa el backend de la API

En esta sección, aprovisionarás una instancia de Compute Engine para que ejecute la implementación de API y el proxy de servicio extensible de Cloud Endpoints.

Crea una instancia de Compute Engine

1. En el menú de navegación de la consola de Cloud (☰), haz clic en Compute Engine > Instancias de VM.
2. Para crear una instancia nueva, haz clic en Crear instancia.
3. En la página Configuración de la máquina, ingresa los valores para los siguientes campos:

Campo	Valor
Nombre	endpoint-host
Región
Zona
Serie	E2
Tipo de máquina > Con núcleo compartido	e2-small

4. Haz clic en SO y almacenamiento.

   Haz clic en Cambiar para comenzar a configurar el disco de arranque y selecciona los siguientes valores:

   • Sistema operativo: Debian
   • Versión: Debian GNU/Linux 11 (bullseye)

5. Haz clic en Herramientas de redes.

6. En Firewall, haz clic en Permitir tráfico HTTP.

7. Haz clic en Seguridad.

8. En Permisos de acceso, haz clic en Permitir el acceso total a todas las APIs de Cloud.

9. Haz clic en Configuración avanzada.

10. En Metadatos, haz clic en + Agregar elemento dos veces.

11. Ingresa los siguientes valores de metadatos:

endpoints-service-config-id	Usa CONFIG_ID para el extremo con el formato: yyyy-mm-ddr0
endpoints-service-name	Usa el valor SERVICE_NAME para el extremo con el formato: quiz-api.endpoints.<Project-ID>.cloud.goog

12. Haz clic en Crear.

Espera que se complete el aprovisionamiento de la VM.

Nota: La instancia de Compute Engine tardará alrededor de 20 segundos para aprovisionar con Debian.

Instala y ejecuta el backend de API

1. Regresa a la ventana de Cloud Shell.
2. Para asegurarte de que el directorio de trabajo está configurado en la carpeta endpoint, ejecuta el siguiente comando:

cd ~/cloudendpoints/start/endpoint/

3. Para copiar los archivos de origen de la aplicación desde Cloud Shell a endpoint-host, ejecuta el siguiente comando:

gcloud compute scp ./quiz-api endpoint-host:~/ --recurse --zone={{{project_0.default_zone | ZONE}}} Nota: Es posible que se te solicite crear una clave SSH. Puedes presionar la tecla INTRO para cada instrucción, incluida la Y para crear el directorio .ssh.

Copiar los archivos puede tomar algunos segundos.

4. Regresa a la consola de Google Cloud.
5. En la página de Compute Engine, haz clic en SSH para conectarte a la máquina virtual endpoint-host.

Nota: Quizá tengas que hacer clic dos veces si usas un bloqueador de ventanas emergentes. Tomará algunos segundos establecer la conexión SSH.

6. En la ventana SSH endpoint-host, instala los requisitos previos del software:

sudo apt-get install ca-certificates curl gnupg -y sudo mkdir -p /etc/apt/keyrings curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg NODE_MAJOR=20 echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list sudo apt-get update sudo apt-get install nodejs -y

Haz clic en Revisar mi progreso para verificar el objetivo.

Crear una instancia de Compute Engine y, además, instalar los requisitos previos del software

7. Para ejecutar la API de la aplicación Quiz, ejecuta los siguientes comandos en la sesión de SSH:

export GCLOUD_PROJECT="$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/project/project-id)" export GCLOUD_BUCKET=$GCLOUD_PROJECT-media export PORT=8081 cd ~/quiz-api npm install npm start

8. Regresa a la consola de Google Cloud, que aún debería mostrar la lista de instancias de VM de Compute Engine.
9. Establece una segunda conexión SSHa endpoint-host.
10. En la segunda ventana SSH endpoint-host, para instalar el proxy de servicio extensible de Cloud Endpoints debes ejecutar los siguientes comandos:

export CLOUD_ENDPOINTS_REPO="google-cloud-endpoints-jessie" echo "deb http://packages.cloud.google.com/apt $CLOUD_ENDPOINTS_REPO main" | sudo tee /etc/apt/sources.list.d/google-cloud-endpoints.list curl --silent https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add - sudo apt-get update && sudo apt-get install endpoints-runtime

11. En la segunda ventana de SSH endpoint-host, ejecuta el siguiente comando para editar el archivo de configuración nginx:

sudo nano /etc/default/nginx

12. Para modificar el archivo, agrega la siguiente declaración luego de la configuración existente:

PORT=80

13. Guarda el archivo (presiona Ctrl+O y, luego, Intro).
14. Sal de nano (presiona Ctrl+X).
15. Para reiniciar nginx, ejecuta el siguiente comando:

sudo service nginx restart

Tarea 4: Prueba y modifica Cloud Endpoint

En esta sección, verificarás la implementación del extremo y modificarás la configuración para permitir la entrega con un nombre de host en vez de una dirección IP.

Invoca el extremo de la nube con la dirección IP

1. Regresa a la consola de Cloud Platform > Compute Engine.
2. Para iniciar una ventana del navegador, haz clic en la dirección IP externa de la máquina virtual endpoint-host.

Nota: Un mensaje de JSON que informa Este método no existe aparecerá en la ventana nueva del navegador. Este es un comportamiento esperado, ya que no asociaste un método con “/”. No hace falta tomar una medida correctiva.

3. Agrega /api/quizzes/places al final de la URL.

Nota: Deberías ver que se muestran datos JSON de la API de quiz.

4. En el Menú de navegación de la consola de Google Cloud, haz clic en Extremos y después haz clic en tu extremo implementado.

Nota: Deberías ver una página de supervisión para el extremo de la API de Quiz. Luego de unos minutos, deberías ver la solicitud que le hiciste al extremo.

Modifica y vuelve a implementar la configuración del extremo de la nube

1. Regresa al editor de código Cloud Shell y elige el archivo quiz-api.json.
2. Para permitir que se acceda a la API con el nombre de host Cloud Endpoint en vez de la dirección IP, agrega la clave y valor “x-google-endpoints” que se muestra en el siguiente fragmento del archivo.

endpoint/quiz-api.json

{ "swagger": "2.0", "host": "quiz-api.endpoints.<Project-ID>.cloud.goog", "x-google-endpoints": [ { "name": "quiz-api.endpoints.<Project-ID>.cloud.goog", "target": "<endpoint-host-EXTERNAL-IP-ADDRESS>" } ], "schemes": [ "https", "http" ],

3. Cambia los valores de <Project-ID> y <endpoint-host-EXTERNAL-IP-ADDRESS> y luego guarda el archivo.

La configuración actualizada debe ser similar a esta:

{ "swagger": "2.0", "host": "quiz-api.endpoints.qwiklabs-gcp-04-a7b3469e256f.cloud.goog", "x-google-endpoints": [ { "name": "quiz-api.endpoints.qwiklabs-gcp-04-a7b3469e256f.cloud.goog", "target": "34.172.61.246" } ], "schemes": [ "https", "http" ],

4. Para volver a implementar la API, regresa a la ventana de Cloud Shell y ejecuta el siguiente comando:

gcloud endpoints services deploy quiz-api.json

5. Abre una pestaña del navegador nueva y navega a http://quiz-api.endpoints.<Project-ID>.cloud.goog/api/quizzes/gcp.

Nota: Deberías ver datos JSON del cuestionario de Google Cloud.

Tarea 5. Supervisa la API

En esta sección revisarás los resultados de supervisión de tu API.

Examina la API en la consola

1. Regresa a la consola de Google Cloud. En el Menú de navegación, haz clic en Extremos y, luego, en tu extremo implementado.

Nota: Deberías ver una página de resumen en la API de Quiz.

2. Tómate unos minutos para revisar los gráficos de solicitudes, latencia y errores.

Nota: Deberías ver que los gráficos de supervisión te permiten observar el rendimiento de tu API mientras ejecuta solicitudes de los clientes.

Finalice su lab

Cuando haya completado el lab, haga clic en Finalizar lab. Google Cloud Skills Boost quitará los recursos que usó y limpiará la cuenta.

Tendrá la oportunidad de calificar su experiencia en el lab. Seleccione la cantidad de estrellas que corresponda, ingrese un comentario y haga clic en Enviar.

La cantidad de estrellas indica lo siguiente:

• 1 estrella = Muy insatisfecho
• 2 estrellas = Insatisfecho
• 3 estrellas = Neutral
• 4 estrellas = Satisfecho
• 5 estrellas = Muy satisfecho

Puede cerrar el cuadro de diálogo si no desea proporcionar comentarios.

Para enviar comentarios, sugerencias o correcciones, use la pestaña Asistencia.

Copyright 2024 Google LLC. Todos los derechos reservados. Google y el logotipo de Google son marcas de Google LLC. El resto de los nombres de productos y empresas pueden ser marcas de las respectivas empresas a las que están asociados.