Desenvolver um serviço do Cloud Run localmente no Cloud Code para VS Code

Antes de implantar um serviço no Cloud Run, você pode desenvolvê-lo localmente usando um emulador do Cloud Run.

Como configurar o serviço para desenvolvimento

Se você não tiver um arquivo .vscode/launch.json definido, o A caixa de diálogo Run/Debug on Cloud Run Emulator permite configurar a inicialização e e salva suas configurações em .vscode/launch.json. Se você tiver um arquivo .vscode/launch.json configurado, poderá editá-lo diretamente.

Para executar o serviço localmente, especifique a configuração:

  1. Abra a paleta de comandos (pressione Ctrl/Cmd+Shift+P ou clique em Visualizar > Paleta de comandos) e execute o comando Run on Cloud Run Emulator.
  2. Na caixa de diálogo "Run/Debug no Cloud Run Emulator", defina as especificações para sua configuração:

    • Somente ferramentas de build instaladas localmente estão disponíveis para o emulador do Cloud Run.
    • Escolha Docker ou Buildpacks como seu builder e especifique a fonte.
    • (Opcional) Para especificar variáveis de ambiente a serem transmitidas para o contêineres, expanda Configurações avançadas do build e clique para especificar pares de chave-valor.
      Nome Descrição Exemplo
      PORT A porta que o servidor HTTP vai detectar. 8080
      K_SERVICE O nome do serviço do Cloud Run em execução. hello-world
      K_REVISION O nome da revisão do Cloud Run em execução. hello-world.1
      K_CONFIGURATION O nome da configuração do Cloud Run que criou a revisão. hello-world
    • (Opcional) Para especificar conexões do Cloud SQL, abra Configurações avançadas do serviço, clique em Conexões e especifique uma conexão do Cloud SQL por linha.
    • (Opcional) Marque a opção Fazer o serviço acessível em outros dispositivos na rede local.
    • (Opcional) Se você só quiser recriar e executar o serviço manualmente, em vez de automaticamente ao fazer uma alteração, limpe Opção Recriar e executar novamente automaticamente quando houver alterações.

Como executar o serviço localmente

  1. Depois de definir as configurações preferenciais, execute o serviço clicando em Run.

  2. Se solicitado, autentique suas credenciais para executar e depurar um seu aplicativo localmente.

  3. Monitore o status da sua implantação na janela de saída.

    Após a conclusão da implantação, veja o serviço em execução abrindo o URL exibido na janela de saída.

  4. Para ver registros detalhados, alterne para a visualização detalhada do Cloud Run na janela de saída.

    Painel de saída com hello-world-5 - Detalhado selecionado na lista suspensa do canal de saída

  5. Após a conclusão da sessão, clique com o botão direito do mouse para usar os seguintes comandos:

    • Acessar registros: abra os registros do aplicativo de uma implantação específica com o explorador de registros do Cloud Code.
    • Abrir URL: abra o URL do serviço do aplicativo de um serviço específico em um navegador da Web.
  6. Se você desativou o modo de exibição na configuração de inicialização e quer fazer alterações no aplicativo e recriá-lo e reimplantá-lo, clique na barra de status do Cloud Code e em Ativar o modo de exibição.

  7. Para interromper a implantação, clique no botão Parar na barra de ações da implantação atual.

    Barra de ações para implantação do Cloud Run

Como armazenar chaves secretas

Se o código inclui dados possivelmente sensíveis, como chaves de API, senhas e certificados, armazená-los como secrets pode ajudar a protegê-los. A integração do Cloud Code com o Secret Manager permite armazenar esses secrets com segurança e buscá-los de maneira programática. Para uma visão detalhada de como é possível criar e gerenciar secrets com o Cloud Code, consulte o guia do Secret Manager.

Como personalizar uma configuração launch.json

O plug-in do Cloud Code atualiza o arquivo de configuração launch.json automaticamente quando você escolhe uma ação de execução. Para personalizar ainda mais a forma como serviço é executado, você pode especificar os seguintes campos em seu Arquivo .vscode/launch.json:

  • watch: detecta alterações no espaço de trabalho e executa novamente o serviço. "True" por padrão.

    O exemplo abaixo mostra o relógio configurado como true:

    "watch": true,
    
  • build: especificar o builder (Docker, jibMaven, jibGradle ou pacotes de criação) para criar imagens.

    O exemplo a seguir mostra um builder do Docker:

    "build": {
      "docker": {
        "path": "Dockerfile"
      }
    },
    

    O exemplo abaixo mostra um builder de buildpack:

    "build": {
      "buildpacks": {
        "path": "src/requirements.txt",
        "builder": "gcr.io/buildpacks/builder:v1"
      }
    },
    
  • image: especifique o nome da imagem a ser usada.

    O exemplo a seguir mostra como especificar um nome de imagem:

      "image": "hello-world",
    
  • service: especifique o serviço do Cloud Run a ser usado.

    O exemplo a seguir mostra como especificar um nome de serviço, uma porta e limites de recursos:

    "service": {
      "name": "hello-world",
      "containerPort": 8080,
      "resources": {
        "limits": {
          "memory": "256Mi"
        }
      }
    },
    
  • debug: especifique configurações de depuração, como mapeamento de caminho remoto, para mapear um para um caminho no contêiner remoto.

    O exemplo a seguir mostra uma seção de depuração que indica o nome local:

    "debug": {
      "sourceFileMap": {
        "${workspaceFolder}": "/app"
      }
    }
    

Receber suporte

Acesse o GitHub para enviar feedback e informar problemas ou o Stack Overflow (ambos em inglês) para fazer perguntas.