Erste Schritte mit Cloud Code for VS Code for 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 Reihe von Codebeispielvorlagen, die Ihnen einen schnellen Einstieg ermöglichen. So erstellen Sie eine Kubernetes-Anwendung mit einem vorhandenen Beispiel:

  1. Starten Sie die Befehlspalette. Drücken Sie dazu Ctrl/Cmd + Shift + P oder klicken Sie auf Ansicht > Befehlspalette. Führen Sie dann Cloud Code: Neue Anwendung aus.
  2. Wählen Sie als Beispieltyp Kubernetes-Anwendung aus.
  3. Wählen Sie aus den verfügbaren Optionen ein Beispiel für die Sprache aus, die Sie verwenden möchten: NodeJS, Go, Python, Java.

  4. Wählen Sie einen bevorzugten Speicherort für die Anwendung auf Ihrem lokalen Computer aus und klicken Sie zum Speichern auf Create new application (Neue Anwendung erstellen).

    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: Konfigurationsdatei für Skaffold, die Cloud Code zum Erstellen, Bereitstellen und Debuggen von Kubernetes-Anwendungen verwendet

Eigene Anwendung verwenden

Eine schrittweise Anleitung zum Verwenden 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 der Konfiguration angeben.

Konfiguration

Wenn Sie die Ausführungskonfiguration Cloud Code: Develop on Kubernetes verwenden, können Sie Ihr Deployment über die verfügbaren Einstellungen anpassen.

Wenn Sie Konfigurationen hinzufügen oder bearbeiten möchten, rufen Sie Run > Open Configurations (Ausführen > Konfigurationen öffnen) auf und bearbeiten oder fügen Sie 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 skaffold.yaml-Datei anpassen, um die Ausführung Ihrer Anwendung zu konfigurieren.

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

Nachdem Sie eine Anwendung eingerichtet haben, können Sie sie in einem Kubernetes-Cluster ausführen und mithilfe von skaffold dev live ansehen. 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 entsprechender Aufforderung eine Image-Registry aus, in die die Images übertragen werden sollen. Wenn Sie Container Registry verwenden, können Sie zu einer vorhandenen Registry gehen oder den Namen der zu erstellenden Registry angeben. Wenn für Ihr Projekt die Artifact Registry API aktiviert und mindestens ein Artifact Registry-Repository aktiviert ist, können Sie ein vorhandenes Artifact Registry-Repository aufrufen 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}
    Achten Sie darauf, dass Sie ordnungsgemäß authentifiziert sind, wenn Sie ein privates Docker Hub-Repository verwenden.
    AWS Container Repository (ECR) {aws_account_id}.dkr.ecr.{region}.amazonaws.com/{my-app}
    Azure Container Registry (ACR) {my_acr_name}.azurecr.io/{my-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

Wenn Sie Ihre Anwendung entwickeln und ausführen, können Sie in der Terminalausgabe nicht nur Logs von ausgeführten Pods als Livestream sehen, sondern auch Logs von einem bestimmten Pod ansehen, indem Sie den Bereich „Kubernetes“ aufrufen.

So rufen Sie Logs eines bestimmten Pods auf:

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

  2. Klicken Sie mit der rechten Maustaste auf den Pod, für den Sie Logs aufrufen möchten, und klicken Sie dann auf Logs ansehen.

    Die Loganzeige wird geöffnet.

Änderungen vornehmen, neu erstellen und bereinigen

Wenn Sie in der Startkonfiguration den Überwachungsmodus auf false festgelegt haben und Änderungen an Ihrer Anwendung vornehmen und sie dann neu erstellen und noch einmal bereitstellen möchten, gehen Sie so vor:

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

  2. Klicken Sie in der Symbolleiste zur Fehlerbehebung 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 Symbolleiste zur Fehlerbehebung 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 der Startkonfiguration ändern.

Store-Secrets

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 Abschnitt Kubernetes werden Cluster, Namespaces, Knoten, Arbeitslasten (z. B. Deployments, Replikatsets, Pods und Container), Dienste und Ingress-Ressourcen, Konfigurationen (z. B. Secrets und Konfigurationspläne) sowie Speicher (z. B. Volumes) angezeigt. Im Bereich „Kubernetes“ können Sie spezielle Aktionen für einige dieser Ressourcen ausführen.

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

Nächste Schritte

Support anfragen

Wenn Sie Feedback geben möchten, können Sie Probleme auf GitHub melden oder eine Frage in Stack Overflow stellen.