Entwicklung in Cloud Code for Cloud Shell beschleunigen

Um Ihre lokale Entwicklung in Cloud Code for Cloud Shell zu beschleunigen, nutzen Sie Synchronisierung und Hot Refresh, automatische Bereitstellung beim Speichern und Verwenden von Skaffold-Modulen um Teile einer Anwendung separat zu entwickeln.

Skaffold-Dateisynchronisierung und Hot Reload aktivieren

Skaffold unterstützt das Kopieren geänderter Dateien in einen bereitgestellten Container, um die Effizienz des lokalen Entwicklungsworkflows zu verbessern und die Neuerstellung, erneute Bereitstellung und den Neustart von Pods zu vermeiden. Wenn Sie also Änderungen an statischen und Quellcodedateien arbeiten, können Sie sehen, dass Ihre Änderungen in Sekundenschnelle wirksam werden, was zu einer beschleunigten Feedback Loop ein.

Bei statischen Dateien (z. B. HTML- und CSS-Dateien) wird dieses Kopierverhalten als Dateisynchronisierung bezeichnet.

Bei Quellcodedateien wird dieses Verhalten als Hot Reload bezeichnet und unterstützt die folgenden Dateitypen:

  • Go: *.go
  • Java: *.java, *.kt, *.scala, *.groovy, *.clj
  • NodeJS: *.js, *.mjs, *.coffee, *.litcoffee, *.json

Wenn Hot Refresh konfiguriert ist, erkennt Skaffold Änderungen an unterstützten Dateien und synchronisiert diese Änderungen am ausgeführten Container in Ihrem Cluster vorzunehmen. Änderungen an Dateitypen, die keine Hotline unterstützen neu erstellen und Pod-Neustart auslösen.

Die automatische Dateisynchronisierung und Hot Reload sind standardmäßig aktiviert, wenn Sie mit Buildpacks als Ihrem bevorzugten Builder arbeiten. Für andere Builder wie Docker können Sie in der Datei skaffold.yaml einen sync-Abschnitt für das anzupassende Artefakt angeben.

Folgende Synchronisierungseinstellungen können festgelegt werden (in der Reihenfolge ihrer Präferenz):

  • auto: Skaffold konfiguriert die Synchronisierung automatisch. (nur für Jib und Buildpacks) artifacts.) Dies ist die Standardeinstellung für Buildpacks.
  • infer: Die Ziele für jede geänderte Datei werden vom Builder abgeleitet.
  • manual: Sie müssen die Dateien in Ihrem lokalen Arbeitsbereich und ihr Ziel im laufenden Container angeben.

Der folgende Beispielabschnitt sync in einer skaffold.yaml-Datei gibt eine manual synchronisieren, um alle /static-html-HTML-Dateien mit static zu synchronisieren Ordner in einem Container:

build:
  artifacts:
    - image: gcr.io/k8s-skaffold/node-example
      context: node
      sync:
        manual:
          - src: 'static-html/*.html'
            dest: static

Einen detaillierten Blick auf die Dateisynchronisierung und die Angabe von Synchronisierungsregeln finden Sie im Skaffold-Leitfaden zur Dateisynchronisierung.

Neue Features beim Entwickeln in Kubernetes hinzufügen

Starten Sie nach der Einrichtung der Dateisynchronisierung und des Hot Refreshs einen Iterationszyklus und fügen Sie mehr Funktionen hinzufügen. Ihre Änderungen werden in Kubernetes bereitgestellt ohne das Deployment anzuhalten und zu entfernen, das Image mit Tags versehen oder den Cluster aktualisieren.

Ein standardmäßiger Iterationszyklus sieht in etwa so aus:

  1. Nehmen Sie eine Änderung an Ihrem Projekt vor. Wenn Sie beispielsweise die Cloud Code Java-Gästebuch-App verwenden, fügen Sie der Klasse FrontendController so einen neuen Endpunkt hinzu:

    1. Öffnen Sie die Datei FrontendController.java aus src/main/java/cloudcode/guestbook/frontend und fügen Sie Folgendes hinzu:

      @RequestMapping("/greeting")
@ResponseBody
public String greeting(@RequestParam(value="name", defaultValue="World") String name) {
   return String.format("Hello from Kubernetes with IntelliJ, %s!", name);
}

    2. Fügen Sie die erforderlichen Importe für die neuen Annotationen RequestMapping und ResponseBody hinzu.

  2. Speichern Sie die Änderungen (Ctrl/Cmd+S) oder erstellen Sie das Projekt.

    Im Konsolenfenster können Sie Fortschritts- und Bereitstellungslogs aufrufen. Bestätigen Sie die Updates, nachdem die Änderungen bereitgestellt wurden.

  3. Klicken Sie zum Beenden der kontinuierlichen Entwicklungssitzung auf das Symbol Beenden.

    Cloud Code löscht alle für die Entwicklungssitzung verwendeten Kubernetes-Ressourcen.

Mikrodienstanwendungen mit Skaffold-Konfigurationen entwickeln

Bei der Entwicklung von Mikrodienstanwendungen kann es hilfreich sein, an separaten um Debugging und Bereitstellung zu vereinfachen.

Sie können Teile Ihrer Anwendung unabhängig entwickeln und debuggen, indem Sie Skaffold-Module hinzufügen. Die Beispielanwendung Bank of Anthos ist beispielsweise eine Anwendung mit zehn Mikrodiensten. Das Beispiel skaffold.yaml diese Dienste in fünf Skaffold-Module namens setup, db, frontend, backend und loadgenerator.

Skaffold-Module und Konfigurationsabhängigkeiten definieren

