Présentation de Cloud Code pour VS Code Kubernetes

Cette page présente le développement Kubernetes dans Cloud Code.

Utiliser la section Kubernetes dans Cloud Code

La section Kubernetes vous permet d'accéder aux informations sur vos clusters, vos nœuds, vos charges de travail, etc. directement depuis votre IDE. Vous pouvez également définir un contexte actuel, diffuser et afficher les journaux, ouvrir un terminal interactif et rechercher des descriptions de ressources avec la section Kubernetes.

Cloud Code utilise le fichier kubeconfig par défaut, situé dans le répertoire $HOME/.kube sous macOS/Linux ou %USERPROFILE%\.kube sous Windows, pour récupérer les ressources Kubernetes. Vous pouvez changer ou ajouter des fichiers Kubeconfig depuis la section Kubernetes. Les fichiers kubeconfig sont des fichiers YAML contenant les informations de votre cluster Kubernetes, le certificat et le jeton secret pour l'authentification au cluster.

Pour utiliser un fichier kubeconfig autre que le fichier kubeconfig par défaut, consultez le guide Utiliser les fichiers kubeconfig.

Accéder à la section Kubernetes

Pour afficher et gérer vos ressources Kubernetes, accédez à la section Kubernetes en cliquant sur Cloud Code, puis en développant la section Kubernetes. Pour afficher des sessions de débogage ou créer un exemple d'application, développez la section Sessions de développement.

Lorsque vous essayez de déboguer, vous pouvez être invité à authentifier vos identifiants pour exécuter et déboguer une application localement.

Accéder à la section "Sessions de développement"

Utilisez les sessions de développement pour exécuter ou déboguer votre application Kubernetes, ou créer un exemple d'application à l'aide d'un modèle.

Lorsque vous démarrez une session de développement ou de débogage, la section Sessions de développement affiche la vue structurée de la journalisation.

Pour accéder aux sessions de développement, cliquez sur Cloud Code, puis développez la section Sessions de développement.

Actions de base

La section Kubernetes est fournie par kubectl. À partir du moment où vous avez configuré votre fichier de configuration kubectl pour accéder à vos clusters, vous pouvez utiliser la section Kubernetes pour ajouter des clusters, parcourir tous les espaces de noms, ressources et nœuds disponibles pour vos clusters, qu'ils soient actifs ou inactifs.

Section Kubernetes

Les actions générales Kubernetes disponibles, accessibles via leurs icônes dans la section Kubernetes, sont les suivantes:

• Ajouter KubeConfig
• refresh Actualiser la section Kubernetes
• question_mark Ouvrir la documentation Cloud Code Kubernetes dans un navigateur Web

Section "Sessions de développement"

Les actions Kubernetes disponibles, accessibles via leurs icônes dans la section Sessions de développement de Kubernetes, sont les suivantes:

• Ouvrir un exemple d'application Kubernetes
• play_arrowExécuter votre application
• Déboguer votre application

Copier un nom de ressource

Vous pouvez copier n'importe quel nom de ressource Kubernetes dans le presse-papiers (y compris les noms des conteneurs et des clusters). Pour copier un nom de ressource, effectuez un clic droit sur la ressource, puis sélectionnez Copier le nom de la ressource.

Actualiser les ressources

La section Kubernetes recherche les modifications et s'actualise automatiquement pour refléter les mises à jour. Pour forcer l'actualisation d'une ressource Kubernetes afin de récupérer ses informations les plus récentes, effectuez un clic droit sur la ressource et sélectionnez Actualiser.

Vous pouvez également forcer l'actualisation de l'intégralité de la section Kubernetes à l'aide du bouton d'actualisation de la section Kubernetes.

Décrire les ressources

Pour afficher les détails d'une ressource hors cluster, effectuez un clic droit sur la ressource, puis sélectionnez Describe (Décrire). Un terminal s'ouvre et affiche les informations sur les ressources.

Personnaliser votre configuration de lancement

Pour configurer l'exécution de votre application, vous pouvez personnaliser votre fichier skaffold.yaml.

Vous pouvez également configurer votre lancement en spécifiant les champs suivants dans la configuration cloudcode.kubernetes de votre fichier .vscode/launch.json :

• skaffoldConfig : spécifiez le fichier de configuration skaffold, qui contient les paramètres de compilation et de déploiement.
• profil : indiquez votre profil skaffold préféré. S'il n'est pas défini, le profil par défaut est utilisé.
• imageRegister : spécifiez le registre d'images vers lequel transférer les images.
• watch : spécifiez s'il faut surveiller les modifications apportées à l'espace de travail et réexécuter l'application. À moins qu'il ne soit défini explicitement sur "false", "true" par défaut.
• cleanUp : spécifiez s'il faut supprimer les ressources Kubernetes déployées dans le cluster après l'arrêt de l'application. À moins qu'il ne soit défini explicitement sur "false", "true" par défaut.
• portForward : spécifiez s'il faut transférer les ports des ressources Kubernetes exposées de votre cluster vers votre ordinateur local. À moins qu'il ne soit défini explicitement sur "false", "true" par défaut.

Afficher le fichier YAML distant

