Desenvolver código usando um editor local do VS Code

Aprenda a abrir um túnel SSH da sua máquina local para uma estação de trabalho e use o suporte de desenvolvimento remoto do VS Code para se conectar aos Cloud Workstations no editor local do VS Code.

Dica: para uma experiência no navegador, use o ambiente de desenvolvimento integrado do Cloud Workstations, o Code OSS para Cloud Workstations, que é baseado no projeto de código aberto Code-OSS.

Antes de começar

Antes de começar, siga as etapas para estas tarefas:

1. Verifique se alguém da sua equipe criou uma configuração de estação de trabalho.
2. Crie e inicie sua estação de trabalho.

3. No console do Google Cloud, copie as seguintes informações:

   1. Nome e ID do projeto: clique no nome do projeto na barra de menus do Google Cloud e copie o ID na caixa de diálogo Project name and ID que é aberta.
   2. Região
   3. Nome do cluster
   4. Nome da configuração

4. Na máquina local, instale a CLI gcloud.

   Se você estiver executando a CLI gcloud pela primeira vez, talvez também precise executar gcloud auth login para receber credenciais e gcloud config set project PROJECT_ID para definir o projeto atual como o ID do projeto que você copiou na etapa anterior.

5. Ao usar ssh pela primeira vez, instale uma extensão SSH remota para que você possa se conectar a uma estação de trabalho do editor do VS Code pelo Extension Marketplace ou pela paleta de comandos.

   Marketplace de extensões

   1. Abra o aplicativo do editor local do VS Code e, em seguida, abra o Extension Marketplace selecionando
      Extensions na barra de atividades.

   2. Clique em Instalar para instalar a extensão Remote - SSH.

   3. Digite remote ssh no campo de pesquisa, que abre a página de extensão para Remote - SSH.

      

   Paleta de comandos

   1. Para abrir a paleta de comandos, pressione Ctrl + Shift + P (ou Command + Shift + P no macOS) ou clique em Ver > Paleta de comandos.

   2. Digite ext install ms-vscode-remote.remote-ssh para instalar a extensão.

Abrir um túnel SSH

Abra um túnel SSH da sua máquina local para uma estação de trabalho usando o comando gcloud workstations start-tcp-tunnel:

1. No console do Google Cloud, acesse a página Cloud Workstations > Workstations.

   Acessar a estação de trabalho

2. Clique no nome da estação de trabalho para abrir a página Detalhes da estação de trabalho.

3. No exemplo abaixo, substitua os marcadores de posição pelo nome da estação de trabalho, região (local), nome do cluster da estação de trabalho e nome da configuração da estação de trabalho. Copie os valores do painel "Detalhes da estação de trabalho" para os marcadores de posição marcados com um ícone 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
   

   Consulte a seção Antes de começar para encontrar o ID do projeto.

   A sinalização --local-host-port=:LOCAL_PORT é opcional. Se você quiser especificar uma porta local, substitua LOCAL_PORT pelo número da porta local que você quer usar. Se você não especificar uma porta local, o sistema vai escolher uma porta local arbitrária e não utilizada para você e vai gerar uma mensagem com o número da porta para que você saiba qual porta local é usada.

4. Depois de preencher os marcadores de posição, clique em content_copy Copiar exemplo de código para copiar o comando da CLI gcloud.

5. Cole o comando na janela do terminal local e pressione Enter para criar o túnel.

   Quando o comando é bem-sucedido, uma mensagem Listening on port aparece seguida pelo número da porta local.

Para mais detalhes sobre cada flag de configuração, consulte Túnel SSH ou start-tcp-tunnel.

Conectar-se a um host do Cloud Workstations

Siga estas etapas para se conectar a um host do Cloud Workstations:

1. Abra ou volte para o aplicativo VS Code.

2. Para iniciar o Remote - SSH, clique em Open a Remote Window na barra de status.

   

3. Selecione a opção Conectar ao host quando a paleta de comandos abrir.

   

4. Digite user@localhost:LOCAL_PORT, substituindo LOCAL_PORT pelo número da porta local.

   O exemplo a seguir se conecta à porta local 1025 especificando user@localhost:1025.

   

   Observação: as chaves de host das estações de trabalho mudam entre sessões porque as estações de trabalho são executadas em VMs temporárias. Por esse motivo, verifique se a validação da chave do host está desativada para a configuração da estação de trabalho.

5. Se você receber uma solicitação para se conectar depois de ver a mensagem de confirmação Host Added, clique em Connect.

   O sistema também pode solicitar que você confirme o hash. Se for solicitado, clique em Continuar.

6. Um novo editor do VS Code é aberto, e a barra de status do VS Code mostra SSH: localhost seguido pelo número da porta.

   Agora você tem acesso aos arquivos e servidores de idioma na estação de trabalho remota e pode criar e executar processos na estação de trabalho.

   O exemplo a seguir mostra uma janela do editor do VS Code conectada a Cloud Workstations por SSH: localhost: 1025.

   

   Você também pode voltar ao Extensions Marketplace para instalar o Cloud Code e outras extensões locais do VS Code para ajudar a criar, executar e testar seu código.