Travailler avec les fichiers YAML Google Cloud et Kubernetes dans Cloud Code pour VS Code

Cloud Code for VS Code est conçu pour rendre Kubernetes et Cloud Build configuration plus facile en effectuant une analyse lint du schéma pour la structure et les valeurs valides, en fournissant des erreurs descriptives. Cloud Code est fourni avec des solutions prêtes à l'emploi pour les fonctions courantes de schéma, de saisie intelligente et de documentation par survol de la souris.

Fichiers de configuration YAML compatibles

Cloud Code est également compatible avec les ressources personnalisées Kubernetes (CRD), comme Kubeflow, prêt à l'emploi.

Utiliser un schéma personnalisé

Avec Cloud Code, vous pouvez fournir votre propre schéma CRD avec le cloudcode.yaml.crdSchemaLocations paramètre dans votre settings.json . Vous pouvez le faire pointer vers un fichier local ou une URL. Les URL pointant vers github.com sont automatiquement en raw.githubusercontent.com.

Extraire le schéma d'un cluster

Lorsque vous basculez vers un cluster exécutant Kubernetes 1.16 ou une version ultérieure dans la Kubernetes, Cloud Code extrait automatiquement le schéma toutes les CRD installées.

Configurer avec des extraits

Les extraits prêts à l'emploi pour les schémas YAML courants (la combinaison Command/Ctrl+Space permettant d'afficher les options) facilitent la création de nouveaux fichiers YAML ou l'ajout de sections à des fichiers existants. Ils aident à travailler sans erreur, tout en respectant les bonnes pratiques. Cloud Code facilite le travail avec les champs répétitifs en remplissant le reste après avoir rempli le premier champ.

Cloud Code propose les extraits de code suivants :

  • 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

Complétez avec le contexte

Sur la base du schéma actuel, Cloud Code fournit des informations des lectures complètes et des documents pertinents pour vous aider à choisir la bonne option.

Saisie avec contexte pour le schéma Kubernetes

Valider le schéma YAML

Cloud Code offre une assistance pour la validation du schéma en signalant les valeurs et les tags non valides dans vos fichiers YAML, et en suggérant des corrections lorsque cela est possible.

Valeur du champ "Nom" soulignée en rouge pour mettre en surbrillance la valeur "1234" non valide. États du texte de l'info-bulle: type incorrect. Chaîne attendue.

Consulter la documentation par survol de la souris

Cloud Code met à votre disposition la documentation pertinente sur une valeur du schéma.

Informations de documentation lorsque vous maintenez le pointeur sur une valeur du schéma

Accéder aux définitions de ressources

Pour afficher les définitions d'une ressource, effectuez un clic droit sur la ressource, puis sélectionnez Accédez à la définition ou à l'aperçu de la définition.

Appliquer un fichier YAML

Pour appliquer une modification de configuration à l'aide du fichier actuel, ouvrez la commande (appuyez sur Ctrl/Cmd+Shift+P ou cliquez sur Affichage > Palette de commandes) puis exécutez la commande Cloud Code: Appliquer le fichier JSON/YAML actuel à la ressource K8s déployée.

Cette commande affiche une vue de comparaison qui vous permet d'examiner les modifications. Cliquez sur Appliquer lorsque vous êtes invité à appliquer la modification. Cela a pour effet d'exécuter kubectl apply -f.

Afficher les différences entre les fichiers YAML

Pour afficher les différences entre un fichier YAML dans le contrôle du code source et un fichier YAML, ouvrez la palette de commandes (appuyez sur Ctrl/Cmd+Shift+P ou cliquez sur Affichage > Palette de commandes), puis exécutez Cloud Code: fichier JSON/YAML différencié avec la ressource K8s déployée.

Effectuer une simulation d'un fichier YAML

Cloud Code effectue automatiquement des simulations à mesure que vous saisissez des informations. dans votre fichier YAML et souligne les erreurs par une ligne jaune ondulée.

Des lignes jaunes ondulées apparaissent lorsque le serveur prend en compte une partie de votre code une erreur basée sur le résultat d'une simulation. Cela peut inclure le non-respect des règles, les noms en double ou les validations sur lesquelles Cloud Code n'effectue pas l'opération côté client (comme le nombre maximal de ports).

Pour afficher la description de l'erreur dans votre fichier YAML, pointez sur souligné en jaune du code.

Échec de "dry run" de la configuration actuelle pour la validation côté serveur, avec message d'erreur fourni sous forme de notificaiton toast. Les détails de l'erreur se trouvent dans le canal de sortie. L'espace de noms "random-namespace" n'existe pas.

Des lignes rouges ondulées apparaissent avant Cloud Code pour signaler les erreurs détectées auprès du serveur Kubernetes. Par exemple, si vous indiquez un nombre au début déclenche une ligne rouge ondulée.

Utiliser des secrets

Les mappages de configuration et secrets est un élément clé de l'utilisation de Kubernetes. Pour afficher le contexte d'une requête avec Cloud Code, placez le pointeur sur le secret pour le décoder

Décodez un secret en maintenant le pointeur sur celui-ci

Étape suivante

Obtenir de l'aide

Pour envoyer vos commentaires, signalez tout problème sur GitHub ou posez une question sur Stack Overflow.