Travailler avec des fichiers YAML Google Cloud et Kubernetes dans Cloud Code pour IntelliJ

Cloud Code est conçu pour vous aider à modifier efficacement les fichiers de configuration associés à Google Cloud et à Kubernetes, grâce, entre autres, à la validation basée sur des schémas, aux diagnostics et à la documentation rapide.

Remarque : Pour des raisons de compatibilité, les fonctionnalités d'édition des fichiers Kubernetes sont automatiquement désactivées si le plug-in JetBrains Kubernetes est détecté. Vous pouvez les réactiver manuellement dans le menu des paramètres de Cloud Code en accédant à Cloud Code > Kubernetes > Kubernetes editing features (fonctionnalités d'édition Kubernetes), puis en activant le paramètre Enable Kubernetes YAML configuration editing features (Activer les fonctionnalités d'édition des fichiers de configuration YAML pour Kubernetes). Ces dispositions pour raison de compatibilité ne concernent que les fichiers YAML pour Kubernetes. La compatibilité avec d'autres types de fichiers de configuration YAML, tels que Skaffold, n'est pas affectée.

Remarque :La modification du code YAML de 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
• Knative
• Kubernetes
• Kustomize
• Migrate to containers
• Skaffold

Cloud Code est également compatible avec les CRD Kubernetes courants, tels que Kubeflow, prêts à l'emploi.

Remarque :Pour utiliser l'agrégation de ressources la plus récente, vous devez disposer de la dernière version de Cloud Code.

Activer ou désactiver la compatibilité avec YAML

Pour activer ou désactiver la compatibilité avec YAML, accédez à Fichier > Paramètres > Outils > Gemini + Google Cloud Code > Kubernetes (pour Windows et Linux) ou IntelliJ IDEA > Paramètres > Outils > Activer la fonctionnalité "Gemini + Google Cloud Code" > >

Utiliser un schéma personnalisé

Avec Cloud Code, vous pouvez fournir votre propre schéma CRD avec les paramètres IntelliJ en accédant à Fichier > Paramètres > Outils > Gemini + Google Cloud Code > Kubernetes (pour Windows et Linux) ou IntelliJ IDEA > Paramètres > Outils > Outils > Kubernetes > >>>

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 le schéma d'un cluster

Lorsque vous basculez vers un cluster exécutant Kubernetes v1.16+ dans l'explorateur Kubernetes, Cloud Code extrait automatiquement le schéma de tous les objets CRD installés.

Assistance Skaffold supplémentaire

Skaffold est le moteur sous-jacent de Cloud Code. Il vous aide à créer, transférer et déployer votre application, et permet de créer des pipelines CI/CD.

Cloud Code fournit une assistance supplémentaire pour la gestion des fichiers de configuration Skaffold. Lorsque vous ouvrez un projet, Cloud Code détecte les schémas Skaffold qui ne sont pas à jour et vous invite (via le journal des événements) lorsqu'une mise à niveau de la version du schéma Skaffold est disponible pour vos fichiers de configuration YAML Skaffold existants.

Vous pouvez également accéder à Outils > Gemini + Cloud Code > Kubernetes > Rechercher les mises à niveau de schémas Skaffold pour rechercher les mises à niveau de schéma disponibles.

Configurer avec des extraits

Les extraits de code prêts à l'emploi pour les schémas YAML courants (en utilisant Ctrl+Espace pour afficher les options) vous permettent de créer un fichier YAML ou d'en ajouter à un fichier existant sans erreur, tout en respectant les bonnes pratiques. De plus, il est plus facile de travailler avec des champs répétitifs. Remplissez-en un et Cloud Code remplit les instances restantes.

Cloud Code propose les extraits de code suivants :

• 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

Complétez avec le contexte

Sur la base du schéma actuel, Cloud Code fournit une saisie semi-automatique contextuelle pour vous aider à choisir la bonne option.

Valider le schéma YAML

Cloud Code prend en charge la validation de schéma en signalant les balises et les valeurs non valides dans vos fichiers YAML, et en suggérant des corrections lorsque cela est possible.

Valider les fichiers YAML Skaffold

Cloud Code offre une prise en charge supplémentaire de l'édition des fichiers de configuration Skaffold, ainsi que des modèles intelligents qui vous permettent de valider vos fichiers skaffold.yaml. Consultez ce guide sur l'utilisation d'une application existante avec Cloud Code.

Compléter les fichiers de configuration Skaffold avec le contexte

Sur la base du schéma actuel, Cloud Code fournit des saisies contextuelles et une documentation pertinente pour vous aider à choisir la bonne option.

Découvrez des définitions grâce à une documentation rapide

Cloud Code fournit la documentation pertinente à une ressource lorsque vous mettez en surbrillance une ligne dans votre fichier de configuration et que vous accédez à View > Quick Documentation (Afficher > Documentation rapide).

Lint YAML pour les problèmes de structure et de validité

Cloud Code prend en charge le linting des problèmes de schéma courants et fournit des erreurs descriptives.

Appliquer un fichier YAML

Pour exécuter kubectl apply -f afin d'appliquer une modification de configuration à l'aide du fichier actuel, vous pouvez utiliser l'icône d'actions kubectl , disponible dans la marge de votre IDE, puis sélectionner Apply (Appliquer). Une vue des différences s'affiche pour vous permettre d'examiner les modifications avant de cliquer sur Appliquer.

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 déployé, vous pouvez utiliser l'icône d'actions kubectl disponible dans la marge de votre éditeur. Sélectionnez l'option Diff (Différence) pour afficher une vue des différences vous permettant de comparer deux fichiers de schéma.

Effectuer une simulation d'un fichier YAML

Pour effectuer une simulation de votre fichier et vérifier sa validité, vous pouvez utiliser l'icône d'actions kubectl , disponible dans la marge de votre IDE, pour sélectionner Dry run on Server (Simulation sur serveur) ou Dry run (Simulation sur le client). Cette opération exécute kubectl apply -f dry-run=server (ou kubectl apply -f dry-run=client pour l'option Client) et vous avertit si votre fichier peut être créé dans votre fenêtre de terminal.

Étapes suivantes

• Créez un fichier de configuration d'exécution Kubernetes dans Cloud Code skaffold.yaml.
• 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 des commentaires ou signaler un problème dans votre IDE IntelliJ, accédez à Outils > Cloud Code > Aide / À propos > Envoyer des commentaires ou signaler un problème pour signaler un problème sur GitHub, ou posez une question sur Stack Overflow.