Erste Schritte mit Cloud Code für VS Code für Kubernetes

Mit Cloud Code können Sie eine Kubernetes-Anwendung auf der Grundlage eines Beispiels oder eines vorhandenen Projekts erstellen.

Anwendung aus einer Vorlage erstellen

Cloud Code enthält eine Sammlung von Codebeispielvorlagen, mit denen Sie schnell loslegen können. So erstellen Sie eine Kubernetes-Anwendung mit einem vorhandenen Beispiel:

  1. Öffnen Sie die Befehlspalette (über Ctrl/Cmd + Shift + P oder Ansicht > Befehlspalette) und führen Sie dann Cloud Code: Neue Anwendung aus.
  2. Wählen Sie als Beispieltyp Kubernetes-Anwendung aus.
  3. Wählen Sie ein Beispiel basierend auf der Sprache aus, die Sie verwenden möchten: NodeJS, Go, Python oder Java.

  4. Wählen Sie einen bevorzugten Speicherort für die Anwendung auf Ihrem lokalen Computer aus und klicken Sie dann auf Neue Anwendung erstellen, um die Anwendung zu speichern.

    Cloud Code klont das ausgewählte Beispiel und öffnet das neue Projekt zur Verwendung.

Beispielstruktur der Anwendung

Alle Sprachbeispielanwendungen haben nahezu dieselbe Struktur. Es gibt zwar weitere unterstützte Strukturen, aber diese Struktur wird für den Anfang empfohlen.

Die Struktur der Node.js-Gästebuchanwendung sieht beispielsweise so aus:

.
|---- .vscode
|      └---- launch.json
|---- kubernetes-manifests
|     |---- guestbook-backend.deployment.yaml
|     |---- guestbook-backend.service.yaml
|     |---- guestbook-frontend.deployment.yaml
|     |---- guestbook-frontend.service.yaml
|     |---- mongo.deployment.yaml
|     └---- mongo.service.yaml
|---- src
|     |---- backend
|     |     |---- Dockerfile
|     |     |---- index.js
|     |     |---- app.js
|     |     └---- package.json
|     |---- frontend
|           |---- Dockerfile
|           |---- index.js
|     |     |---- app.js
|           └---- package.json
└---- skaffold.yaml

Wenn Sie sich diese Node.js-Beispielanwendung für das Kubernetes-Gästebuch genauer ansehen, finden Sie hier einige Schlüsseldateien und ihre Verwendung:

  • .vscode
    • extensions.json: Aufforderung zum Herunterladen weiterer Erweiterungen beim Öffnen dieses Projekts
    • launch.json: Konfiguration (vom Typ cloudcode.kubernetes) starten, um die Kubernetes-Anwendung auszuführen oder Fehler zu beheben
    • tasks.json: Konfigurationsinformationen für Visual Studio Code-Aufgaben
  • kubernetes-manifests
    • guestbook-backend.deployment.yaml: Pod-Spezifikation für die Backend-Knoten
    • guestbook-frontend.deployment.yaml: Pod-Spezifikation für die Frontend-Knoten
    • mongo.deployment.yaml: Pod-Spezifikation für die Datenbank
  • src
    • (backend|frontend)/app.js: Node.js-Code mit der Webserverlogik
    • (backend|frontend)/Dockerfile: wird verwendet, um das Container-Image für unser Programm zu erstellen
  • skaffold.yaml: Eine Konfigurationsdatei, die Cloud Code zum Erstellen, Bereitstellen und Debuggen von Kubernetes-Anwendungen verwendet.

Eigene Anwendung verwenden

Eine Anleitung zur Verwendung eines vorhandenen Projekts finden Sie unter Cloud Code mit einer vorhandenen Kubernetes-Anwendung verwenden.

Kubernetes-Kontext festlegen

Bevor Sie Ihre Anwendung ausführen, müssen Sie sie einrichten, um sie in Ihrem bevorzugten Kubernetes-Kontext bereitzustellen. Sie können dies in Ihrer Konfiguration angeben.

Konfiguration

Wenn Sie die Ausführungskonfiguration Cloud Code: Develop on Kubernetes verwenden, können Sie die Bereitstellung anpassen, indem Sie die verfügbaren Einstellungen konfigurieren.

Wenn Sie Konfigurationen hinzufügen oder bearbeiten möchten, gehen Sie zu Ausführen > Konfigurationen öffnen und bearbeiten oder fügen Sie dann Konfigurationen hinzu.

Build-Einstellungen

Cloud Code unterstützt die Artefakttypen Docker, Jib und Buildpacks. Informationen zum Festlegen Ihres bevorzugten Builders und der relevanten Einstellungen finden Sie im Leitfaden „Build-Einstellungen für Container-Images konfigurieren“.

Startkonfiguration anpassen

Sie können die Ausführung Ihrer Anwendung konfigurieren, indem Sie die Datei skaffold.yaml anpassen.

Sie können den Start auch konfigurieren, indem Sie die cloudcode.kubernetes-Konfiguration in der Datei .vscode/launch.json bearbeiten.

