Kubernetes-Anwendungen in Cloud Code für Cloud Shell debuggen

Mit Cloud Code können Sie Fehler in Anwendungen beheben, die in einem Google Kubernetes Engine-Cluster (GKE) durch Nutzung skaffold debug

Sie können in Ihrer Anwendung Fehler auf einem lokalen Cluster (z. B. minikube oder Docker Desktop), GKE oder einem anderen Cloud-Anbieter beheben.

Dank der Debugging-Unterstützung von Cloud Code manuelle Einrichtung wie Portweiterleitung oder Einschleusung sprachspezifischer . Für die Fehlerbehebung ist ein Cloud Code-fähiger GKE-Anwendung, die ein skaffold.yaml enthält Konfigurationsdatei und eine cloudcode.kubernetes-Startkonfiguration.

Fehler in GKE-Anwendungen beheben

Führen Sie die folgenden Schritte aus, um mit dem Debuggen Ihrer GKE-Anwendung zu beginnen: Schritte:

1. Klicken Sie in der Cloud Code-Statusleiste auf den Namen des aktiven Projekts.

   

2. Wählen Sie im Schnellauswahl-Menü Debug on Kubernetes aus.

3. Wenn Ihre Anwendung nicht über die erforderliche Skaffold-Konfiguration verfügt oder Startkonfiguration für cloudcode.kubernetes, Cloud Code finden Sie hier.

4. Geben Sie an, ob Sie den aktuellen Kubernetes-Kontext zum Ausführen der Anwendung verwenden oder ob Sie zu einem bevorzugten Kontext wechseln möchten.

5. Wenn Sie einen Remote-Cluster als Kontext ausgewählt haben, wählen Sie bei entsprechender Aufforderung ein Image aus Registry, in die die Images übertragen werden sollen. Wenn Sie Container Registry verwenden, können Sie eine vorhandene Registry aufrufen oder den Namen einer zu erstellenden Registry angeben. Wenn Ihr Projekt Artifact Registry API aktiviert und mindestens ein Artifact Registry-Repository kann ein vorhandenes Artifact Registry-Repository suchen und auswählen.

   In den folgenden Beispielen wird gezeigt, wie Sie für einige gängige Registries angeben, wo Container-Images gespeichert werden:

   Artifact Registry	{region}-docker.pkg.dev/{project_id}/{repo-name}
   Container Registry	gcr.io/{project_id}
   Docker Hub	docker.io/{account} Stellen Sie sicher, dass Sie ordnungsgemäß authentifiziert wenn Sie ein privates Docker Hub-Repository verwenden.

   Um den endgültigen Namen des Image-Repositorys zu generieren, verkettet Cloud Code diese Image-Registry mit dem in den Kubernetes-Manifesten angegebenen Image-Namen. Diese Auswahl wird in Ihrer cloudcode.kubernetes-Startkonfiguration gespeichert (in .vscode/launch.json).

   Weitere Informationen finden Sie im Leitfaden zur Image-Registry.

   Anschließend erstellt Cloud Code Ihre Container, überträgt sie in die Registry, wendet Kubernetes-Konfigurationen auf den Cluster an und wartet auf den Rollout.

   Nach Abschluss der Einführung leitet Cloud Code alle deklarierten Containerports automatisch an Ihren Computer weiter und zeigt die URLs im Ausgabefenster an. So können Sie Ihre Live-Anwendung durchsuchen.

6. Für jeden debugfähigen Container in Ihrer Anwendung werden Sie aufgefordert, das Verzeichnis im Remote-Container, in dem sich das zu debuggende Programm befindet, zu bestätigen oder einzugeben.

   Alternativ können Sie die ESC drücken, um das Debugging für den Container zu überspringen.

   

   Cloud Code hängt für jedes Debug-fähige Gerät eine Debug-Sitzung an. Container in der Anwendung.

   Sie können jetzt die gleichen Aufgaben ausführen, die Sie normalerweise beim Debuggen von lokalem Code ausführen, z. B. das Festlegen von Haltepunkten und das Durchlaufen von Code in einem Live-Kubernetes-Cluster.

   Wenn eine Änderung an Ihrer Anwendung automatisch gespeichert wird, stellt Cloud Code Ihre Anwendung standardmäßig noch einmal bereit und richtet eine neue Debug-Sitzung ein. Sie können dieses Feature in der Startkonfiguration Ihres Projekts mit dem Flag watch ein- oder ausschalten.

