Développer du code avec un éditeur VS Code local

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

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

Avant de commencer

Avant de commencer, veillez à suivre les étapes pour ces tâches:

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

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

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

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

   Si vous exécutez la CLI gcloud 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 distante afin de pouvoir vous connecter à une station de travail depuis l'éditeur VS Code via Extension Marketplace ou la palette de commandes.

   Place de marché des extensions

   1. Ouvrez votre application locale de l'éditeur de code VS, puis ouvrez Extension Marketplace en sélectionnant
      Extensions dans la barre d'activité.

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

   3. Saisissez remote ssh dans le champ de recherche. La page d'extension Remote - SSH s'ouvre.

      

   Palette de commandes

   1. Pour ouvrir la palette de commandes, appuyez sur Ctrl+Maj+P (ou Cmd+Maj+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 un poste de travail à l'aide de la commande gcloud workstations start-tcp-tunnel:

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

   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 pour 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 "Workstation details" (Détails de la station de travail) dans les espaces réservés signalés par l'icône edit (Modifier).

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

   Pour trouver l'ID du projet, consultez la section Avant de commencer.

   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 choisit pour vous un port local arbitraire non utilisé et génère un message avec le numéro de port pour 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 CLI gcloud.

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

   Lorsque la commande aboutit, un message Listening on port apparaît suivi du numéro de port local.

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

Se connecter à un hôte Cloud Workstations

Pour vous connecter à un hôte Cloud Workstations, procédez comme suit:

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 Connect to Host (Se connecter à l'hôte) lorsque la palette de commandes s'affiche.

   

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 celles-ci s'exécutent sur des VM éphémères. Assurez-vous que la validation des clés d'hôte est désactivée pour la configuration de la station de travail pour cette raison.

5. Si vous êtes invité à vous connecter après que le message de confirmation Hôte ajouté s'affiche, cliquez sur Connect (Se connecter).

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

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 langue sur votre poste de travail distant, et vous pouvez créer et exécuter des processus qui s'exécutent à l'intérieur de celui-ci.

   L'exemple suivant montre une fenêtre de l'é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 qui vous aideront à compiler, exécuter et tester votre code.