Desenvolver código usando um editor local do VS Code

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

Antes de começar

Antes de começar, siga as etapas destas tarefas:

  1. Verifique se alguém da sua equipe criou uma configuração de estação de trabalho.
  2. Crie e inicie a estação de trabalho.
  3. No Google Cloud console, copie as seguintes informações:

    1. Nome e ID do projeto: clique no nome do projeto na Google Cloud barra de menus e copie o ID na caixa de diálogo Nome e ID do projeto que será 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 credenciais e gcloud config set project PROJECT_ID para definir o projeto atual como o ID do projeto copiado 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 no editor do VS Code pelo Marketplace de extensões ou pela paleta de comandos.

    Marketplace de extensões

    1. Abra o aplicativo do editor local do VS Code e o Marketplace de extensões selecionando
      Extensões 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.

      Instalar a extensão Remote-SSH

    Paleta de comandos

    1. Para abrir a paleta de comandos, pressione Control+Shift+P (ou Command+Shift+P no macOS) ou clique em Visualizar > 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 máquina local para uma estação de trabalho usando o gcloud workstations start-tcp-tunnel comando:

  1. Noconsolenavegue até a página Google Cloud 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 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 editEdit.

    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 e vai gerar uma mensagem com o número da porta para que você saiba qual porta local ela usa.

  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 for bem-sucedido, uma mensagem Listening on port vai aparecer seguida por o 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 do VS Code.
  2. Para iniciar o Remote - SSH, clique em Abrir uma janela remota na barra de status.

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

    Conectar ao host

  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.

    Adicionar host SSH

  5. Se você receber uma solicitação de conexão depois de ver a mensagem de confirmação Host adicionado, clique em Conectar.

    O sistema também pode solicitar 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 linguagem na estação de trabalho remota, e pode criar e executar processos que são executados dentro da estação de trabalho.

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

    Conectado à estação de trabalho

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