7. In der Debugging-Seitenleiste können Sie Variablen und Stack-Informationen prüfen. Verwenden Sie die Debug Console im Debugger im unteren Bereich, um mit der Debugging-Sitzung zu interagieren.

8. Nach Abschluss Ihrer Sitzung können Sie die folgenden Kontextmenübefehle verwenden:

   • Open Deployment Logs (Bereitstellungslogs öffnen): Die Anwendungslogs eines bestimmten mit dem Cloud Code-Log-Explorer bereitstellen.
   • Dienst-URL öffnen: Öffnen Sie die Anwendungsdienst-URL eines bestimmten Dienstes in einem Webbrowser.

9. Wenn Sie den Überwachungsmodus in der Startkonfiguration deaktiviert haben und Sie Änderungen an Ihrer Anwendung vornehmen und die Anwendung neu erstellen und noch einmal bereitstellen möchten, pausieren Sie im Bereich „Entwicklungssitzungen“ die Ausführungsaktion und klicken Sie dann auf Anwendung neu erstellen und neu bereitstellen.

10. Klicken Sie zum Beenden der Debugging-Sitzung in der Debug-Symbolleiste auf Stop.

    Nach Beendigung der Debugging-Sitzung werden alle bereitgestellten Kubernetes-Ressourcen aus dem Cluster gelöscht.

Konfigurationsdetails

Cloud Code, bereitgestellt von Skaffold, verarbeitet die folgenden Konfigurationsdetails automatisch für alle unterstützten Sprachen:

• Portweiterleitung des Debug-Ports, damit der Debugger hinzugefügt werden kann.
• Anhängen eines Debuggers an einen oder mehrere Debug-fähige Container in Ihrer Anwendung. Wenn Ihre Anwendung über mehrere debugfähige Container verfügt (Container, deren Sprache wird von Cloud Code Debug unterstützt), die in skaffold.yaml gesetzt ist, wird an jeden Debug-fähigen Container ein Debugger angehängt.
• Quellzuordnungsdefinitionen über Sitzungen hinweg: Sie können diese Definitionen anpassen, indem Sie die Datei .vscode/launch.json direkt bearbeiten.

Cloud Code verarbeitet außerdem die folgenden sprachspezifischen Konfigurationsdetails:

node --inspect=localhost:9229

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

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

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

Weitere Informationen zum Debugging auf Skaffold finden Sie in der skaffold debug-Dokumentation.

Container einrichten

Folgen Sie der Anleitung für die verwendete Sprache, um den Container für das Debugging vorzubereiten:

Anhang-Konfiguration einrichten

Wenn Sie einen debugfähigen Container hinzufügen möchten, benötigen Sie eine Anhang-Konfiguration vom Typ cloudcode.kubernetes.

Vscode/launch.json-Datei hinzufügen

Wenn Ihr Projekt im Ordner .vscode keine Datei launch.json hat, können Sie über das Debug-Feld eine Datei hinzufügen.

1. Um den Debug-Bereich aufzurufen, klicken Sie auf Fehler beheben in der Aktivitätsleiste.

2. Wählen Sie im Drop-down-Menü die Option Konfiguration hinzufügen aus.

3. Wählen Sie Cloud Code: Kubernetes als Umgebung aus.

   

4. Wählen Sie die Option An Kubernetes-Pod anhängen aus.

   

5. Wählen Sie die verwendete Programmiersprache aus.

   Dadurch wird eine Datei launch.json für Ihr Projekt erstellt und geöffnet und eine Anhangskonfiguration erstellt.

