Implementa automáticamente una aplicación web de Python de IA generativa desde el control de versión a Cloud Run

1. Descripción general

Implementar una aplicación web por primera vez puede ser intimidante. Incluso después de la primera implementación, si el proceso es demasiado laborioso, es posible que evites implementar versiones nuevas de tu aplicación. Con la implementación continua, puedes implementar automáticamente los cambios de tu aplicación con facilidad.

En este lab, escribirás una aplicación web y configurarás Cloud Run para que implemente automáticamente tu aplicación cuando se realice un cambio en el código fuente de la aplicación. Luego, modifica tu aplicación y vuelve a implementarla.

Qué aprenderás

  • Escribe una aplicación web con el editor de Cloud Shell
  • Almacena el código de tu aplicación en GitHub
  • Implementa tu aplicación automáticamente en Cloud Run
  • Agrega IA generativa a tu aplicación con Vertex AI

2. Requisitos previos

  1. Si aún no tienes una Cuenta de Google, debes crear una.
    • Usar una cuenta personal en lugar de una cuenta laboral o educativa Es posible que las cuentas laborales y educativas tengan restricciones que te impidan habilitar las APIs necesarias para este lab.
  2. Si aún no tienes una cuenta de GitHub, debes crear una.

3. Configura el proyecto

  1. Accede a la consola de Google Cloud.
  2. Habilita la facturación en la consola de Cloud.
    • Completar este lab debería costar menos de USD 1 en recursos de Cloud.
    • Puedes seguir los pasos al final de este lab para borrar recursos y evitar cargos adicionales.
    • Los usuarios nuevos pueden acceder a la prueba gratuita de USD 300.
    • ¿Asistirás a un evento de IA generativa para desarrolladores? Es posible que haya disponible un crédito de USD 1.
  3. Crea un proyecto nuevo o elige reutilizar uno existente.
  4. Confirma que la facturación esté habilitada en Mis proyectos en la Facturación de Cloud.
    • Si tu proyecto nuevo dice Billing is disabled en la columna Billing account, haz lo siguiente:
      1. Haz clic en los tres puntos de la columna Actions.
      2. Haz clic en Cambiar la facturación.
      3. Selecciona la cuenta de facturación que deseas usar
    • Si asistes a un evento de IA generativa para desarrolladores, es probable que la cuenta se llame Cuenta de facturación de prueba de Google Cloud Platform.

4. Abre el editor de Cloud Shell

  1. Navega al Editor de Cloud Shell.
  2. Si la terminal no aparece en la parte inferior de la pantalla, ábrela:
    • Haz clic en el menú de hamburguesa Ícono de menú de hamburguesa.
    • Haz clic en Terminal.
    • Haz clic en Terminal nueva. Abre una terminal nueva en el editor de Cloud Shell
  3. En la terminal, configura tu proyecto con este comando:
    • Formato:
      gcloud config set project [PROJECT_ID]
    • Ejemplo:
      gcloud config set project lab-project-id-example
    • Si no recuerdas el ID de tu proyecto, haz lo siguiente:
      • Puedes enumerar todos los IDs de tus proyectos con el siguiente comando:
        gcloud projects list | awk '/PROJECT_ID/{print $2}'
      Establece el ID del proyecto en la terminal del editor de Cloud Shell
  4. Si se te solicita autorización, haz clic en Autorizar para continuar. Haz clic para autorizar Cloud Shell
  5. Deberías ver el siguiente mensaje:
    Updated property [core/project].
    Si ves un WARNING y se te pregunta Do you want to continue (Y/N)?, es probable que hayas ingresado el ID del proyecto de forma incorrecta. Presiona N, presiona Enter y vuelve a intentar ejecutar el comando gcloud config set project.

5. Habilita las APIs

En la terminal, habilita las APIs:

gcloud services enable \
  run.googleapis.com \
  cloudbuild.googleapis.com \
  aiplatform.googleapis.com

Este comando puede tardar unos minutos en completarse, pero, finalmente, debería producir un mensaje de éxito similar a este:

