Depure una aplicación de Kubernetes en Cloud Code para Cloud Shell

Cloud Code te permite depurar con facilidad una aplicación implementada en un clúster de Kubernetes mediante skaffold debug. Puedes depurar tu aplicación en un clúster local (como Minikube o Docker Desktop), Google Kubernetes Engine (GKE) o cualquier otro proveedor de servicios en la nube.

No es necesario completar la configuración manual, como la redirección de puertos o la inserción de argumentos de depuración específicos del lenguaje. Solo necesitas una aplicación de Kubernetes lista para usar en Cloud Code que incluya un archivo de configuración skaffold.yaml y una configuración de inicio cloudcode.kubernetes.

Depurar una aplicación

  1. Haz clic en Barra de estado de Cloud Code Cloud Code en la barra de estado y, luego, selecciona Debug on Kubernetes (Depurar en Kubernetes).
  2. Si tu aplicación no tiene la configuración de Skaffold necesaria o la configuración de inicio de cloudcode.kubernetes, Cloud Code te ayudará a configurarlos.
  3. Confirma si deseas usar el contexto de Kubernetes actual para ejecutar la app (o cambia a una que prefieras).
  4. Si eliges un clúster remoto como contexto, cuando se te solicite, elige un registro de imágenes para enviar las imágenes. Si usas Container Registry, puedes navegar a un registro existente o especificar el nombre de un registro que se creará. Si tu proyecto tiene la API de Artifact Registry habilitada y al menos un repositorio de Artifact Registry, puedes explorar y seleccionar un repositorio de Artifact Registry existente.

    En los siguientes ejemplos, se muestra cómo especificar dónde se almacenan las imágenes de contenedor para algunos registros comunes:

    Container Registry gcr.io/{project_id}
    Docker Hub docker.io/{account}
    Asegúrate de estar autenticado de forma adecuada si usas un repositorio privado de Docker Hub.

    Para generar el nombre final del repositorio de imágenes, Cloud Code concatena este registro de imágenes con el nombre de imagen especificado en los manifiestos de Kubernetes. Esta opción se almacena en la configuración de inicio de cloudcode.kubernetes (que se encuentra en .vscode/launch.json).

    Para obtener más información, consulta la guía de control del registro de imágenes.

    A continuación, Cloud Code compila los contenedores, los envía al registro, aplica las configuraciones de Kubernetes al clúster y espera el lanzamiento.

    Cuando finaliza el lanzamiento, Cloud Code redirecciona automáticamente todos los puertos de contenedor declarados a tu máquina y muestra las URL en la ventana de resultado para que puedas explorar la aplicación en vivo.

  5. Para cada contenedor depurable de tu aplicación, confirma o ingresa el directorio en el contenedor remoto en el que se encuentra el programa que deseas depurar.

    De forma alternativa, puede presionar ESC para omitir la depuración del contenedor.

    Solicitud raíz remoto

    Cloud Code adjunta una sesión de depuración para cada contenedor depurable de la aplicación.

    Ahora puedes realizar las mismas tareas que sueles hacer cuando depuras código local, como establecer puntos de interrupción y revisar el código paso a paso, en un clúster activo de Kubernetes.

    De forma predeterminada, cuando un cambio en tu aplicación se guarda de forma automática, Cloud Code vuelve a implementar tu aplicación y configura una nueva sesión de depuración. Puedes activar o desactivar esta función con la marca watch en la configuración de inicio del proyecto.

  6. Usa la barra lateral de depuración para revisar la información sobre las variables y la pila. Usa la consola de depuración ubicada en el depurador del panel inferior si deseas interactuar con la sesión de depuración.

  7. Una vez que se complete la sesión, puedes usar los siguientes comandos del menú contextual:

    • Open Deployment Logs: Abre los registros de la aplicación de una implementación específica con el explorador de registros de Cloud Code.
    • Abrir URL de servicio: abre la URL del servicio de aplicación de un servicio específico en un navegador web
  8. Si desactivaste el modo de supervisión en tu configuración de inicio y quieres realizar cambios en tu aplicación, volver a compilarla y volver a implementarla, en el panel Sesiones de desarrollo, haz una pausa en la acción de ejecución y, luego, haz clic en Ícono de vuelve a compilar e implementar Volver a compilar e implementar la aplicación.

  9. Con el objetivo de finalizar la sesión de depuración, haz clic en Ícono de detención de depuración Detener en la barra de herramientas de depuración.

    Cuando finalices la sesión de depuración, se borrarán del clúster todos los recursos de Kubernetes implementados.

Detalles de configuración

Con la tecnología de Skaffold, Cloud Code controla automáticamente los siguientes detalles de configuración para todos los lenguajes compatibles:

  • Redireccionar el puerto de depuración para poder conectar el depurador
  • Conectar un depurador a uno o más contenedores depurables en tu aplicación. Si tu aplicación tiene varios contenedores depurables (contenedores cuyo lenguaje es compatible con la depuración de Cloud Code) configurados en skaffold.yaml, entonces se adjunta un depurador a cada uno de los contenedores depurables.
  • Conserva las definiciones de asignación de origen en las sesiones. Para personalizar estas definiciones, edita directamente tu .vscode/launch.json.

Cloud Code también controla los siguientes detalles de configuración específicos del lenguaje:

Node.js

Reescribe el punto de entrada que se invocará:

node --inspect=localhost:9229

Python

Instala el módulo ptvsd mediante un contenedor Init y reescribe el punto de entrada que se invocará:

python -m ptvsd --host localhost --port 5678

Go

Instala el depurador dlv mediante un contenedor Init y reescribe el punto de entrada de modo que la sesión de depuración iniciada se ejecute solo con un servidor de depuración (en modo sin interfaz gráfica) continúa el proceso de depuración en el inicio, acepta varias conexiones de clientes y escucha en localhost:56268:

dlv exec --headless --continue --accept-multiclient --listen=localhost:56268 --api-version=2, <app> --

Java

Agregar un entorno JAVA_TOOLS_OPTIONS con la configuración del protocolo de depuración de Java (JDWP) adecuado para que el agente de depuración de JDWP escuche una conexión de socket en el puerto 5005 y permita que la VM comience a ejecutarse antes de adjuntar el depurador:

jdwp=transport=dt_socket,server=y,suspend=n,address=5005,quiet=y

Para obtener más información sobre la depuración con la tecnología de Skaffold, consulta la documentación de skaffold debug.

Adjunta el depurador a un Pod de Kubernetes

Cloud Code para VS Code también admite la conexión de un depurador a un Pod de Kubernetes. Para obtener una comparación, consulta Cómo adjuntar un Pod de Kubernetes en comparación con la depuración de una aplicación de Kubernetes.