6. Aktualisieren Sie die Konfigurationsattribute in der Datei launch.json, um sie an die Ihres Projekts anzupassen. Weitere Informationen zu Konfigurationsattributen finden Sie unter Konfigurationsattribute:

Anhangskonfiguration zur .vscode/launch.json-Datei hinzufügen

So fügen Sie einer vorhandenen .vscode/launch.json-Datei eine neue Anhang-Konfiguration hinzu:

1. Öffnen Sie die Datei launch.json.
2. Klicken Sie auf Konfiguration hinzufügen, um das IntelliSense für das Snippet aufzurufen.
3. Wählen Sie zum Hinzufügen einer Anhangskonfiguration das Symbol Cloud Code: Attach to Kubernetes Pod (Cloud Code: An Kubernetes Pod anhängen) für die verwendete Sprache verwenden.
4. Aktualisieren Sie die Attribute in der Konfiguration, damit sie mit denen Ihres Projekts übereinstimmen. Weitere Informationen zu Konfigurationsattributen finden Sie unter Konfigurationsattribute:

Konfigurationsattribute

Debugger an einen Kubernetes-Pod anhängen

Cloud Code für Cloud Shell unterstützt das Anhängen eines Debuggers an einen Kubernetes-Pod für Node.js, Python, Go, Java und .NET. Sie benötigen lediglich einen debugfähigen Container und eine Anhang-Konfiguration vom Typ cloudcode.kubernetes.

Informationen dazu, wie sich das Anhängen an einen Kubernetes-Pod von Fehlerbehebung für eine Kubernetes-Anwendung finden Sie unter Unterschiede zwischen dem Anhängen eines Debuggers an einen Pod und dem Debuggen einer Kubernetes-Anwendung

Führen Sie die folgenden Aufgaben aus, um einen Debugger an Ihren Kubernetes-Pod anzuhängen:

1. Klicken Sie in der Aktivitätsleiste auf  Fehler beheben, um den Bereich „Fehler beheben“ aufzurufen.

2. Wählen Sie die Konfiguration aus und starten Sie sie, indem Sie auf F5 drücken.

   • localhost:${debugPort} wird während der Fehlerbehebung an den Container debugPort weitergeleitet.

   Die Fehlerbehebungssitzung wurde erfolgreich eingerichtet. Sie können die Aufgaben ausführen, die Sie normalerweise beim Debuggen von lokalem Code ausführen, z. B. das Festlegen von Haltepunkten und das Durchlaufen von Code.

3. In der Debugging-Seitenleiste können Sie Variablen und Stack-Informationen prüfen. Verwenden Sie die Debug Console im Debugger im unteren Bereich, um mit der Debugging-Sitzung zu interagieren.

4. Klicken Sie zum Beenden der Debugging-Sitzung in der Debug-Symbolleiste auf Stop.

Unterschied zwischen dem Anhängen eines Debuggers an einen Pod und dem Debugging einer Kubernetes-Anwendung

{
  "name": "Attach to Kubernetes Pod (NodeJS)",
  "type": "cloudcode.kubernetes",
  "request": "attach",
  "language": "Node",
  "debugPort": 9229,
  "podSelector": {
     "app": "hello-world"
  },
  "localRoot": "${workspaceFolder}",
  "remoteRoot": "/app"
}

{
  "name": "Run/Debug on Kubernetes",
  "type": "cloudcode.kubernetes",
  "request": "launch",
  "skaffoldConfig": "${workspaceFolder}/skaffold.yaml",
  "watch": true,
  "cleanUp": true,
  "portForward": true
}

Nächste Schritte

• Verwenden Sie Dateisynchronisierung und Hot Reload, um die Entwicklung zu beschleunigen.
• Richten Sie in Cloud Code eine Umgebung für die kontinuierliche Entwicklung ein.
• Kubernetes-Logs ansehen in Cloud Code.