So definieren Sie Skaffold-Module und Konfigurationsabhängigkeiten:

  1. Öffnen Sie das Projekt, in dem Sie die Module definieren möchten.

  2. Öffnen Sie die Datei skaffold.yaml.

  3. Wenn Ihre skaffold.yaml-Datei mehrere Konfigurationen hat, Konfigurieren Sie ein Skaffold-Modul, indem Sie die folgende Zeile angeben:

    metadata:
  name: MODULE_NAME_1

    In der skaffold.yaml der Bank of Anthos definiert das Modul db beispielsweise Datenbankbereitstellungen:

    apiVersion: skaffold/v3
kind: Config
metadata:
  name: db # module defining database deployments
requires:
- configs:
  - setup
build:
  artifacts:
  - image: accounts-db
    context: src/accounts-db
  - image: ledger-db
    context: src/ledger-db
manifests:
  rawYaml:
  - dev-kubernetes-manifests/accounts-db.yaml
  - dev-kubernetes-manifests/ledger-db.yaml
deploy:
  kubectl: {}

  4. Bei Konfigurationen, die auf einer anderen Konfiguration basieren, bevor die aktuelle Konfiguration bereitgestellt werden kann, müssen Sie die Konfiguration den Abhängigkeiten hinzufügen. Wenn Sie eine Konfigurationsabhängigkeit angeben möchten, fügen Sie dem Abschnitt requires der Datei skaffold.yaml eine Liste vom Typ configs hinzu.

    Die skaffold.yaml-Datei der Bank of Anthos enthält beispielsweise die Konfigurationsabhängigkeit setup.

    Zum Definieren einer Abhängigkeit fügen Sie der Datei skaffold.yaml Folgendes hinzu: DEPENDENCY_NAME ist der Name der Abhängigkeit.

    requires:
    - configs: DEPENDENCY_NAME

    Auf diese Weise aufgeführte Konfigurationen können auf Abhängigkeiten verweisen, die im dieselbe Datei oder andere skaffold.yaml-Dateien im aktuellen Projekt.

  5. Testen Sie Ihre Konfigurationsabhängigkeiten, indem Sie jedes Skaffold-Modul separat erstellen. So können Sie prüfen, ob diese mit ihren Abhängigkeiten bereitgestellt werden. Führen Sie dazu die Schritte unter Bestimmte Skaffold-Module und ihre Abhängigkeiten erstellen aus.

Bestimmte Skaffold-Module und deren Abhängigkeiten erstellen

Nachdem Sie Ihre Module und ihre Abhängigkeiten definiert haben, können Sie in der launch.json-Datei angeben, welche Module mit Cloud-Code ausgeführt werden sollen.

Wenn für Ihr Projekt keine launch.json-Datei definiert ist, werden Sie beim Ausführen von Cloud Code: Auf Kubernetes ausführen oder Cloud Code: Debuggen in Kubernetes aufgefordert, die zu erstellenden Module auszuwählen.

  1. Öffnen Sie die Befehlspalette (Ctrl/Cmd+Shift+P) und führen Sie dann Cloud Code: Auf Kubernetes ausführen aus.
  2. Klicken Sie auf Module auswählen.
  3. Wählen Sie die Module aus, die Sie bereitstellen möchten, und klicken Sie dann auf OK. Jedes Modul wird mit seinen Abhängigkeiten erstellt.
  4. Wenn Sie dazu aufgefordert werden, wählen Sie eine Image-Registry aus und drücken Sie dann Enter.

Wenn Ihr Projekt ein launch.json hat, gehen Sie so vor, um das Skaffold auszuwählen. zu erstellende Module:

  1. Öffnen Sie die launch.json-Datei Ihres Projekts.

  2. Bearbeiten Sie die Startkonfiguration, um die Option skaffoldFlags mit einer durch Kommas getrennten Liste von modules hinzuzufügen. Wenn skaffoldFlags weggelassen wird, werden alle Module erstellt.

      {
    "name": "Run on Kubernetes",
    "type": "cloudcode.kubernetes",
    "request": "launch",
    "skaffoldConfig": "${workspaceFolder}/skaffold.yaml",
    "skaffoldFlags": {
       "modules": ["MODULE_NAME_2,MODULE_NAME_2"],
    "watch": true,
    "cleanUp": true,
    }
  }

  3. Führen Sie die bearbeitete Startkonfiguration aus.

Kontinuierliche Entwicklung in Kubernetes

Nachdem Sie das Ausführungsziel mit den gewünschten Optionen konfiguriert haben, können Sie die Anwendung entweder regelmäßig ausführen oder einen Entwicklungsdurchlauf in Ihrer IDE starten, um eventuelle Änderungen an der Quelle und Abhängigkeiten in die Live-Anwendung zu übernehmen.

Das Ausführungsziel Auf Kubernetes ausführen startet den Entwicklungszyklus für einen Kubernetes-Cluster. Nach dem Start des Entwicklungszyklus Cloud Code erstellt mit Skaffold ein Image für die und taggt es, überträgt es per Push in das konfigurierte Repository und verwendet kubectl die Kubernetes-Manifeste des Projekts bereitstellen.

  1. Passen Sie die Bereitstellung mit den verfügbaren Konfigurationsoptionen an.
  2. Wenn Ihre Anwendung für die Verwendung von Skaffold-Module können Sie Sie können bestimmte Module zum Erstellen oder Bereitstellen auswählen.
  3. Ö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.
  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. Weitere Informationen zum Einrichten eines Kubernetes-Kontexts finden Sie unter Konfiguration einrichten.

  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 für Ihr Projekt die Artifact Registry API aktiviert ist und es mindestens ein Artifact Registry-Repository gibt, können Sie ein vorhandenes Artifact Registry-Repository aufrufen und auswählen.

    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.

Nächste Schritte