Desenvolver código usando um editor local do VS Code

Saiba como abrir um túnel SSH da sua máquina local para uma estação de trabalho e usar o suporte de desenvolvimento remoto do VS Code para se conectar ao Cloud Workstations pelo editor local do VS Code.

Dica :para uma experiência no navegador, use o Code OSS para Cloud Workstations do ambiente de desenvolvimento integrado do 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 Nome e ID do projeto 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 seja necessário executar gcloud auth login para receber as credenciais e gcloud config set project PROJECT_ID para definir seu 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 se conectar a uma estação de trabalho usando o editor do VS Code por meio do Marketplace de extensões ou usando a paleta de comandos.

   Marketplace de extensões

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

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

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

      

   Palette de comandos

   1. Para abrir o Palette de comandos, pressione Control+Shift+P (ou Command+Shift+P no macOS) ou clique em View > Command Palette.

   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 > Estações de trabalho.

   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 a seguir, substitua os marcadores de posição pelo nome, região (local), nome do cluster da estação de trabalho e nome de configuração da estação de trabalho. Copie os valores do painel de detalhes da estação de trabalho nos marcadores de posição marcados com um ícone de edição 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. Para 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 não utilizada e arbitrária e vai enviar uma mensagem com o número da porta para que você saiba qual porta local está sendo usada.

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

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 é exibida seguida pelo número da porta local.

Para mais detalhes sobre cada sinalização 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 retorne ao aplicativo VS Code.

2. Para iniciar 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 conecta à porta local 1025 especificando user@localhost:1025.

   

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

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

   O sistema também pode pedir que você confirme o hash. Se 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 idiomas na estação de trabalho remota e pode criar e executar processos que são executados nela.

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

   

   Também é possível voltar ao Extensions Marketplace para instalar o Cloud Code e outras extensões locais do VS Code para criar, executar e testar o código.