Entwicklung in Cloud Code for IntelliJ beschleunigen

Um Ihre lokale Entwicklung in Cloud Code for IntelliJ zu beschleunigen, nutzen Sie die Dateisynchronisierung und das Hot Refresh-Verfahren, die automatische Bereitstellung beim Speichern und verwenden Skaffold-Module, um Teile einer Anwendung separat zu entwickeln.

Skaffold-Dateisynchronisierung und Hot Refresh aktivieren

Skaffold unterstützt das Kopieren geänderter Dateien in einen bereitgestellten Container, um Ihren lokalen Entwicklungsworkflow effizienter zu gestalten und Pods nicht neu erstellen, neu bereitstellen und neu starten zu müssen. Wenn Sie also Änderungen an statischen Dateien und Quellcodedateien vornehmen, werden die Änderungen innerhalb weniger Sekunden wirksam, was zu einer beschleunigten Feedbackschleife führt.

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 mit dem ausgeführten Container im Cluster. Änderungen an Dateitypen, die kein Hot Refresh unterstützen, lösen eine Image-Neuerstellung und einen Pod-Neustart aus.

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 Artefakt angeben, das Sie anpassen.

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

  • auto: Skaffold konfiguriert die Synchronisierung automatisch. (nur für Jib- und Buildpacks-Artefakte.) 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 ausgeführten Container angeben.

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

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

Nachdem Sie die Dateisynchronisierung und das Hot Refresh eingerichtet haben, starten Sie einen Iterationszyklus und fügen Sie Ihrem Projekt weitere Funktionen hinzu. Die Änderungen werden in Ihrem Kubernetes-Cluster bereitgestellt, ohne das Deployment anzuhalten und zu entfernen, das Image manuell zu erstellen und zu taggen oder den Cluster zu aktualisieren.

Ein Standard-Iterationszyklus sieht etwa so aus:

  1. Nehmen Sie eine Änderung an Ihrem Projekt vor. Wenn Sie beispielsweise die Cloud Code Java Guestbook-Anwendung verwenden, fügen Sie der FrontendController-Klasse 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 Ihre Ä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 auf das Symbol Beenden, um die Sitzung der kontinuierlichen Entwicklung zu 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, unabhängig an separaten Abschnitten zu arbeiten, um die Fehlerbehebung und Bereitstellung zu vereinfachen.

Sie können Teile Ihrer Anwendung unabhängig entwickeln und debuggen, indem Sie Ihre Anwendung in Skaffold-Module aufteilen. Das Beispiel Bank of Anthos ist beispielsweise eine Anwendung mit zehn Mikrodiensten. Die Datei skaffold.yaml des Beispiels gruppiert 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 die Datei skaffold.yaml mehrere Konfigurationen hat, geben Sie die folgende Zeile an, um eine Konfiguration zu einem Skaffold-Modul zu machen:

    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 davon abhängen, dass eine andere Konfiguration bereitgestellt wird, bevor die aktuelle Konfiguration bereitgestellt werden kann, müssen Sie die Konfiguration Ihren Abhängigkeiten hinzufügen. Wenn Sie eine Konfigurationsabhängigkeit angeben möchten, fügen Sie dem Abschnitt requires der Datei skaffold.yaml eine configs-Liste 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, wobei DEPENDENCY_NAME der Name der Abhängigkeit ist.

    requires:
    - configs: DEPENDENCY_NAME

    Auf diese Weise aufgeführte Konfigurationen können auf Abhängigkeiten verweisen, die in derselben Datei oder in anderen skaffold.yaml-Dateien im aktuellen Projekt definiert sind.

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

Bestimmte Skaffold-Module und deren Abhängigkeiten erstellen

Nachdem Sie die Module und deren Abhängigkeiten definiert haben, können Sie auf dem Tab Build/Deploy (Erstellen/Bereitstellen) angeben, welche Module ausgeführt werden sollen. Wählen Sie dazu Run > Edit configuration (Ausführen > Konfigurationen bearbeiten) aus.

  1. Installieren Sie die neuesten Insider-Builds.

  2. Klicken Sie auf Ausführen > Konfigurationen bearbeiten und öffnen Sie den Tab Erstellen / Bereitstellen.

  3. Wählen Sie für die Skaffold-Konfiguration die Datei skaffold.yaml aus.

    Wählen Sie eine der folgenden Optionen aus:

    • Mit allen Modulen und Abhängigkeiten erstellen und bereitstellen
    • Erstellen und bereitstellen mit (wenn Module verfügbar sind) und wählen Sie die Module aus, die Sie erstellen und bereitstellen möchten.

Ihre Auswahl bleibt für nachfolgende Bereitstellungen erhalten. Wenn Sie nur einen Teil der Module auswählen, zeigt Cloud Code eine Warnung zum Bereitstellen einer Teilmenge von Modulen und nicht des gesamten Systems an.

Kontinuierliche Entwicklung in Kubernetes

Nachdem Sie das Ausführungsziel mit den gewünschten Optionen konfiguriert haben, können Sie sich entweder für eine regelmäßige Ausführung Ihrer Anwendung entscheiden oder einen Entwicklungsiterationszyklus in Ihrer IDE starten, um alle Änderungen an der Quelle und den Abhängigkeiten an Ihre Live-Anwendung zu übertragen.

Das Ausführungsziel Develop on Kubernetes startet den Entwicklungszyklus auf Ihrem Kubernetes-Cluster. Nachdem Sie den Entwicklungszyklus gestartet haben, erstellt Cloud Code mithilfe von Skaffold ein Image für das Projekt, taggt es, überträgt es per Push an das konfigurierte Repository und stellt mithilfe von kubectl die Kubernetes-Manifeste des Projekts bereit.

  1. Klicken Sie auf das Symbol Develop on Kubernetes und dann auf Edit Configurations, um das Dialogfeld Run/Debug Configurations zu öffnen.
  2. Passen Sie Ihre Bereitstellung mithilfe der verfügbaren Konfigurationsoptionen an.
  3. Wenn Sie möchten, dass Cloud Code Ihre Anwendung automatisch noch einmal bereitstellt, nachdem Ihre Änderungen gespeichert wurden, wählen Sie unter Watch mode - rebuild and redeploy die Option On filesave aus. Bei neuen Kubernetes-Anwendungen ist standardmäßig On demand ausgewählt. Weitere Informationen zu Uhr-Modi findest du unter Smartwatch-Modi.
  4. Wenn Ihre Anwendung für die Verwendung von Skaffold-Modulen konfiguriert ist, können Sie nur bestimmte Module erstellen oder bereitstellen.
  5. Wenn Sie mit der Konfiguration zufrieden sind, klicken Sie auf OK und dann auf das Symbol Ausführen.

Nächste Schritte

Support kontaktieren

So senden Sie Feedback oder melden ein Problem in Ihrer IntelliJ-IDE: Tools > Cloud Code > Hilfe / Info > Feedback geben oder Problem melden, um ein Problem auf GitHub zu melden oder stellen Sie eine Frage zu Stack Overflow.