Operation "operations/acf.p2-73d90d00-47ee-447a-b600" finished successfully.

6. Configurar Git

  1. Configura tu correo electrónico de usuario global de Git:
    git config --global user.email "you@example.com"
  2. Configura tu nombre de usuario global de Git:
    git config --global user.name "Your Name"
  3. Configura tu rama predeterminada global de Git en main:
    git config --global init.defaultBranch main

7. Escribe el código

Para escribir una aplicación en Python, haz lo siguiente:

  1. Navega al directorio principal:
    cd ~
  2. Crea el directorio codelab-genai.
    mkdir codelab-genai
  3. Navega al directorio codelab-genai:
    cd codelab-genai
  4. Crea un archivo main.py:
    touch main.py
  5. Crea el archivo requirements.txt con la lista de dependencias:
    cat > requirements.txt << EOF
Flask==3.0.0
gunicorn==20.1.0
EOF
  6. Abre el archivo main.py en el editor de Cloud Shell:
    cloudshell edit main.py
    Ahora debería aparecer un archivo vacío en la parte superior de la pantalla. Aquí puedes editar este archivo main.py. Mostrar que el código va en la sección superior de la pantalla
  7. Copia el siguiente código y pégalo en el archivo main.py abierto:
    import os

from flask import Flask

app = Flask(__name__)

@app.route("/")
def hello_world():
    return f"Hello world!"


if __name__ == "__main__":
    app.run(debug=True, host="0.0.0.0", port=int(os.environ.get("PORT", 8080)))
    Después de unos segundos, el editor de Cloud Shell guardará tu código automáticamente. Este código responde a las solicitudes HTTP con nuestro saludo “Hello world!”.

El código inicial de tu aplicación está terminado y listo para almacenarse en el control de versión.

8. Crea un repositorio

  1. Regresa a la terminal de Cloud Shell en la parte inferior de la pantalla.
  2. Asegúrate de seguir en el directorio correcto:
    cd ~/codelab-genai
  3. Inicializa tu repositorio de Git
    git init -b main
  4. Accede a la CLI de GitHub.
    gh auth login
    Presiona Enter para aceptar las opciones predeterminadas y sigue las instrucciones en la herramienta de la CLI de GitHub, incluidas las siguientes:
    1. ¿A qué cuenta quieres acceder? GitHub.com
    2. ¿Cuál es tu protocolo preferido para las operaciones de Git en este host? HTTPS
    3. ¿Quieres autenticar Git con tus credenciales de GitHub? Y (omite este paso si no aparece).
    4. ¿Cómo deseas autenticar la CLI de GitHub? Login with a web browser
    5. Copia tu código de un solo uso
    6. Abre https://github.com/login/device.
    7. Pega tu código de uso único
    8. Haz clic en Autorizar GitHub.
    9. Completa tu acceso
  5. Confirma que accediste a tu cuenta:
    gh api user -q ".login"
    Si accediste correctamente, se mostrará tu nombre de usuario de GitHub.
  6. Crea una variable de GITHUB_USERNAME
    GITHUB_USERNAME=$(gh api user -q ".login")
  7. Confirma que creaste la variable de entorno:
    echo ${GITHUB_USERNAME}
    Si creaste la variable correctamente, debería mostrarse tu nombre de usuario de GitHub.
  8. Crea un repositorio de GitHub vacío llamado codelab-genai:
    gh repo create codelab-genai --private
    Si recibes el siguiente error, haz lo siguiente:
    GraphQL: Name already exists on this account (createRepository)
    Entonces, ya tienes un repositorio llamado codelab-genai. Tienes dos opciones para seguir este instructivo:
  9. Agrega el repositorio codelab-genai como el origin remoto:
    git remote add origin https://github.com/${GITHUB_USERNAME}/codelab-genai

