Développer du code à l'aide d'un éditeur VS Code local

Découvrez comment ouvrir un tunnel SSH depuis votre ordinateur local vers une station de travail, puis utilisez la compatibilité avec le développement à distance de VS Code pour vous connecter à Cloud Workstations depuis votre éditeur VS Code local.

**Conseil** : Pour une expérience dans le navigateur, vous pouvez utiliser l'IDE Cloud Workstations Code OSS pour Cloud Workstations, qui est basé sur le projet Open Source Code-OSS.

Avant de commencer

Avant de commencer, assurez-vous de suivre les étapes de ces tâches :

1. Assurez-vous qu'un membre de votre équipe a créé une configuration de station de travail.
2. Créez et lancez votre station de travail.

3. Dans la Google Cloud console, copiez les informations suivantes :

   1. Nom et ID du projet : cliquez sur le nom du projet dans la Google Cloud barre de menu, puis copiez l’ID dans la boîte de dialogue Nom et ID du projet qui s’ouvre.
   2. Région
   3. Nom du cluster
   4. Nom de la configuration

4. Sur votre ordinateur local, installez la CLI gcloud.

   Si vous exécutez gcloud CLI pour la première fois, vous devrez peut-être également exécuter gcloud auth login pour obtenir des identifiants et gcloud config set project PROJECT_ID pour définir votre projet actuel sur l'ID de projet que vous avez copié à l'étape précédente.

5. Lorsque vous utilisez ssh pour la première fois, installez une extension SSH à distance afin de pouvoir vous connecter à une station de travail depuis l'éditeur VS Code via Extensions Marketplace ou la palette de commandes.

   Extensions Marketplace

   1. Ouvrez votre application d'éditeur VS Code locale, puis ouvrez le Extension Marketplace en sélectionnant
      Extensions dans la barre des tâches.

   2. Cliquez sur Installer pour installer l'extension Remote - SSH.

   3. Saisissez remote ssh dans le champ de recherche, ce qui ouvre la page d'extension pour Remote - SSH.

      

   Palette de commandes

   1. Pour ouvrir la palette de commandes, appuyez sur Control+Shift+P (ou Command+Shift+P sous macOS), ou cliquez sur Affichage > Palette de commandes.

   2. Saisissez ext install ms-vscode-remote.remote-ssh pour installer l' extension.

Ouvrir un tunnel SSH

Ouvrez un tunnel SSH depuis votre ordinateur local vers une station de travail à l'aide de la gcloud workstations start-tcp-tunnel commande :

1. Dans la Google Cloud console, accédez à la page Cloud Workstations > Stations de travail.

   Accéder aux stations de travail

2. Cliquez sur le nom de la station de travail pour ouvrir la page Détails de la station de travail.

3. Dans l'exemple suivant, remplacez les espaces réservés par le nom de la station de travail, la région (emplacement), le nom du cluster de stations de travail et le nom de la configuration de la station de travail. Copiez les valeurs du panneau "Détails de la station de travail" dans les espaces réservés marqués d'une icône Modifier edit.

   gcloud workstations start-tcp-tunnel \
     --project=PROJECT_ID \
     --region=REGION \
     --cluster=CLUSTER_NAME \
     --config=CONFIG_NAME \
     --local-host-port=:LOCAL_PORT \
     WORKSTATION_NAME 22
   

   Consultez la section Avant de commencer pour trouver l'ID du projet.

   L'option --local-host-port=:LOCAL_PORT est facultative. Si vous souhaitez spécifier un port local, remplacez LOCAL_PORT par le numéro de port local que vous souhaitez utiliser. Si vous ne spécifiez pas de port local, le système en choisit un arbitraire et inutilisé pour vous, puis affiche un message avec le numéro de port afin que vous sachiez quel port local il utilise.

4. Après avoir rempli les espaces réservés, cliquez sur content_copy Copier l'exemple de code pour copier la commande de la CLI gcloud.

5. Collez la commande dans la fenêtre de votre terminal local, puis appuyez sur Enter pour créer le tunnel.

   Lorsque la commande réussit, un Listening on port message s'affiche, suivi de le numéro de port local.

Pour en savoir plus sur chaque option de configuration, consultez Tunnel SSH ou start-tcp-tunnel.

Se connecter à un hôte Cloud Workstations

Procédez comme suit pour vous connecter à un hôte Cloud Workstations :

1. Ouvrez l'application VS Code ou revenez-y.

2. Pour lancer Remote - SSH, cliquez sur Ouvrir une fenêtre à distance dans la barre d'état.

   

3. Sélectionnez l'option Se connecter à l'hôte lorsque la palette de commandes s'ouvre.

   

4. Saisissez user@localhost:LOCAL_PORT, en remplaçant LOCAL_PORT par votre numéro de port local.

   L'exemple suivant se connecte au port local 1025 en spécifiant user@localhost:1025.

   

   Remarque : Les clés d'hôte des stations de travail changent d'une session à l'autre, car les stations de travail s'exécutent sur des VM éphémères. Pour cette raison, assurez-vous que la validation des clés d'hôte est désactivée pour la configuration de la station de travail.

5. Si vous êtes invité à vous connecter après avoir vu le message de confirmation Hôte ajouté, cliquez sur Se connecter.

   Le système peut également vous inviter à confirmer le hachage. Si vous y êtes invité, cliquez sur Continuer.

6. Un nouvel éditeur VS Code s'ouvre et la barre d'état VS Code affiche SSH : localhost : suivi du numéro de port.

   Vous avez maintenant accès aux fichiers et aux serveurs de langage de votre station de travail à distance, et vous pouvez créer et exécuter des processus qui s'exécutent dans votre station de travail.

   L'exemple suivant montre une fenêtre d'éditeur VS Code connectée à Cloud Workstations via SSH : localhost : 1025.

   

   Vous pouvez également revenir à Extensions Marketplace pour installer Cloud Code et d'autres extensions VS Code locales afin de vous aider à créer, exécuter et tester votre code.