Mit Google Cloud- und Kubernetes-YAML-Dateien in Cloud Code for IntelliJ arbeiten

Cloud Code unterstützt Sie bei der Bearbeitung von Konfigurationsdateien für Google Cloud und Kubernetes, darunter Dateien zur schemabasierten Validierung, Diagnose und Kurzdokumentation.

Unterstützte YAML-Konfigurationsdateien

Cloud Code unterstützt auch gängige und sofort einsetzbare Kubernetes-CRDs wie Kubeflow.

YAML-Unterstützung aktivieren oder deaktivieren

Wenn Sie die YAML-Unterstützung aktivieren oder deaktivieren möchten, klicken Sie auf Datei > Einstellungen > Tools > Gemini + Google Cloud Code > Kubernetes (für Windows und Linux) oder IntelliJ IDEA > Einstellungen > Tools > Gemini + Google Cloud Code > Kubernetes (für macOS) und klicken Sie das Kästchen YAML-Unterstützung aktivieren an oder aus, um die Funktion zu aktivieren oder zu deaktivieren.

Benutzerdefiniertes Schema verwenden

Mit Cloud Code können Sie Ihr eigenes CRD-Schema mit IntelliJ-Einstellungen angeben. Klicken Sie dazu auf Datei > Einstellungen > Tools > Gemini + Google Cloud Code > Kubernetes (für Windows und Linux) oder IntelliJ IDEA > Einstellungen > Tools > Gemini + Google Cloud Code > Kubernetes (für macOS) und lesen Sie dann den Abschnitt CRD-Schema-Standorte.

Sie können entweder auf eine lokale Datei oder eine URL verweisen. URLs, die auf github.com verweisen, werden automatisch in raw.githubusercontent.com umgewandelt.

Schema aus einem Cluster abrufen

Wenn Sie im Kubernetes Explorer zu einem Cluster mit Kubernetes v1.16+ wechseln, ruft Cloud Code automatisch das Schema aller installierten CRDs ab.

Weitere Skaffold-Unterstützung

Skaffold ist die Cloud Code zugrunde liegende Engine. Sie hilft Ihnen beim Erstellen, Übertragen und Bereitstellen Ihrer Anwendung und bietet Unterstützung für CI-/CD-Pipelines.

Cloud Code unterstützt zusätzlich die Verwaltung von Skaffold-Konfigurationsdateien. Wenn Sie ein Projekt öffnen, erkennt Cloud Code Skaffold-Schemas, die nicht aktuell sind, und informiert Sie (über das Ereignisprotokoll), wenn für Ihre vorhandenen Skaffold-YAML-Konfigurationsdateien ein Upgrade verfügbar ist.

Benachrichtigung im Ereignisprotokoll, über die der Nutzer aufgefordert wird, ein Upgrade der Skaffold-Schemaversion durchzuführen, da die vorhandenen YAML-Dateien nicht die neueste Version haben

Alternativ können Sie Tools > Gemini + Cloud Code > Kubernetes > Auf Skaffold Schema-Upgrades prüfen aufrufen, um nach verfügbaren Schema-Upgrades zu suchen.

Mit Snippets konfigurieren

Mit den sofort einsatzbereiten Snippets für gängige YAML-Schemas (mit Strg + Leertaste zum Aufrufen von Optionen) können Sie eine neue YAML-Datei erstellen oder eine vorhandene Datei fehlerfrei ergänzen und dabei Best Practices einhalten. Außerdem wird die Arbeit mit sich wiederholenden Feldern vereinfacht. Wenn Sie eines der Felder ausfüllen, werden die verbleibenden Instanzen automatisch ausgefüllt.

Snippets für sich wiederholende Felder verwenden

Cloud Code bietet die folgenden Snippets:

  • Cloud Build - Cloud Run deployment
  • Cloud Build - Docker container build
  • Cloud Build - GKE deployment
  • Cloud Build - GKE Skaffold deployment
  • Cloud Build - Go build
  • Cloud Build - Terraform plan + apply
  • Config Connector - BigQueryDataset
  • Config Connector - BigQueryTable
  • Config Connector - BigtableCluster
  • Config Connector - BigtableInstance
  • Config Connector - PubSubSubscription
  • Config Connector - PubSubTopic
  • Config Connector - RedisInstance
  • Config Connector - SpannerInstance
  • Kubernetes - ConfigMap
  • Kubernetes - Deployment
  • Kubernetes - Ingress
  • Kubernetes - Pod
  • Kubernetes - Service
  • Migrate to Containers - Export
  • Migrate to Containers - PersistentVolumeClaim
  • Migrate to Containers - StatefulSet
  • Skaffold - Bazel
  • Skaffold - Getting-started
  • Skaffold - Helm deployment
  • Skaffold - Kaniko