9. Comparte tu código

  1. Confirma que estás en el directorio correcto:
    cd ~/codelab-genai
  2. Agrega todos los archivos del directorio actual a esta confirmación:
    git add .
  3. Crea la primera confirmación:
    git commit -m "add http server"
  4. Envía tu confirmación a la rama main del repositorio origin:
    git push -u origin main

Puedes ejecutar este comando y visitar la URL resultante para ver el código de tu aplicación en GitHub:

echo -e "\n\nTo see your code, visit this URL:\n \
    https://github.com/${GITHUB_USERNAME}/codelab-genai/blob/main/main.py \n\n"

10. Configura implementaciones automáticas

  1. Deja abierta la pestaña del editor de Cloud Shell. Volveremos a esta pestaña más adelante.
  2. En una pestaña nueva, visita la página de Cloud Run.
  3. Selecciona el proyecto de Google Cloud correcto en la consola Menú desplegable del proyecto de la consola de Google Cloud.
  4. Haz clic en CONNECT REPO.
  5. Haz clic en CONFIGURAR CON CLOUD BUILD.
    1. Selecciona GitHub como Proveedor de repositorio.
      • Si no accediste a tu cuenta de GitHub en el navegador, hazlo con tus credenciales.
    2. Haz clic en Autenticar y, luego, en Continuar.
    3. Después de acceder, verás un mensaje en la página de Cloud Run que indica La app de GitHub no está instalada en ninguno de tus repositorios.
    4. Haz clic en el botón INSTALAR GOOGLE CLOUD BUILD.
      • En la página de configuración de la instalación, selecciona Only select repositories y elige el repositorio codelab-genai que creaste a través de la CLI.
      • Haz clic en Instalar.
      • Nota: Si tienes muchos repositorios de GitHub, la carga puede tardar unos minutos.
    5. Selecciona your-user-name/codelab-genai como el repositorio
        .
      • Si el repositorio no está presente, haz clic en el vínculo Administrar repositorios conectados.
    6. Deja Rama como ^main$.
    7. Haz clic en Go, Node.js, Python, Java, .NET Core, Ruby o PHP a través de los buildpacks de Google Cloud.
      • Deja los otros campos (Build context directory, Entrypoint y Function target) como están.
    8. Haga clic en Guardar.
  6. Desplázate hacia abajo hasta Authentication.
  7. Haz clic en Permitir invocaciones sin autenticar.
  8. Haz clic en CREAR.

Una vez que finalice la compilación (lo que tardará varios minutos), ejecuta este comando y visita la URL resultante para ver tu aplicación en ejecución:

echo -e "\n\nOnce the build finishes, visit your live application:\n \
    "$( \
        gcloud run services list | \
        grep codelab-genai | \
        awk '/URL/{print $2}' | \
        head -1 \
    )" \n\n"

11. Cómo cambiar tu código

Regresa al editor de Cloud Shell.

Si aún tienes abierto el editor de Cloud Shell, puedes omitir estos pasos.

  1. Navega al Editor de Cloud Shell.
  2. Si la terminal no aparece en la parte inferior de la pantalla, ábrela:
    • Haz clic en el menú de hamburguesa Ícono de menú de hamburguesa.
    • Haz clic en Terminal.
    • Haz clic en Terminal nueva. Abre una terminal nueva en el editor de Cloud Shell
  3. En la terminal, configura tu proyecto con este comando:
    • Formato:
      gcloud config set project [PROJECT_ID]
    • Ejemplo:
      gcloud config set project lab-project-id-example
    • Si no recuerdas el ID de tu proyecto, haz lo siguiente:
      • Puedes enumerar todos los IDs de tus proyectos con el siguiente comando:
        gcloud projects list | awk '/PROJECT_ID/{print $2}'
      Establece el ID del proyecto en la terminal del editor de Cloud Shell
  4. Si se te solicita autorización, haz clic en Autorizar para continuar. Haz clic para autorizar Cloud Shell
  5. Deberías ver el siguiente mensaje:
    Updated property [core/project].
    Si ves un WARNING y se te pregunta Do you want to continue (Y/N)?, es probable que hayas ingresado el ID del proyecto de forma incorrecta. Presiona N, presiona Enter y vuelve a intentar ejecutar el comando gcloud config set project.

