Présentation de Cloud Code for 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, nœuds, charges de travail et plus encore, directement depuis votre IDE. Vous pouvez également définir un contexte actuel, diffuser et afficher les journaux, ouvrir un terminal interactif et rechercher les descriptions de ressources dans la section Kubernetes.

Section Kubernetes dans Cloud Code

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 basculer ou ajouter de nouveaux fichiers Kubeconfig depuis la section Kubernetes. Les fichiers Kubeconfig sont des fichiers YAML contenant les détails, le certificat et le jeton secret de votre cluster Kubernetes pour l'authentification auprès du cluster.

Pour utiliser un fichier kubeconfig autre que le fichier kubeconfig par défaut, consultez le guide Utiliser des 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 et en développant la section Kubernetes. Pour afficher les sessions de débogage ou créer une application exemple, développez la section Development sessions (Sessions de développement).

Lors d'une tentative de débogage, vous pouvez être invité à authentifier vos identifiants pour exécuter et déboguer une application en local.

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éez 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 de journalisation structurée.

Volet des sessions de développement

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 alimentée par kubectl. Tant que vous avez configuré votre fichier de configuration kubectl pour accéder à vos clusters, vous pouvez utiliser la section Kubernetes pour ajouter des clusters et parcourir tous les espaces de noms, ressources et nœuds disponibles pour vos clusters, qu'ils se trouvent dans le contexte actif ou inactif.

Section Kubernetes

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

  • ajouter KubeConfig
  • refresh. Actualisez la section Kubernetes.
  • question_mark Ouvrir la documentation Kubernetes Cloud Code dans un navigateur Web

Section "Sessions de développement"

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

  • Icône Ouvrir l'exemple Kubernetes Ouvrir un exemple d'application Kubernetes
  • play_arrow Exécuter l'application
  • Icône de débogage 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 le nom d'une ressource, effectuez un clic droit sur la ressource et choisissez Copier le nom de la ressource.

Copier le nom de la ressource à l'aide du menu contextuel

Actualiser les ressources

La section Kubernetes surveille les modifications et s'actualise automatiquement pour refléter les mises à jour. Pour forcer l'actualisation d'une ressource Kubernetes afin d'extraire ses dernières informations, effectuez un clic droit sur la ressource et choisissez Refresh (Actualiser).

Actualiser les pods à l'aide du menu contextuel

Vous pouvez également forcer l'actualisation de l'ensemble de la section Kubernetes à l'aide du bouton d'actualisation de la section Kubernetes. 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 Décrire. Un terminal s'ouvre et affiche les informations sur la ressource. Décrire les détails de la ressource dans le menu contextuel

Personnaliser votre configuration de lancement

Pour configurer l'exécution de votre application, vous pouvez personnaliser le 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 ou pointez sur la ressource pour afficher les icônes Edit YAML (Modifier le fichier YAML) et View YAML (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.

Fichier YAML du pod Kubernetes ouvert à l'aide de l'icône Afficher YAML

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.

Boîte de dialogue "Afficher les journaux" dans la palette de commandes

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

Visionneuse de journauxPour afficher les journaux d'un pod ou d'un conteneur, effectuez un clic droit sur la ressource et sélectionnez Afficher les journaux.

Afficher les journaux d'un pod

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).

Ouvrir un terminal interactif

Actions spécifiques sur les ressources

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

Clusters

  • Ajouter un cluster au 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 choisir le projet et le cluster que vous souhaitez utiliser ou créer un cluster.

Choisir la plate-forme du cluster

Créer ou choisir un cluster GKE

  • 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é accède à ce cluster par défaut.

    Définir le cluster comme actif à l'aide du menu contextuel

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

Si plusieurs contextes sont configurés sur un cluster, vous pouvez choisir l'un des contextes disponibles à définir comme contexte actuel.

Espaces de noms

  • Définir comme espace de noms actif:définissez un espace de noms comme actif, de sorte que le contexte kubectl configuré accède à cet espace de noms par défaut.

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

    Définir l'espace de noms comme contexte actuel à l'aide du menu contextuel

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

Notez qu'un 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 minikube ou un cluster GKE. Si vous ne voyez pas l'option Définir en tant que contexte actuel pour un espace de noms donné et que vous souhaitez créer un contexte pour celui-ci, exécutez 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.
  • Get Terminal (Obtenir le terminal) : obtient le terminal d'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
Coche verte à côté du pod indiquant l'état de fonctionnement

Des conteneurs

Déploiements

  • Afficher les journaux:affichez les journaux 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.
Icônes de déploiement vertes indiquant un état opérationnel

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:

Liste des définitions de ressources personnalisées dans la section

Étapes suivantes