Pour afficher le fichier YAML d'une ressource de votre cluster, sélectionnez-la ou pointez dessus pour afficher les icônes Modifier le fichier YAML et Afficher le fichier YAML. Sélectionnez le bouton Afficher YAML pour ouvrir le fichier YAML correspondant à la ressource spécifiée dans un nouvel onglet de l'éditeur.

Afficher les journaux

Vous pouvez diffuser et afficher les journaux des ressources Kubernetes dans la console de la section Kubernetes pour surveiller leur progression.

Pour ouvrir la visionneuse de journaux, ouvrez la palette de commandes en appuyant sur Ctrl/Cmd+Shift+P ou en cliquant sur Affichage > Palette de commandes, puis sélectionnez Cloud Code: Afficher les journaux.

Le visionneuse de journaux s'ouvre dans un nouvel onglet de l'éditeur.

Pour afficher les journaux d'un pod ou d'un conteneur, effectuez un clic droit sur la ressource, puis sélectionnez Afficher les journaux.

Lancer un terminal

Pour les pods et les conteneurs, vous pouvez ouvrir un terminal interactif en effectuant un clic droit sur le pod ou le conteneur, puis en sélectionnant Get terminal (Obtenir un terminal).

Actions spécifiques sur les ressources

La section Kubernetes affiche les clusters, les espaces de noms, les nœuds, les charges de travail (déploiements, ensembles d'instances dupliquées, pods et conteneurs), les services et les entrées, les configurations (secrets et mappages de configuration) et le stockage (volumes, etc.). La section Kubernetes vous permet d'effectuer des actions uniques sur certaines de ces ressources.

Clusters

• Ajouter un cluster au fichier Kubeconfig:ajoutez un cluster GKE ou minikube existant ou créez-en un.

La boîte de dialogue "Ajouter un cluster" s'affiche. Vous pouvez y choisir le projet et le cluster que vous souhaitez utiliser ou créer un cluster.

• Définir en tant que cluster actif:définissez le cluster spécifié comme actif, de sorte que le contexte kubectl que vous avez configuré puisse accéder à ce cluster par défaut.

  

La section Kubernetes s'actualise automatiquement et le symbole Kubernetes s'affiche à côté du cluster approprié.

Si plusieurs contextes ont été configurés sur un même cluster, vous pouvez choisir l'un des contextes disponibles et le définir comme actif.

Espaces de noms

• Définir en tant qu'espace de noms actif:définissez un espace de noms comme actif, de sorte que le contexte kubectl que vous avez configuré puisse accéder à cet espace de noms par défaut.

  Effectuez un clic droit sur l'espace de noms que vous souhaitez définir comme actif.

  

Si cette action aboutit, la section Kubernetes s'actualise automatiquement et un astérisque apparaît à côté de l'espace de noms pour indiquer qu'il fait partie du contexte actuel.

Notez que le contexte Kubernetes est un raccourci qui vous donne un accès rapide à un espace de noms dans votre cluster. Les contextes sont normalement créés automatiquement lorsque vous démarrez un cluster Minikube ou GKE. Si vous ne voyez pas l'option Définir en tant que contexte actif pour un espace de noms donné et si vous souhaitez créer un contexte pour celui-ci, utilisez la commande kubectl config set-context dans votre terminal pour définir un contexte avec le cluster, l'utilisateur et l'espace de noms de votre choix.

Pods

• Afficher les journaux:affichez les journaux d'un pod dans la console de la section Kubernetes.

• Ouvrir le terminal:obtenez un terminal pour un pod dans la console de la section Kubernetes.

  Par ailleurs, les libellés de pods en cours d'exécution sont associés à des marques d'état colorées :

  • Rouge : le pod a échoué
  • Jaune : le pod démarre ou se termine
  • Vert : le pod est opérationnel et en cours d'exécution

Conteneurs

• Afficher les journaux:affichez les journaux d'un conteneur dans la console de la section Kubernetes.
• Obtenir un terminal:obtenez un terminal pour un conteneur dans la console de la section Kubernetes.

Déploiements

• Afficher les journaux:affichez les journaux à partir d'un déploiement dans la console de la section Kubernetes.

  Les déploiements en direct présentent des marques d'état colorées situées à côté de leurs libellés et du nombre d'instances dupliquées actives/totales :

  • Jaune : le déploiement ne présente pas de disponibilité minimale ni de problèmes d'image.
  • Vert : le déploiement est opérationnel et sa disponibilité minimale.

Nœuds

Les nœuds de votre cluster sont signalés par des marques d'état colorées situées à côté de leurs noms :

• Jaune : le nœud présente un problème de ressource, au niveau de la mémoire ou de la disponibilité du disque.
• Vert : le nœud est opérationnel.

Définitions de ressources personnalisées

La section "Kubernetes" répertorie toutes les définitions de ressources personnalisées (CRD) installées et disponibles sur votre cluster:

Étape suivante

• Commencez à utiliser Cloud Code for VS Code for Kubernetes en créant et en déployant une application Kubernetes à partir d'un exemple de code.
• Utilisez la synchronisation des fichiers et le rechargement à chaud pour accélérer le développement.
• Déboguer votre application dans Cloud Code