Agrega Vertex AI a tu aplicación

  1. Regresa a la terminal de Cloud Shell en la parte inferior de la pantalla.
  2. Asegúrate de seguir en el directorio correcto:
    cd ~/codelab-genai
  3. Agrega la dependencia del SDK de Vertex AI a las dependencias existentes:
    sed -i -e '$agoogle-cloud-aiplatform==1.59.0' requirements.txt
  4. Agrega la biblioteca de autenticación de Google a las dependencias existentes:
    sed -i -e '$agoogle-auth==2.32.0' requirements.txt
  5. Vuelve a abrir main.py en el editor de Cloud Shell
    cloudshell edit main.py
  6. Reemplaza el código de tu archivo main.py por lo siguiente:
    import os

from flask import Flask, request

import google.auth
import vertexai
from vertexai.generative_models import GenerativeModel

_, project = google.auth.default()

app = Flask(__name__)

@app.route("/")
def hello_world():
    vertexai.init(project=project, location="us-central1")
    model = GenerativeModel("gemini-1.5-flash")
    animal = request.args.get("animal", "dog") 
    prompt = f"Give me 10 fun facts about {animal}. Return this as html without backticks."
    response = model.generate_content(prompt)
    return response.text

if __name__ == "__main__":
    app.run(debug=True, host="0.0.0.0", port=int(os.environ.get("PORT", 8080)))

12. Volver a implementar

  1. Asegúrate de que aún te encuentres en el directorio correcto en Cloud Shell:
    cd ~/codelab-genai
  2. Ejecuta estos comandos para confirmar una nueva versión de tu aplicación en tu repositorio local de Git:
    git add .
git commit -m "add latest changes"
  3. Envía los cambios a GitHub:
    git push
  4. Cuando finalice la compilación, ejecuta este comando y visita la aplicación implementada:
    echo -e "\n\nOnce the build finishes, visit your live application:\n \
    "$( \
        gcloud run services list | \
        grep codelab-genai | \
        awk '/URL/{print $2}' | \
        head -1 \
    )" \n\n"

Es posible que la compilación tarde varios minutos en finalizar antes de que puedas ver los cambios.

Puedes ver el historial de todas las revisiones aquí: https://console.cloud.google.com/run/detail/us-central1/codelab-genai/revisions

13. (Opcional) Audita tu uso de Vertex AI

Al igual que con otros servicios de Google Cloud, puedes auditar las operaciones de Vertex AI. Los registros de auditoría te ayudan a responder las preguntas “¿Quién hizo qué, dónde y cuándo?”. Los registros de auditoría administrativos de Vertex AI están habilitados de forma predeterminada. Para auditar las solicitudes de generación de contenido, debes habilitar los registros de auditoría de acceso a los datos:

  1. En la consola de Google Cloud, ve a la página Registros de auditoría:

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es IAM y administración.
  2. Asegúrate de que el proyecto de Google Cloud existente sea aquel en el que crearás tu aplicación de Cloud Run.
  3. En la tabla Configuración de los registros de auditoría de acceso a los datos, busca y selecciona Vertex AI API en la columna Servicio.
  4. En la pestaña Tipos de registro, selecciona los tipos de registros de auditoría de acceso a los datos Admin read y Data read.
  5. Haz clic en Guardar.

Después de habilitarlo, podrás ver los registros de auditoría de cada invocación de la aplicación. Para ver los registros de auditoría con detalles de invocación, haz lo siguiente:

  1. Regresa a tu aplicación implementada y actualiza la página para activar el registro.
  2. En la consola de Google Cloud, ve a la página Explorador de registros:

  3. En la ventana de consultas, escribe lo siguiente:
    LOG_ID("cloudaudit.googleapis.com%2Fdata_access")
protoPayload.serviceName="aiplatform.googleapis.com"
  4. Haz clic en Ejecutar consulta.

