Mit Google Cloud und Kubernetes YAML in Cloud Code for VS Code arbeiten

Cloud Code for VS Code wurde entwickelt, um die Konfiguration von Kubernetes und Cloud Build zu vereinfachen, indem Schemas sowohl nach Struktur als auch nach gültigen Werten gefiltert und beschreibende Fehler zurückgegeben werden. Zusammen mit Cloud Code erhalten Sie sofort einsatzbereite Lösungen für allgemeine Schemas, intelligente Vervollständigung und Dokumentation durch Mauszeigerbewegung.

Unterstützte YAML-Konfigurationsdateien

Cloud Code unterstützt außerdem gängige benutzerdefinierte Kubernetes-Ressourcendefinitionen (CRDs) wie Kubeflow.

Benutzerdefiniertes Schema verwenden

Mit Cloud Code können Sie Ihr eigenes CRD-Schema mit der Einstellung cloudcode.yaml.crdSchemaLocations in der Datei settings.json bereitstellen. Sie können entweder auf eine lokale Datei oder eine URL verweisen. URLs, die auf github.com verweisen, werden automatisch in raw.githubusercontent.com konvertiert.

Schema aus einem Cluster abrufen

Wenn Sie in der Kubernetes-Ansicht zu einem Cluster wechseln, auf dem Kubernetes v1.16 oder höher ausgeführt wird, ruft Cloud Code automatisch das Schema aller installierten CRDs ab.

Mit Snippets konfigurieren

Sofort einsatzbereite Snippets für gängige YAML-Schemas (mit Command/Ctrl+Space zum Aufrufen von Optionen) vereinfachen das Starten einer neuen YAML-Datei und das fehlerfreie Hinzufügen zu einer vorhandenen Datei. Dabei werden Best Practices beachtet. Cloud Code erleichtert die Arbeit mit sich wiederholenden Feldern, da die verbleibenden Instanzen nach dem Ausfüllen des ersten Felds ausgefüllt werden.

Cloud Code bietet die folgenden Snippets:

  • Anthos Config Management - Cluster
  • Anthos Config Management - Cluster Selector
  • Anthos Config Management - Config Management
  • Anthos Config Management - Namespace Selector
  • 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 - Secret
  • Kubernetes - Service
  • Migrate to Containers - Export
  • Migrate to Containers - PersistentVolumeClaim
  • Migrate to Containers - StatefulSet
  • Skaffold - Bazel
  • Skaffold - Getting-started
  • Skaffold - Helm deployment
  • Skaffold - Kaniko

Mit Kontext vervollständigen

Basierend auf dem aktuellen Schema bietet Cloud Code kontextbezogene Vervollständigungen und relevante Dokumente, die Ihnen bei der Auswahl der richtigen Option helfen.

Kontextvervollständigung für Kubernetes-Schemas

YAML-Schema validieren

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, um den ungültigen Wert 1234 hervorzuheben; Hover-Text zeigt an: Falscher Typ. Erwarteter String.

Dokumentation aufrufen, wenn der Mauszeiger darauf bewegt wird

Cloud Code zeigt relevante Dokumentation an, wenn Sie den Mauszeiger auf einen Wert im Schema bewegen.

Dokumentationsinformationen, wenn Sie den Mauszeiger auf einen Wert im Schema bewegen

Auf Ressourcendefinitionen zugreifen

Wenn Sie die Definitionen für eine Ressource ansehen möchten, klicken Sie mit der rechten Maustaste auf die Ressource und wählen Sie dann Go to Definition (Zur Definition) oder Peek Definition (Definition aufrufen) aus.

YAML-Datei anwenden

Öffnen Sie zum Anwenden einer Konfigurationsänderung mit der aktuellen Datei die Befehlspalette. Drücken Sie dazu Ctrl/Cmd + Shift + P oder klicken Sie auf Ansicht > Befehlspalette. Führen Sie dann Cloud Code: Aktuelle JSON/YAML-Datei auf K8s bereitgestellte Ressource anwenden aus.

Mit diesem Befehl wird eine Unterschiedsansicht angezeigt, mit der Sie Änderungen prüfen können. Klicken Sie auf Anwenden, wenn Sie gefragt werden, ob Sie diese Änderung anwenden möchten. Dadurch wird kubectl apply -f ausgeführt.

Unterschiede zwischen YAML-Dateien ansehen

Wenn Sie sich die Unterschiede zwischen einer YAML-Datei in der Versionsverwaltung und einer bereitgestellten YAML-Datei ansehen möchten, öffnen Sie die Befehlspalette. Drücken Sie dazu Ctrl/Cmd + Shift + P oder klicken Sie auf Ansicht > Befehlspalette. Führen Sie dann Cloud Code: Diff Current JSON/YAML File with K8s Deployed Resource aus.

Probelauf einer YAML-Datei ausführen

Cloud Code führt automatisch Probeläufe aus, während Sie Informationen in die YAML-Datei eingeben. Fehler werden mit einer gelben, verschnörkelten Zeile unterstrichen.

Gelbe, verschnörkelte Linien werden angezeigt, wenn der Server einen Teil Ihres Codes aufgrund eines Probelaufs als Fehler betrachtet. Dazu können Richtlinienverstöße, doppelte Namen oder Validierungen gehören, die Cloud Code clientseitig nicht durchführt (z. B. maximale Portnummern).

Halten Sie den Mauszeiger über den gelb unterstrichenen Code, um die Beschreibung des Fehlers in Ihrer YAML-Datei anzuzeigen.

Die serverseitige Validierung des Probelaufs schlägt in „hello.deployment.yaml“ fehl und eine Fehlermeldung wird als Toast angezeigt. Die Fehlerdetails finden Sie im Ausgabekanal. Der Namespace „random-namespace“ ist nicht vorhanden

Vor der Cloud Code-Prüfung mit dem Kubernetes-Server werden für erkannte Fehler rote, verschnörkelte Linien angezeigt. Wenn z. B. eine Zahl für einen String eingefügt wird, wird eine rote, verschnörkelte Linie ausgelöst.

Mit Secrets arbeiten

Die Verwendung von Konfigurationszuordnungen und secrets ist ein wichtiger Bestandteil der Arbeit mit Kubernetes. Wenn Sie den Kontext eines base64-Secrets mit Cloud Code ansehen möchten, halten Sie den Mauszeiger über das Secret, um es zu decodieren.

Secret decodieren, indem du den Mauszeiger über das Secret hältst

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.