Kontextbezogene Vervollständigung

Anhand des aktuellen Schemas stellt Cloud Code eine kontextbezogene Vervollständigung für die Auswahl der richtigen Option bereit.

Kontextvervollständigung für Kubernetes-Schemas

YAML-Schema prüfen

Cloud Code bietet Unterstützung für die Schemavalidierung. Dazu werden ungültige Tags und Werte in Ihren YAML-Dateien mit Flags versehen und es werden nach Möglichkeit Korrekturen empfohlen.

Wert des Namensfelds „rot“ unterstrichen Text, um einen ungültigen Wert von 1234 hervorzuheben; Hover-Text zeigt: „Falscher Typ. Erwarteter String.

Skaffold-YAML-Dateien validieren

Cloud Code unterstützt die Bearbeitung von Skaffold-Konfigurationsdateien und enthält intelligente Vorlagen, mit denen Sie Ihre skaffold.yaml-Dateien validieren können. Weitere Informationen finden Sie im Leitfaden zur Verwendung einer vorhandenen Anwendung mit Cloud Code.

Grafik: Skaffold-YAML-Vorlagen

Skaffold-Konfigurationsdateien mit Kontext vervollständigen

Anhand des aktuellen Schemas stellt Cloud Code eine kontextbezogene Vervollständigung und entsprechende Dokumente für die Auswahl der richtigen Option bereit.

Grafik: Skaffold-Vervollständigungen

Definitionen mithilfe der Schnelldokumentation abrufen

Cloud Code zeigt Ihnen die passende Dokumentation zu einer Ressource an, wenn Sie eine Zeile in Ihrer Konfigurationsdatei markieren und Ansicht > Schnelldokumentation auswählen.

Grafik: Kurzdokumentation

YAML auf strukturelle und Gültigkeitsprobleme prüfen

Cloud Code bietet Linting-Unterstützung für gängige Schemaprobleme und stellt Fehlerbeschreibungen bereit.

Grafik: Linting von YAML-Dateien

YAML-Datei anwenden

Wenn Sie kubectl apply -f ausführen möchten, um eine Konfigurationsänderung mithilfe der aktuellen Datei anzuwenden, können Sie das kubectl-Aktionssymbol Symbol: kubectl-Aktionen verwenden, das im Bundsteg Ihrer IDE verfügbar ist, und Anwenden auswählen. Dadurch wird eine Übersicht angezeigt, in der Sie die Änderungen vor dem Klicken auf Übernehmen prüfen können.

Option „Anwenden“ in der kubectl-Aktionsliste hervorgehoben

YAML-Dateien vergleichen

Wenn Sie die Unterschiede zwischen einer YAML-Datei in der Versionsverwaltung und einer bereitgestellten YAML-Datei sehen möchten, können Sie das kubectl-Aktionssymbol Symbol: kubectl-Aktionen im Bundsteg Ihres Editors verwenden. Wählen Sie die Option Diff aus, um eine Ansicht mit den Unterschieden aufzurufen, in der Sie zwei Schemadateien vergleichen und gegenüberstellen können.

Option „Diff“ in der kubectl-Aktionsliste hervorgehoben

Probelauf einer YAML-Datei ausführen

Einen Probelauf Ihrer Datei und die Überprüfung ihrer Gültigkeit können Sie mit dem kubectl-Aktionssymbol Symbol: kubectl-Aktionen prüfen, das im Bundsteg Ihrer IDE verfügbar ist, und wählen Sie Probelauf auf Server oder Probelauf auf Client. Dadurch wird kubectl apply -f dry-run=server (oder kubectl apply -f dry-run=client für die Clientoption) ausgeführt und Sie werden benachrichtigt, ob Ihre Datei erfolgreich in Ihrem Terminalfenster erstellt werden kann.

Option „Probelauf auf Server“ in der kubectl-Aktionsliste hervorgehoben

Nächste Schritte

Support anfordern

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.