Los registros de auditoría capturan el uso de la API de Vertex AI, pero no te permiten observar datos relacionados con la carga de trabajo, como instrucciones o detalles de respuestas.

14. (Opcional) Aumenta la observabilidad de tu carga de trabajo de IA

Los registros de auditoría no capturan información relacionada con la carga de trabajo. Para aumentar la observabilidad de tus cargas de trabajo, debes registrar esta información de forma explícita. Para ello, puedes usar tu framework de registro favorito. En los siguientes pasos, se muestra cómo hacerlo con el mecanismo de registro nativo de Node.js.

  1. Vuelve a abrir main.py en el editor de Cloud Shell
    cloudshell edit ~/codelab-genai/main.py
  2. Después de la línea import os (línea 1), agrega las siguientes líneas:
    import sys, json, logging

class JsonFormatter(logging.Formatter):
    def format(self, record):
        json_log_object = {
            "severity": record.levelname,
            "message": record.getMessage(),
        }
        json_log_object.update(getattr(record, "json_fields", {}))
        return json.dumps(json_log_object)
logger = logging.getLogger(__name__)
sh = logging.StreamHandler(sys.stdout)
sh.setFormatter(JsonFormatter())
logger.addHandler(sh)
logger.setLevel(logging.DEBUG)
    Estas líneas cambian el formato predeterminado de los registros de Python para que sigan el formato estructurado de JSON que se puede transferir a Google Cloud.
  3. Después de la línea que llama a model.generate_content(prompt) (línea 34), agrega las siguientes líneas:
        json_fields = {"prompt": prompt, "response": response.to_dict()}
    logger.debug("Content is generated", extra={"json_fields": json_fields})
    Este código imprime la información estructurada sobre la generación de contenido en stdout, donde el agente de registro la lee y la transfiere a Cloud Logging.
  4. Vuelve a abrir Cloud Shell y escribe el siguiente comando para asegurarte de que estás en el directorio correcto:
    cd ~/codelab-genai
  5. Confirma los cambios:
    git commit -am "observe generated content"
  6. Envía los cambios a GitHub para activar la reimplementación de la versión modificada:
    git push

Después de implementar la nueva versión, puedes observar la información de depuración sobre las llamadas a Vertex AI.

Para ver los registros de tu aplicación, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página Explorador de registros:

  2. En la ventana de consultas, escribe lo siguiente:
    LOG_ID("run.googleapis.com%2Fstdout")
severity=DEBUG
  3. Haz clic en Ejecutar consulta.

El resultado de la búsqueda muestra registros con la instrucción y la respuesta de Vertex AI, incluidas las “calificaciones de seguridad” que se pueden usar para supervisar las prácticas de seguridad.

15. (Opcional) Limpieza

Si bien Cloud Run no cobra cuando el servicio no se usa, es posible que se te cobre por el almacenamiento de la imagen de contenedor en Artifact Registry. Puedes borrar tu proyecto de Cloud para evitar que se generen cargos. Si borras tu proyecto de Cloud, se dejan de facturar todos los recursos que usaste en ese proyecto.

Si quieres, borra el proyecto:

gcloud projects delete $GOOGLE_CLOUD_PROJECT

También puedes borrar los recursos innecesarios de tu disco de Cloud Shell. Puedes hacer lo siguiente:

  1. Borra el directorio del proyecto del codelab: 
    rm -rf ~/codelab-genai
  2. Advertencia. Esta acción no se puede deshacer. Si quieres borrar todo el contenido de Cloud Shell para liberar espacio, puedes borrar todo tu directorio principal. Ten cuidado de guardar en otro lugar todo lo que quieras conservar. 
    sudo rm -rf $HOME

16. Felicitaciones

En este lab, escribiste una aplicación web y configuraste Cloud Run para implementar automáticamente tu aplicación cuando se realizaba un cambio en el código fuente de la aplicación. Luego, modificaste tu aplicación y la volviste a implementar.

Si disfrutaste este lab, puedes volver a intentarlo en otro lenguaje de programación o framework: