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

Cloud Code pour VS Code est conçu pour faciliter la configuration de Kubernetes et de Cloud Build en appliquant des fonctions d'analyse lint au schéma pour la structure et les valeurs valides, et 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 définitions de ressources personnalisées (CRD, Custom Resource Definition) Kubernetes courantes, telles que Kubeflow, prêtes à l'emploi.

Utiliser un schéma personnalisé

Avec Cloud Code, vous pouvez fournir votre propre schéma CRD avec le paramètre cloudcode.yaml.crdSchemaLocations dans votre fichier settings.json. Vous pouvez le faire pointer vers un fichier local ou une URL. Les URL pointant vers github.com sont automatiquement converties au format 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 vue Kubernetes, Cloud Code extrait automatiquement le schéma de tous les objets CRD installés.

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 l'utilisation des champs répétitifs en remplissant les instances restantes après avoir renseigné 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 saisies contextuelles 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 non valide 1234. Le texte de l'info-bulle indique que le type est incorrect. Chaîne attendue.

Consulter la documentation par survol de la souris

Cloud Code fournit la documentation pertinente lorsque vous maintenez le pointeur 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 choisissez Go to Definition (Accéder à la définition) ou Peek Definition (Accéder à la définition).

Appliquer un fichier YAML

Pour appliquer une modification de configuration à l'aide du fichier actuel, ouvrez la palette de commandes (appuyez sur Ctrl/Cmd+Shift+P ou cliquez sur Affichage > Palette de commandes), puis exécutez 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 dépôt source et un fichier YAML déployé, ouvrez la palette de commandes (appuyez sur Ctrl/Cmd+Shift+P ou cliquez sur Affichage > Palette de commandes), puis exécutez Cloud Code: Diff Current JSON/YAML File with K8s Deployed Resource.

Effectuer une simulation d'un fichier YAML

Cloud Code effectue automatiquement des simulations lorsque 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 considère une partie de votre code comme une erreur en fonction du résultat d'une simulation. Cela peut inclure des cas de non-respect des règles, des noms en double ou des validations que Cloud Code n'effectue pas côté client (telles que le nombre maximal de numéros de port).

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

É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 pour les erreurs détectées avant que Cloud Code ne vérifie auprès du serveur Kubernetes. Par exemple, saisir un nombre à la place d'une chaîne déclenche une ligne rouge ondulée.

Utiliser des secrets

L'utilisation de mappages de configuration et de secrets est un élément clé de l'utilisation de Kubernetes. Pour afficher le contexte d'un secret base64 avec Cloud Code, pointez sur le secret afin de le décoder.

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

Étapes suivantes

Assistance

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