Depurar aplicativos do Kubernetes com o Cloud Code para VS Code

O Cloud Code permite depurar um aplicativo implantado em um cluster do Google Kubernetes Engine (GKE) usando o skaffold debug.

É possível depurar seu aplicativo em um cluster local, como minikube ou Docker Desktop, GKE ou qualquer outro provedor de nuvem.

Com o suporte à depuração do Cloud Code, não é preciso concluir a configuração manual, como a configuração do encaminhamento de portas ou a injeção de argumentos de depuração específicos da linguagem. A depuração exige um aplicativo do GKE pronto para o Cloud Code que inclua um arquivo de configuração skaffold.yaml e uma configuração de inicialização cloudcode.kubernetes.

Depurar um aplicativo do GKE

Para começar a depurar seu aplicativo do GKE, siga estas etapas:

1. Na barra de status do Cloud Code, clique no nome do projeto ativo.

   

2. No menu "Escolha rápida" que aparece, selecione Depurar no Kubernetes.

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

4. Se o aplicativo não tiver a configuração skaffold.yaml ou cloudcode.kubernetes necessária, o Cloud Code ajudará você a configurá-las.

5. Confirme se você quer usar o contexto do Kubernetes atual para executar o aplicativo (ou alternar para um preferido).

6. Se você escolheu um cluster remoto como contexto, quando solicitado, escolha um registro de imagem para enviar as imagens.

   Se o projeto tiver a API Artifact Registry ativada e pelo menos um repositório do Artifact Registry, é possível navegar e selecionar um repositório existente do Artifact Registry. de dados.

   Os exemplos a seguir demonstram como especificar onde as imagens de contêiner são armazenadas para alguns registros comuns:

   Artifact Registry	REGION-docker.pkg.dev/PROJECT_ID/REPO_NAME
   Docker Hub	docker.io/ACCOUNT Verifique se você tem a autenticação correta se estiver usando um repositório particular do Docker Hub.
   AWS Container Repository (ECR)	AWS_ACCOUNT_ID.dkr.ecr.REGION.amazonaws.com/APP
   Azure Container Registry (ACR)	ACR_NAME.azurecr.io/APP

   Para gerar o nome final do repositório de imagem, o Cloud Code concatena esse registro de imagem com o nome da imagem especificado nos manifestos do Kubernetes. Essa escolha é armazenada na configuração de inicialização cloudcode.kubernetes (encontrada em .vscode/launch.json).

   Para mais informações, consulte o guia de processamento de registros de imagem.

   O Cloud Code, em seguida, cria os contêineres, os envia para o registro, aplica as configurações do Kubernetes ao cluster e aguarda o lançamento.

   Após a conclusão do lançamento, o Cloud Code encaminha automaticamente todas as portas de contêiner declaradas à sua máquina e exibe os URLs na janela de saída para que seja possível procurar seu aplicativo ativo.

7. Para cada contêiner depurável no seu aplicativo, confirme ou insira o diretório no contêiner remoto em que o programa que você quer depurar está localizado.

   Como alternativa, pressione ESC para pular a depuração do contêiner.

   

   O Cloud Code anexa uma sessão de depuração para cada contêiner depurável no aplicativo.

   Agora é possível realizar as mesmas tarefas realizadas ao depurar código local, como definir pontos de interrupção e avançar o código, em um cluster ativo do Kubernetes.

   Por padrão, quando você salva uma alteração no aplicativo, o Cloud Code o implanta novamente e configura uma nova sessão de depuração. Alterne esse recurso com a sinalização watch na configuração de inicialização do seu projeto.

8. Para inspecionar informações de pilha e variáveis, use a barra lateral de depuração (em inglês). Para interagir com a sessão, use o Console de depuração (em inglês) no depurador do painel inferior.

9. Depois que a sessão for concluída, use os seguintes comandos do menu de contexto:

   • Abrir registros de implantação:abra os registros do aplicativo de uma implantação específica com o explorador de registros do Cloud Code.
   • Open Service URL: abra o URL do serviço do aplicativo de um serviço específico em um navegador da Web.

10. Se você desativou o modo de exibição na configuração de inicialização e quer fazer mudanças no aplicativo e recriá-lo e reimplantá-lo, pause a ação de execução no painel "Sessões de desenvolvimento" e clique em Recrie e reimplante o aplicativo.

11. Para encerrar a sessão de depuração, clique em Stop na barra de ferramentas de depuração.

    Depois de terminar a sessão de depuração, todos os recursos implantados do Kubernetes são excluídos do cluster.

Detalhes da configuração

O Cloud Code processa automaticamente os seguintes detalhes de configuração para todas as linguagens compatíveis:

• Faça o encaminhamento de portas de depuração para que o depurador seja anexado.
• Como anexar um depurador a um ou mais contêineres depuráveis no aplicativo. Se o aplicativo tiver vários contêineres depuráveis (contêineres com linguagem compatível com a depuração do Cloud Code) configurados em skaffold.yaml, um depurador será anexado a cada um deles.
• Manter definições de mapeamento de origem entre sessões Você pode personalizar essas definições editando seu arquivo .vscode/launch.json diretamente.

O Cloud Code também processa os seguintes detalhes de configuração específicos da linguagem:

node --inspect=localhost:9229

python -m ptvsd --host localhost --port 5678

  dlv exec --headless --continue --accept-multiclient --listen=localhost:56268 --api-version=2, <app> --

  jdwp=transport=dt_socket,server=y,suspend=n,address=5005,quiet=y

Para mais detalhes sobre a depuração usando skaffold debug, consulte a documentação.

Configurar o contêiner

Para preparar o contêiner para depuração, siga as instruções referentes à linguagem que você está usando: