Déboguer des applications Kubernetes dans Cloud Code pour Cloud Shell

Cloud Code vous permet de déboguer une application déployée sur un cluster Google Kubernetes Engine (GKE) à l'aide de skaffold debug.

Vous pouvez déboguer votre application sur un cluster local (comme minikube ou Docker Desktop), GKE ou tout autre fournisseur cloud.

Grâce aux fonctionnalités de débogage de Cloud Code, vous n'avez pas besoin d'effectuer une configuration manuelle, telle que la configuration du transfert de port ou l'injection d'arguments de débogage spécifiques au langage. Le débogage nécessite une application GKE compatible avec Cloud Code, qui inclut un fichier de configuration skaffold.yaml et une configuration de lancement cloudcode.kubernetes.

Déboguer une application GKE

Pour commencer à déboguer votre application GKE, procédez comme suit:

Dans la barre d'état Cloud Code, cliquez sur le nom du projet actif.
Dans le menu Quick Pick qui s'affiche, sélectionnez Debug on Kubernetes (Déboguer sur Kubernetes).
Si votre application ne dispose pas de la configuration Skaffold ou de la configuration de lancement cloudcode.kubernetes nécessaire, Cloud Code vous aide à les configurer.
Confirmez que vous souhaitez utiliser le contexte Kubernetes actuel pour exécuter l'application (ou basculez vers le contexte de votre choix).

Si vous avez choisi un cluster distant comme contexte, choisissez un registre d'images vers lequel transférer les images lorsque vous y êtes invité. Si vous utilisez Container Registry, vous pouvez accéder à un registre existant ou spécifier le nom d'un registre à créer. Si l'API Artifact Registry est activée et au moins un dépôt Artifact Registry pour votre projet, vous pouvez parcourir et sélectionner un dépôt Artifact Registry existant.

Les exemples suivants montrent comment spécifier l'emplacement de stockage des images de conteneurs pour certains registres courants :

Artifact Registry	{region}-docker.pkg.dev/{project_id}/{repo-name}
Container Registry	gcr.io/{project_id}
Docker Hub	docker.io/{account} Si vous utilisez un dépôt Docker Hub privé, assurez-vous d'être correctement authentifié.

Pour générer le nom final du dépôt d'images, Cloud Code concatène ce registre d'images avec le nom d'image spécifié dans les fichiers manifestes Kubernetes. Ce choix est stocké dans votre configuration de lancement cloudcode.kubernetes (disponible dans .vscode/launch.json).

Pour en savoir plus, consultez le guide de gestion des registres d'images.

Cloud Code crée ensuite vos conteneurs, les transfère dans le registre, applique les configurations Kubernetes au cluster et attend le déploiement.

Une fois le déploiement terminé, Cloud Code transfère automatiquement tous les ports de conteneur déclarés vers votre ordinateur et affiche les URL dans la fenêtre de sortie afin que vous puissiez parcourir votre application en ligne.

Pour chaque conteneur débogable dans votre application, vous êtes invité à confirmer ou à saisir le répertoire du conteneur distant dans lequel se trouve le programme à déboguer.

Vous pouvez également appuyer sur ESC pour ignorer le débogage du conteneur.

Cloud Code associe une session de débogage pour chaque conteneur débogable de l'application.

