Guide de démarrage rapide: déployer une application Kubernetes avec Cloud Code pour VS Code

Déployer une application Kubernetes avec Cloud Code for VS Code

Cette page vous explique comment démarrer rapidement avec Cloud Code.

Vous allez configurer une nouvelle application Kubernetes à l'aide d'un exemple d'application, créer un cluster, exécuter votre application sur ce cluster, déboguer votre code en cours d'exécution, afficher les journaux de votre application active et connecter un terminal à votre conteneur en cours d'exécution.

Si vous utilisez une machine Apple utilisant la silicon de la série M, vous devez utiliser Cloud Build pour effectuer un déploiement sur Cloud Run qui n'accepte que les images x86 (cela peut entraîner des frais). Cloud Code vous aide à créer des images x86 à l'aide de Cloud Build. Pour en savoir plus, consultez la page Compatibilité avec Cloud Code pour la version silicium de la série Apple M.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
  2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier si la facturation est activée sur un projet.

  4. Activez l'API Google Kubernetes Engine

    Activer l'API

  5. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  6. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier si la facturation est activée sur un projet.

  7. Activez l'API Google Kubernetes Engine

    Activer l'API

  8. Installez Git. Git est nécessaire pour copier des exemples sur votre ordinateur.

Installer Cloud Code

  1. Installez Visual Studio Code sur votre ordinateur, si ce n'est pas déjà fait.

  2. Pour toutes les plates-formes cloud, installez le client Docker (authentifié avec votre registre Docker) sur le PATH de votre machine (son dossier d'installation doit être visible sous un répertoire dans votre PATH.

    • Pour vérifier si Docker est déjà installé, exécutez docker -v.
    • Si vous utilisez Windows Home, consultez la page Installer Docker Desktop sur Windows Home.
    • Si vous utilisez WSL, mais que vous ne pouvez pas installer "Docker for Desktop", utilisez plutôt Minikube pour le développement local avec Cloud Code.

    Cloud Code installe automatiquement kubectl, Skaffold et la CLI gcloud.

  3. Installez Cloud Code à l'aide de l'une des options suivantes :

    • Ouvrez VS Code et installez Cloud Code.
    • Ouvrez Visual Studio Code sur votre ordinateur. Utilisez la vue Extensions Icône de l'extension dans VS Code (l'icône carrée doit être disponible dans la barre des tâches de gauche), recherchez et cliquez sur l'extension Cloud Code puis cliquez sur Installer.

    Si vous exécutez Cloud Code pour VS Code sur une puce Apple Silicon série M, vous êtes invité à installer Rosetta 2 ou à désactiver les dépendances automatiques, ce qui nécessite que Rosetta 2 fonctionne sur votre système.

    Une fois l'installation terminée, la page de bienvenue de Cloud Code s'affiche, ainsi qu'un ensemble d'exemples d'applications sous "Applications de démarrage" que vous pouvez utiliser pour configurer rapidement une nouvelle application. La barre d'état Cloud Code, contenant les actions courantes de Cloud Code, est disponible dans la barre d'état VS Code.

Créer une application

  1. Dans la palette de commandes (appuyez sur Cmd/Ctrl+Shift+P), exécutez Cloud Code: New Application (Cloud Code : Nouvelle application), puis choisissez Kubernetes Application

  2. Choisissez une application Hello World dans la langue de votre choix.

    Par exemple, si vous choisissez Node.js: Hello World, vous créez une application Hello World Node.js de démarrage.

  3. Enregistrez la nouvelle application.

    Une notification confirme que votre application a été créée et celle-ci s'ouvre dans une nouvelle fenêtre.

Créer un cluster GKE

Pour créer un cluster Google Kubernetes Engine (GKE) standard, procédez comme suit :

  1. Cliquez sur Icône Cloud Code Code cloud, puis développez la section Kubernetes.

  2. Cliquez sur + Add a Cluster to the KubeConfig (+ Ajouter un cluster à KubeConfig), puis sélectionnez Google Kubernetes Engine.

  3. Lorsque vous êtes invité à activer le conteneur, sélectionnez Oui.

  4. Choisissez Standard comme type de cluster.

  5. Cliquez sur Ouvrir pour autoriser Cloud Code à ouvrir Cloud Console.

  6. Dans Cloud Console, utilisez le projet que vous avez créé, définissez la zone sur us-central1-a et définissez le nom du cluster sur my-first-cluster.

  7. Cliquez sur Create (Créer). Cette opération prend quelques minutes.

  8. Une fois le cluster créé, dans la section développée Kubernetes, cliquez sur Actualiser la vue du cluster KubernetesActualiser.

  9. Lorsque le nom de votre nouveau cluster apparaît dans la liste, cliquez dessus. Votre nouveau cluster est ajouté à la configuration et configuré en tant que contexte actif.

Lancer et afficher votre application

Maintenant que vous êtes prêt, vous pouvez exécuter votre application et l'afficher en direct. En outre, Cloud Code surveille les modifications apportées à votre système de fichiers afin que vous puissiez modifier et réexécuter votre application quasiment en temps réel.