Weitere Informationen zum Anpassen der Startkonfiguration finden Sie unter Kubernetes in Cloud Code.

Führen Sie Ihre Anwendung aus

Sobald Sie eine Anwendung eingerichtet haben, können Sie sie in einem Kubernetes-Cluster ausführen und live ansehen, indem Sie skaffold dev verwenden. Sie können Ihre Anwendung auf einem lokalen Cluster wie Minikube oder Docker Desktop, in Google Kubernetes Engine oder in jedem anderen Cloud-Anbieter ausführen.

  1. Öffnen Sie die Befehlspalette (drücken Sie Ctrl/Cmd+Shift + P) und führen Sie dann den Befehl Cloud Code: Auf Kubernetes ausführen aus.
  2. 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. Weitere Informationen zum Einrichten eines Kubernetes-Kontexts finden Sie unter Konfiguration einrichten.

  3. Wenn Sie einen Remote-Cluster als Kontext ausgewählt haben, wählen Sie bei Aufforderung eine Bildregistrierung aus, in die die Bilder übertragen werden sollen. Wenn in Ihrem Projekt die Artifact Registry API aktiviert ist und mindestens ein Artifact Registry-Repository vorhanden ist, können Sie ein vorhandenes Artifact Registry-Repository 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
    Docker Hub docker.io/ACCOUNT
    Achten Sie darauf, dass Sie richtig authentifiziert sind, wenn Sie ein privates Docker Hub-Repository verwenden.
    AWS-Container-Repository (ECR): AWS_ACCOUNT_ID.dkr.ecr.REGION.amazonaws.com/APP
    Azure Container Registry (ACR) ACR_NAME.azurecr.io/APP

    Cloud Code verkettet diese Image-Registry mit dem Image-Namen, der in den Kubernetes-Manifesten angegeben ist, um den Namen des endgültigen Image-Repositorys zu generieren.

    Weitere Informationen finden Sie im Leitfaden zur Image-Registry.

    Diese Auswahl wird in Ihrer Startkonfiguration cloudcode.kubernetes gespeichert (in .vscode/launch.json).

    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.

Logs ansehen

Neben dem Anzeigen von Logs von ausgeführten Pods als Livestream in der Terminalausgabe während der Entwicklung und Ausführung Ihrer Anwendung können Sie auch Logs von einem bestimmten Pod aufrufen, indem Sie zum Kubernetes-Bereich wechseln.

So rufen Sie Logs eines bestimmten Pods auf:

  1. Maximieren Sie im Bereich „Kubernetes“ die Option Deployments.

  2. Rechtsklicken Sie auf den Pod, dessen Logs Sie ansehen möchten, und klicken Sie dann auf Logs ansehen.

    Die Loganzeige wird geöffnet.

Änderungen vornehmen, neu erstellen und bereinigen

Wenn Sie den Uhrenmodus in Ihrer Startkonfiguration auf false eingestellt haben und Änderungen an Ihrer Anwendung vornehmen und die Anwendung dann neu erstellen und erneut bereitstellen möchten, gehen Sie so vor:

  1. Nehmen Sie die gewünschten Änderungen vor und speichern Sie sie.

  2. Klicken Sie in der Debugging-Symbolleiste auf Pausieren (F6) und dann auf Neu starten (Ctrl/Cmd + Shift + F5), um die Anwendung neu zu erstellen und bereitzustellen.

  3. Klicken Sie in der Debugging-Symbolleiste auf Beenden, um die Ausführung der Anwendung zu beenden.

Nachdem Sie die Anwendung beendet haben, werden alle bereitgestellten Kubernetes-Ressourcen aus dem Cluster gelöscht. Sie können dieses Verhalten mit dem Flag cleanUp in Ihrer Startkonfiguration ändern.

Secrets speichern

Wenn Ihr Code potenziell sensible Daten wie API-Schlüssel, Passwörter und Zertifikate enthält, sollten Sie diese als Secrets speichern. Mit Cloud Code können Sie diese Secrets sicher in Secret Manager speichern und sie bei Bedarf programmatisch abrufen.

Eine detaillierte Beschreibung dazu, wie Sie Secrets mit Cloud Code erstellen und verwalten können, finden Sie in der Anleitung zu Secret Manager.

Ressourcendetails aufrufen

Im Bereich „Kubernetes“ werden Cluster, Namespaces, Knoten, Arbeitslasten (z. B. Deployments, Replicasets, Pods und Container), Services und Ingresses, Konfigurationen (z. B. Secrets und ConfigMaps) und Speicher (z. B. Volumes) angezeigt. Im Kubernetes-Bereich können Sie für einige dieser Ressourcen bestimmte Aktionen ausführen.

Weitere Informationen zum Aufrufen von Ressourcendetails finden Sie in der Kubernetes-Übersicht.

Nächste Schritte

Support anfragen

Wenn Sie Feedback geben möchten, stellen Sie eine Frage in Stack Overflow. Wenn Sie Google Cloud-Kunde sind, können Sie Tickets über die Standard-Supportkanäle von Google Cloud einreichen.