Vous pouvez désormais effectuer les mêmes tâches que celles que vous effectuez normalement lors du débogage de code local (définition de points d'arrêt et passage en revue du code, par exemple) sur un cluster Kubernetes en service.

Par défaut, lorsqu'une modification apportée à votre application est enregistrée automatiquement, Cloud Code redéploie l'application et configure une nouvelle session de débogage. Vous pouvez activer ou désactiver cette fonctionnalité avec l'option watch dans la configuration de lancement de votre projet.
Pour inspecter les variables et les informations de pile, utilisez la barre latérale de débogage. Pour interagir avec la session de débogage, utilisez la console de débogage dans le volet inférieur du débogueur.
Une fois la session terminée, vous pouvez utiliser les commandes du menu contextuel suivantes :
- Open Deployment Logs (Ouvrir les journaux de déploiement) : ouvrez les journaux d'application d'un déploiement spécifique avec l'explorateur de journaux Cloud Code.
- Ouvrir une URL de service : ouvrez l'URL du service d'application d'un service spécifique dans un navigateur Web.
Si vous avez désactivé le mode de surveillance dans votre configuration de lancement et que vous souhaitez modifier votre application, puis la recompiler et la redéployer, dans le volet "Sessions de développement", mettez l'application en pause, puis cliquez sur Recompiler et redéployer l'application.
Pour mettre fin à la session de débogage, cliquez sur Arrêter dans la barre d'outils de débogage.

Une fois la session de débogage terminée, toutes les ressources Kubernetes déployées sont supprimées du cluster.

Détails de la configuration

Cloud Code, fourni par Skaffold, gère automatiquement les détails de configuration suivants pour tous les langages compatibles:

Transfert du port de débogage pour que le débogueur puisse être associé
Association d'un débogueur à un ou plusieurs conteneurs débogables dans votre application. Si votre application comporte plusieurs conteneurs débogables (dont le langage est compatible avec le débogage Cloud Code) configurés dans skaffold.yaml, un débogueur est associé à chaque conteneur débogable.
Conserver les définitions de mappage de source entre les sessions. Vous pouvez personnaliser ces définitions en modifiant directement le fichier .vscode/launch.json.

Cloud Code gère également les détails de configuration spécifiques au langage suivants :

Node.js

Réécriture du point d'entrée à appeler :

node --inspect=localhost:9229

Python

Installation du module ptvsd à l'aide d'un conteneur d'initialisation et réécriture du point d'entrée à appeler :

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

Go

Installation du débogueur dlv à l'aide d'un conteneur init et de la réécriture du point d'entrée, de sorte que la session de débogage lancée s'exécute avec un serveur de débogage uniquement (en mode sans interface graphique), continue le processus débogué au démarrage, accepte plusieurs connexions client et écoute à l'adresse localhost:56268 :

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

Java

Ajout d'un environnement JAVA_TOOLS_OPTIONS avec la configuration JDWP (Java Debug Wire Protocol) appropriée, de sorte que l'agent de débogage JDWP écoute une connexion de socket sur le port 5005 et permet à la VM de commencer à s'exécuter avant Debugger est associé :

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

Pour en savoir plus sur le débogage basé sur Skaffold, consultez la documentation skaffold debug.

Configurer votre conteneur

Pour préparer votre conteneur au débogage, suivez les instructions relatives au langage que vous utilisez :

Node.js

Démarrez l'application Node.js avec --inspect=<debugPort>, où debugPort provient de la configuration d'association. Par exemple, CMD ["node", "--inspect=9229", "index.js"].

Python

Assurez-vous que le module ptvsd est installé sur votre ordinateur et dans votre conteneur.
Démarrez l'application Python via ptvsd. Faites correspondre le port spécifié au champ debugPort de la configuration d'association. Exemple :
```
CMD ["python", "-m", "ptvsd", "--port", "", "app.py"]
```

Go

Assurez-vous que le package dlv est installé sur votre ordinateur et que votre conteneur Go est installé.
Démarrez votre application Go via dlv debug.

Le port spécifié dans la commande de démarrage doit être identique à la valeur de l'attribut debugPort dans la configuration de l'association. Exemple :
```
CMD ["dlv", "debug", "--headless", "--listen=:<debugPort>", "--log"]
```
Conseil de dépannage : Lors du débogage d'une application Go, celle-ci s'arrête et attend la liaison à un débogueur. Rattachez un débogueur pour que le service démarre.

Java

Assurez-vous que la JVM est installée sur votre ordinateur.
Démarrez l'application Java avec les options suivantes, où debugPort provient de la configuration de rattachement.
```
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=,quiet=y
```
Par exemple, pour démarrer l'application Java en mode débogage et écouter le port debugPort pour la connexion:
```
ENTRYPOINT ["java","-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<debugPort>,quiet=y", "-jar", "my-app-1.0.jar"]
```

.NET Core

Assurez-vous que vsdbg, le débogueur en ligne de commande .NET Core de Microsoft, est installé sur votre conteneur Kubernetes.

Exemple :

RUN apt-get update 

  && apt-get install -y --no-install-recommends unzip 

  && apt-get install -y procps 

  && rm -rf /var/lib/apt/lists/* 

  && curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v latest -l /dbg/netcore/vsdbg

Définir votre configuration d'association

Pour vous rattacher à un conteneur débogable, vous devez disposer d'une configuration de rattachement de type cloudcode.kubernetes.

Ajouter un fichier .vscode/launch.json

Si votre projet ne contient pas de fichier launch.json dans son dossier .vscode, vous pouvez en ajouter un à l'aide du panneau de débogage.

Pour accéder au panneau "Debug" (Débogage), cliquez sur Debug (Débogage) dans la barre "Activity" (Activité).
Sélectionnez Add Configuration (Ajouter une configuration) dans le menu déroulant.
Sélectionnez l'environnement Cloud Code: Kubernetes.
Sélectionnez l'option Attach to Kubernetes Pod (Associer au pod Kubernetes).
Sélectionnez le langage de programmation que vous utilisez.

Cela a pour effet de créer et d'ouvrir un fichier launch.json pour votre projet, puis de créer une configuration de rattachement pour vous.
Mettez à jour les attributs de configuration dans le fichier launch.json pour qu'ils correspondent à ceux de votre projet. Pour en savoir plus sur les attributs de configuration, consultez la section Attributs de configuration.

Ajouter une configuration d'association à votre fichier .vscode/launch.json

Pour ajouter une nouvelle configuration d'association à un fichier .vscode/launch.json existant:

Ouvrez le fichier launch.json.
Pour appeler l'extrait de code "Intellisense", cliquez sur Add Configuration (Ajouter une configuration).
Pour ajouter une configuration d'association, sélectionnez l'extrait de code Cloud Code: Attach to Kubernetes Pod (Cloud Code : associer au pod Kubernetes) correspondant au langage que vous utilisez.
Mettez à jour les attributs de la configuration pour qu'ils correspondent à ceux de votre projet. Pour en savoir plus sur les attributs de configuration, consultez la section Attributs de configuration.

Attributs de configuration

Attribut	Description
debugPort	Port de débogage utilisé sur le conteneur.
podSelector	Ensemble de paires clé/valeur utilisé pour sélectionner le pod de débogage. Pour plus d'informations, consultez le guide sur les sélecteurs. L'exemple suivant présente un `podSelector` type : `"podSelector": { "app": <deployment-name> }`
localRoot	Chemin du répertoire local contenant le programme en cours de débogage. La valeur par défaut est "${workspaceFolder}".
remoteRoot	Chemin absolu du répertoire distant contenant le programme en cours de débogage (sur le conteneur Kubernetes).

Associer un débogueur à votre pod Kubernetes

Cloud Code pour Cloud Shell permet de joindre un débogueur à un pod Kubernetes pour Node.js, Python, Go, Java et .NET. Vous avez simplement besoin d'un conteneur débogable et d'une configuration d'association de type cloudcode.kubernetes.

Pour en savoir plus sur les différences entre l'association à un pod Kubernetes et le débogage d'une application Kubernetes, consultez la section Différences entre l'association d'un débogueur à un pod et le débogage d'une application Kubernetes.

Pour associer un débogueur à votre pod Kubernetes, procédez comme suit:

Pour accéder au panneau "Debug" (Débogage), cliquez sur Debug (Débogage) dans la barre "Activity" (Activité).
Sélectionnez et lancez la configuration en appuyant sur F5.
- localhost:${debugPort} est transféré vers debugPort sur le conteneur lors du débogage.
La session de débogage est maintenant configurée. Vous pouvez effectuer les tâches habituelles de débogage du code local, comme définir des points d'arrêt et parcourir le code.
Pour inspecter les variables et les informations de pile, utilisez la barre latérale de débogage. Pour interagir avec la session de débogage, utilisez la console de débogage dans le volet inférieur du débogueur.
Pour mettre fin à la session de débogage, cliquez sur Arrêter dans la barre d'outils de débogage.

Différences entre l'association d'un débogueur à un pod et le débogage d'une application Kubernetes

Associer à un pod Kubernetes	Déboguer une application Kubernetes
Débogue un seul pod Kubernetes.	Débogue tous les conteneurs débogables de l'application.
L'application doit s'exécuter dans le pod Kubernetes avant le débogage.	Exécute l'application sur le cluster Kubernetes et associe le débogueur.
Utilise la configuration (.vscode/launch.json) de type `cloudcode.kubernetes` et la requête `attach`.	Utilise la configuration (.vscode/launch.json) de type `cloudcode.kubernetes` et la requête `launch`. Pour en savoir plus, consultez Configurations de lancement ou d'association.
Exemple de configuration: { "name": "Attach to Kubernetes Pod (NodeJS)", "type": "cloudcode.kubernetes", "request": "attach", "language": "Node", "debugPort": 9229, "podSelector": { "app": "hello-world" }, "localRoot": "${workspaceFolder}", "remoteRoot": "/app" }	Exemple de configuration: { "name": "Run/Debug on Kubernetes", "type": "cloudcode.kubernetes", "request": "launch", "skaffoldConfig": "${workspaceFolder}/skaffold.yaml", "watch": true, "cleanUp": true, "portForward": true }
Cette configuration ne peut pas être utilisée pour exécuter l'application.	Cette configuration peut être utilisée pour exécuter ou déboguer l'application.
Cette configuration est spécifique à chaque langage.	Cette configuration n'est pas spécifique à un langage.
Aucune commande dédiée.	Commande Debug on Kubernetes (Déboguer sur Kubernetes).

Étapes suivantes

Utilisez la synchronisation des fichiers et le hot reload pour accélérer le développement.
Configurez un environnement de développement continu dans Cloud Code.
Affichez les journaux Kubernetes dans Cloud Code.