Pour exécuter votre application, procédez comme suit :

  1. Cliquez sur la barre d'état Cloud Code et sélectionnez Run on Kubernetes (Exécuter sur Kubernetes).
  2. Confirmez si vous souhaitez utiliser le contexte actif du cluster ou basculer vers un autre.
  3. Si vous y êtes invité, choisissez un registre d'images vers lequel transférer les images.

    Une fenêtre de résultat s'affiche, dans laquelle vous pouvez suivre la progression de votre application en cours d'exécution. Un flux en direct des journaux des pods en cours d'exécution s'affiche également dans la sortie du terminal.

  4. Une fois votre application exécutée sur Kubernetes, la fenêtre de résultat affiche une adresse IP. Pour utiliser cette adresse IP associée afin d'accéder à votre application, appuyez sur Ctrl/Cmd, puis sur l'adresse.

Conseils de dépannage

Si vous utilisez un cluster préexistant, pour le définir comme actif et obtenir les identifiants du cluster:

  1. Cliquez sur Icône Cloud Code Code cloud, puis développez la section Kubernetes.

  2. Effectuez un clic droit sur le nom du cluster, puis cliquez sur Définir en tant que cluster actif.

Déboguer votre application

Pour déboguer votre application, procédez comme suit :

  1. Cliquez sur la barre d'état Cloud Code, puis sélectionnez Debug on Kubernetes (Déboguer sur Kubernetes).

  2. Si vous y êtes invité, confirmez si vous souhaitez utiliser le contexte actuel du cluster ou passer à un autre.

    Cloud Code utilise les configurations cloudcode.kubernetes de votre fichier .vscode/launch.json pour exécuter votre application et lui associer une session de débogage.

    Cloud Code crée vos conteneurs, les transfère dans le registre, applique les configurations Kubernetes au cluster et renvoie l'adresse IP que vous pouvez utiliser pour parcourir votre application active.

  3. Avant d'associer votre session de débogage, vous êtes invité à confirmer ou à saisir le répertoire du conteneur distant dans lequel se trouve le programme à déboguer, ou à appuyer sur ÉCHAP pour ignorer le débogage du conteneur.

  4. Pour ajouter un point d'arrêt à la ligne 9, ouvrez src/app.js, puis cliquez dans la marge de l'éditeur.

    Les cercles remplis de rouge indiquent les points d'arrêt actifs, tandis que les cercles vides gris indiquent les points d'arrêt désactivés. Pour un contrôle plus précis des points d'arrêt, vous pouvez utiliser la section "Points d'arrêt" de la vue "Débogage" de VS Code.

    Section "Points d'arrêt" dans le panneau de gauche de la page de débogage, qui permet d'ajouter, de supprimer et de désactiver des points d'arrêt

    Lorsque vous envoyez une nouvelle requête à votre application, le débogueur se met en pause au premier point d'arrêt actif.

    Dans l'exemple suivant, sous Variables (dans la section Local), notez que la valeur de res._contentLength; pour Hello, world! est 13.

    Application interrompue au niveau du point d'arrêt, sections variables et pile des appels remplies avec des valeurs couvertes

  5. Remplacez la chaîne envoyée dans la ligne 8 par Hello, goodbye!, puis redémarrez l'action Debug on Kubernetes (Déboguer sur Kubernetes).

    Une fois l'application recompilée et redéployée, notez la valeur mise à jour de res._contentLength.

    Application interrompue au niveau du point d'arrêt avec des valeurs mises à jour

Une fois votre session de débogage démarrée, le volet Sessions de développement affiche la vue de journalisation structurée. Au début de la tâche, une tâche s'affiche avec une icône représentant un demi-cercle en rotation Icône de progression.

Si une tâche aboutit, une coche verte Icône d'opération réussie s'affiche à côté de l'étape correspondante.

Pour afficher les détails d'une étape, cliquez sur celle-ci dans le volet Session de développement. Le volet "Résultat" affiche l'étape dans la sortie de la journalisation.

Ouvrir un terminal dans votre conteneur

Pour ouvrir un terminal dans votre conteneur, procédez comme suit :

  1. Cliquez sur Icône Cloud Code Code cloud, puis développez la section Kubernetes.

  2. Développez les sections suivantes:

    • Section de votre cluster préféré
    • La section Espaces de noms, puis la section de votre espace de noms préféré
    • La section Pods, puis la section "Pods préférés"
    • La section Conteneurs

    Icône Cloud Code

  3. Cliquez avec le bouton droit sur le conteneur dans lequel vous souhaitez ouvrir un terminal, puis cliquez sur Get Terminal (Obtenir un terminal).

    Un terminal est alors lancé. Vous avez maintenant accès à une interface système à l'intérieur du conteneur en cours d'exécution.

Nettoyer

Une fois votre application arrêtée, toutes les ressources Kubernetes déployées pendant l'exécution sont automatiquement supprimées.

Pour éviter que les autres ressources utilisées dans ce démarrage rapide soient facturées sur votre compte, veillez à supprimer le cluster et le projet que vous avez créés.

Si vous utilisez Google Cloud et que vous souhaitez supprimer uniquement votre cluster, procédez comme suit :

  1. Dans l'explorateur Kubernetes, pointez sur le nom de votre cluster, puis cliquez sur Icône Ouvrir dans Cloud ConsoleOuvrir dans Cloud Console.
  2. Cliquez sur Delete (Supprimer), puis sur Delete.

Pour supprimer votre projet (et les ressources associées, y compris les clusters) :

  1. Accédez à la page "Projets" dans Cloud Console:

    Accéder à la page "Projets"

  2. Sélectionnez le projet que vous avez créé dans ce guide de démarrage rapide, puis cliquez sur Supprimer.

  3. Saisissez l'ID du projet pour confirmer, puis cliquez sur Arrêter.

    Cette opération ferme le projet et programme sa suppression.

Étapes suivantes