Utiliser Google Cloud et Kubernetes YAML 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 effet, les fonctions d'analyse lint sur la structure et les valeurs valides sont présentes, et les erreurs sont 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.

Remarque:La modification des fichiers YAML Cloud Build n'est disponible que pour les fichiers nommés cloudbuild.yaml.

Fichiers de configuration YAML compatibles

• Anthos Config Management
• Cloud Build
• Config Connector
• Istio
• Knative
• Kubernetes
• Kustomize
• Skaffold

Cloud Code est également compatible par défaut avec des définitions de ressources personnalisées (CRD) personnalisées Kubernetes, telles que Kubeflow.

Utiliser un schéma personnalisé

Avec Cloud Code, vous pouvez fournir votre propre schéma CRD à l'aide du 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 en raw.githubusercontent.com.

Extraire un schéma d'un cluster

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

Configurer avec des extraits de code

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 traitement des champs répétitifs en remplissant les instances restantes 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

Saisie avec contexte

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

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.

Faire apparaître la documentation par survol de la souris

Cloud Code fournit la documentation pertinente 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 ou Peek Definition.

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 Afficher > 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 de contrôle source et un fichier YAML déployé, ouvrez la palette de commandes (appuyez sur Ctrl/Cmd+Shift+P ou cliquez sur Afficher > Palette de commandes), puis exécutez Cloud Code: fichier JSON/YAML Diff avec code déployé K8s.

Effectuer un "dry run" (test à blanc) d'un fichier YAML

Pour effectuer une simulation de votre configuration et vérifier sa validité, ouvrez la palette de commandes (appuyez sur Ctrl/Cmd+Shift+P ou cliquez sur Affichage > Palette de commandes) et exécutez Cloud Code: configuration actuelle de simulation pour la validation côté serveur et Cloud Code: Configuration actuelle de la validation côté client.

Cela a pour effet d'exécuter kubectl apply -f dry-run=server (ou kubectl apply -f dry-run=client, pour l'option Client) et d'afficher une validation réussie (ou un message d'erreur si votre fichier de configuration n'est pas valide) sous la forme d'une notification toast.

Dans l'exemple suivant, le "dry run" de la configuration actuelle pour la validation côté serveur, hello.deployment.yaml, renvoie une erreur de création de déploiement car l'espace de noms spécifié, random-namespace, n'existe pas.

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 en base64 avec Cloud Code, maintenez le pointeur de la souris sur le secret pour le décoder.

Étapes suivantes

• Créez un fichier skaffold.yaml de configuration d'exécution Kubernetes Cloud Code.
• Créez manuellement une configuration Skaffold pour votre application.
• Consultez la documentation de référence sur Skaffold.yaml.

Obtenir de l'aide

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