Começar a usar o Cloud Code para VS Code para Kubernetes

O Cloud Code permite criar um aplicativo do Kubernetes com base em uma amostra ou de um projeto atual.

Criar um aplicativo usando um modelo

O Cloud Code vem com uma coleção de modelos de exemplo de código para você começar rapidamente. Para criar um aplicativo do Kubernetes usando uma amostra, siga estas etapas:

  1. Inicie a paleta de comandos (pressione Ctrl/Cmd+Shift+P ou clique em View > Command Palette) e execute Cloud Code: New Application.
  2. Selecione Aplicativo do Kubernetes como o tipo de amostra.
  3. Selecione um modelo baseado na linguagem que você quer usar dentre as opções disponíveis: Node.js, Go, Python e Java.

  4. Escolha um local de aplicativo de sua preferência na máquina local e clique em Criar novo aplicativo para salvar.

    O Cloud Code clona a amostra que você escolheu e abre seu novo projeto para uso.

Exemplo de estrutura de aplicativos

Os aplicativos criados a partir de modelos em todas as linguagens têm quase a mesma estrutura. Essa não é a única estrutura compatível, mas é a opção recomendada ao dar os primeiros passos.

Por exemplo, a estrutura do aplicativo Guestbook Node.js tem esta aparência:

.
|---- .vscode
|      └---- launch.json
|---- kubernetes-manifests
|     |---- guestbook-backend.deployment.yaml
|     |---- guestbook-backend.service.yaml
|     |---- guestbook-frontend.deployment.yaml
|     |---- guestbook-frontend.service.yaml
|     |---- mongo.deployment.yaml
|     └---- mongo.service.yaml
|---- src
|     |---- backend
|     |     |---- Dockerfile
|     |     |---- index.js
|     |     |---- app.js
|     |     └---- package.json
|     |---- frontend
|           |---- Dockerfile
|           |---- index.js
|     |     |---- app.js
|           └---- package.json
└---- skaffold.yaml

Para analisar mais detalhadamente este aplicativo de amostra de livro de visitas do Node.js para o Kubernetes, veja alguns arquivos importantes e seus respectivos usos:

  • .vscode
    • extensions.json: solicitação de download de extensões relacionadas ao abrir este projeto
    • launch.json: iniciar configuração (do tipo cloudcode.kubernetes) para executar ou depurar o aplicativo do Kubernetes
    • tasks.json: informações de configuração para tarefas do Visual Studio Code
  • kubernetes-manifests
    • guestbook-backend.deployment.yaml: especificação do pod para os nós de back-end
    • guestbook-frontend.deployment.yaml: especificação do pod para os nós de front-end
    • mongo.deployment.yaml: especificação do pod para o banco de dados
  • src
    • (backend|frontend)/app.js: código do Node.js com a lógica do servidor da Web
    • (backend|frontend)/Dockerfile: usado para criar a imagem do contêiner do nosso programa
  • skaffold.yaml: arquivo de configuração do Skaffold, que o Cloud Code usa para criar, implantar e depurar aplicativos do Kubernetes

Usar seu próprio aplicativo

Para saber como usar um projeto, consulte Usar o Cloud Code com um aplicativo do Kubernetes.

Definir o contexto do Kubernetes

Antes de executar o aplicativo, verifique se você está configurado para implantar o aplicativo no contexto de sua preferência. É possível especificar isso na configuração.

Configuração

Ao usar a configuração de execução Cloud Code: desenvolver no Kubernetes, é possível personalizar a implantação definindo as configurações disponíveis.

Para adicionar ou editar configurações, acesse Run > Open Configurations e edite ou adicione configurações.

Configurações da versão

O Cloud Code é compatível com tipos de artefato do Docker, Jib e Buildpacks. Consulte Como configurar o guia de preferências de criação de imagens de contêiner para saber como definir o builder preferencial e as configurações relevantes.

Personalizar a configuração de inicialização

Para configurar a execução do aplicativo, personalize o arquivo skaffold.yaml.

Também é possível configurar a inicialização editando a configuração cloudcode.kubernetes no arquivo .vscode/launch.json.

Para mais informações sobre como personalizar a configuração de inicialização, consulte Kubernetes no Cloud Code.

Execute o aplicativo

Depois de configurar um aplicativo, você pode executá-lo em um cluster do Kubernetes e visualizá-lo ao vivo, usando skaffold dev. É possível executar o aplicativo em um cluster local (como Minikube ou Docker Desktop), Google Kubernetes Engine ou qualquer outro provedor de nuvem.

  1. Abra a paleta de comandos (pressione Ctrl/Cmd+Shift+P) e execute o comando Cloud Code: Run on Kubernetes.
  2. Confirme se você quer usar o contexto do Kubernetes atual para executar o aplicativo (ou alternar para um preferido). Para mais informações sobre como configurar um contexto do Kubernetes, consulte Como configurar.

  3. 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 do Artifact Registry.

    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

    O Cloud Code concatena esse registro de imagem com o nome da imagem especificado nos manifestos do Kubernetes para gerar o nome final do repositório de imagens.

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

    Essa escolha é armazenada em sua configuração de inicialização cloudcode.kubernetes (encontrada em .vscode/launch.json)

    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.

Ver registros

Além de ver os registros de pods em execução como uma transmissão ao vivo na saída do terminal enquanto você desenvolve e executa o aplicativo, é possível conferir os registros de um pod específico navegando até a seção do Kubernetes.

Para ver os registros de um pod específico, siga estas etapas:

  1. Na seção Kubernetes, abra Implantações.

  2. Clique com o botão direito do mouse no pod do qual você quer ver os registros e clique em Ver registros.

    O Visualizador de registros é aberto.

Fazer mudanças, recriar e limpar

Se você definiu o modo de exibição como false na configuração de inicialização e quer fazer alterações no aplicativo e recriá-lo e reimplantá-lo:

  1. Faça e salve as mudanças.

  2. Na barra de depuração, clique em Pausar (F6) e em Reiniciar (Ctrl/Cmd + Shift + F5) para recriar e implantar novamente o aplicativo.

  3. Para interromper a execução do aplicativo, na barra de ferramentas de depuração, clique em Stop.

Depois que você interrompe o aplicativo, todos os recursos implantados do Kubernetes são excluídos do cluster. É possível mudar esse comportamento usando a flag cleanUp na configuração de inicialização.

Armazenar secrets

Se o código inclui dados possivelmente confidenciais, como chaves de API, senhas e certificados, é recomendável armazená-los como secrets. O Cloud Code permite armazenar esses secrets com segurança no Gerenciador de secrets e buscá-los de maneira programática quando precisar deles.

Para uma visão detalhada de como criar e gerenciar secrets com o Cloud Code, consulte o guia do Gerenciador de secrets.

Conferir detalhes do recurso

A seção do Kubernetes mostra clusters, namespaces, nós, cargas de trabalho (como implantações, réplicas, pods e contêineres), serviços e entradas, configurações (como segredos e mapas de configuração) e armazenamento (como volumes). Com a seção do Kubernetes, é possível realizar ações exclusivas em alguns desses recursos.

Consulte a Visão geral do Kubernetes para mais informações sobre como conferir os detalhes do recurso.

A seguir

Receber suporte

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