Visão geral do Cloud Code para VS Code Kubernetes

Esta página oferece uma visão geral do desenvolvimento do Kubernetes no Cloud Code.

Usar a seção do Kubernetes no Cloud Code

A seção Kubernetes permite acessar informações sobre clusters, nós, cargas de trabalho e muito mais, diretamente do seu ambiente de desenvolvimento integrado. Também é possível definir um contexto atual, transmitir e visualizar registros, abrir um terminal interativo e procurar descrições de recursos com a seção do Kubernetes.

Seção do Kubernetes do Cloud Code

O Cloud Code usa o arquivo kubeconfig padrão, localizado no diretório $HOME/.kube no macOS/Linux ou %USERPROFILE%\.kube no Windows, para recuperar recursos do Kubernetes. É possível alternar ou adicionar novos arquivos Kubeconfig na seção Kubernetes. Os arquivos Kubeconfig são arquivos YAML que contêm os detalhes do cluster do Kubernetes, o certificado e o token secreto para autenticação no cluster.

Para usar um arquivo kubeconfig diferente do padrão, consulte o guia Trabalhar com arquivos kubeconfig.

Acessar a seção do Kubernetes

Para acessar e gerenciar seus recursos do Kubernetes, clique em Cloud Code e abra a seção Kubernetes. Para conferir sessões de depuração ou criar um app de exemplo, abra a seção Sessões de desenvolvimento.

Ao tentar depurar, talvez seja necessário autenticar suas credenciais para executar e depurar um aplicativo localmente.

Acessar a seção "Sessões de desenvolvimento"

Use as sessões de desenvolvimento para executar ou depurar seu aplicativo do Kubernetes ou criar um aplicativo de amostra usando um modelo.

Quando você inicia uma sessão de desenvolvimento ou depuração, a seção Sessões de desenvolvimento mostra a visualização de geração de registros estruturada.

Painel de sessões de desenvolvimento

Para acessar as sessões de desenvolvimento, clique em Cloud Code e abra a seção Sessões de desenvolvimento.

Ações básicas

A seção Kubernetes é fornecida por kubectl. Se você tiver configurado o arquivo de configuração kubectl para acessar os clusters, use a seção Kubernetes para adicionar clusters, procurar todos os namespaces, recursos e nós disponíveis para os clusters, independentemente de eles estarem no contexto ativo ou inativo.

Seção do Kubernetes

As ações gerais disponíveis do Kubernetes, acessíveis pelos ícones na seção Kubernetes, são:

  • add KubeConfig
  • refresh Atualize a seção Kubernetes.
  • question_mark Abra a documentação do Kubernetes do Cloud Code em um navegador da Web

Seção de sessões de desenvolvimento

As ações do Kubernetes disponíveis, acessíveis pelos ícones na seção Sessões de desenvolvimento do Kubernetes, são:

  • Ícone de exemplo do Open Kubernetes Abrir um aplicativo de exemplo do Kubernetes
  • play_arrow Executar o app
  • Ícone de depuração Depurar o aplicativo

Copiar o nome de um recurso

É possível copiar qualquer nome de recurso do Kubernetes para a área de transferência (inclusive nomes de contêiner e cluster). Para copiar o nome de um recurso, clique com o botão direito do mouse nele e escolha Copiar nome do recurso.

Copiar o nome do recurso usando o menu do botão direito do mouse

Atualizar recursos

A seção Kubernetes procura alterações e é atualizada automaticamente para refletir as atualizações. Para forçar uma atualização de qualquer recurso do Kubernetes para buscar as informações mais recentes, clique com o botão direito do mouse no recurso e escolha Atualizar.

Atualizar pods usando o menu do botão direito do mouse

Também é possível forçar uma atualização de toda a seção Kubernetes usando o botão de atualização da seção Kubernetes. Botão de atualização da seção do Kubernetes

Descrever recursos

Para mostrar os detalhes de qualquer recurso que não seja de cluster, clique com o botão direito do mouse no recurso e selecione Descrever. Um terminal é aberto e mostra as informações do recurso. Descrever os detalhes do recurso no menu do botão direito do mouse

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 especificando os seguintes campos na configuração cloudcode.kubernetes no seu arquivo .vscode/launch.json:

  • skaffoldConfig: especifica o arquivo de configuração do skaffold que contém as definições de compilação e implantação.
  • profile: especifica seu perfil skaffold preferido. Se não for definido, o perfil padrão será usado.
  • imageRegistry: especifica o registro de imagens para onde as imagens serão enviadas.
  • watch: especifique se é preciso acompanhar as alterações no espaço de trabalho e execute novamente o aplicativo. A menos que seja explicitamente definido como falso, verdadeiro por padrão.
  • cleanUp: especificar se os recursos implantados do Kubernetes serão excluídos no cluster após o encerramento do aplicativo. A menos que seja explicitamente definido como falso, verdadeiro por padrão.
  • portForward: especifique se quer encaminhar portas para os recursos expostos do Kubernetes no cluster para a máquina local. A menos que seja explicitamente definido como falso, verdadeiro por padrão.

Acessar o YAML remoto

Para visualizar o YAML de um recurso no cluster, selecione ou passe o cursor sobre o recurso para mostrar os ícones Editar YAML e Visualizar YAML. Selecione o botão View YAML para abrir o arquivo YAML correspondente ao recurso especificado em uma nova guia do editor.

YAML do pod do Kubernetes aberto usando o ícone "Ver YAML"

Ver registros

É possível fazer streaming e visualizar os registros dos recursos do Kubernetes no console da seção Kubernetes para monitorar o progresso.

Para abrir o visualizador de registros, pressione Ctrl/Cmd+Shift+P ou clique em Visualizar > Paleta de comandos e selecione Cloud Code: Visualizar registros.

Mostrar a caixa de diálogo de registros na paleta de comandos

O visualizador de registros é aberto em uma nova guia do editor.

Visualizador de registros Para conferir os registros de um pod ou contêiner, clique com o botão direito do mouse no recurso e selecione Ver registros.

Como conferir os registros de um pod

Inicie um terminal.

Para pods e contêineres, é possível abrir um terminal interativo clicando com o botão direito do mouse no pod ou contêiner e selecionando Abrir terminal.

Como abrir um terminal interativo

Ações específicas de recursos

A seção 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.

Clusters

  • Adicione um cluster ao Kubeconfig:adicione um cluster do GKE ou minikube existente ou crie um novo.

A caixa de diálogo "Adicionar cluster" aparece, e você pode escolher o projeto e o cluster que quer usar ou criar um novo cluster.

Como escolher a plataforma de cluster

Criar ou escolher um cluster do GKE

  • Definir como cluster ativo:define o cluster especificado como ativo para que o contexto kubectl configurado acesse esse cluster por padrão.

    Definir o cluster como ativo usando o menu do botão direito do mouse

A seção do Kubernetes é atualizada automaticamente, e você vai ver o símbolo do Kubernetes ao lado do cluster apropriado.

Se um cluster tiver vários contextos configurados, você poderá escolher um dos contextos disponíveis para definir como o contexto atual.

Namespaces

  • Definir como namespace ativo:defina um namespace como ativo para que o contexto kubectl configurado acesse esse namespace por padrão.

    Clique com o botão direito do mouse no namespace que você quer definir como ativo.

    Definir o namespace como o contexto atual usando o menu do botão direito do mouse

Se a ação for bem-sucedida, a seção do Kubernetes será atualizada automaticamente e você vai ver um asterisco ao lado do namespace para indicar que ele faz parte do contexto atual.

Um contexto do Kubernetes é um atalho que fornece acesso rápido a um namespace no cluster. Normalmente, os contextos são criados automaticamente quando você inicia um cluster do minikube ou do GKE. Se você não encontrar a opção Definir como contexto atual para um determinado namespace e quiser criar um contexto para ele, use o comando kubectl config set-context no terminal para definir um contexto com o cluster, o usuário e o namespace de sua preferência.

Pods

  • Ver registros:confira os registros de um pod no console da seção Kubernetes.
  • Abrir terminal:receba um terminal para um pod no console da seção Kubernetes.

    Além disso, os pods em execução terão marcas de status coloridas ao lado dos rótulos:

    • Vermelho: o pod está em estado de falha
    • Amarelo: o pod está sendo iniciado ou encerrado.
    • Verde: o pod está normal e em execução
Marca de seleção verde ao lado do pod indicando status íntegro

Contêineres

Implantações

  • Conferir registros:confira os registros de uma implantação no console da seção do Kubernetes.

    As implantações ativas têm marcas de status coloridas ao lado dos rótulos e contagens de réplicas atuais/totais:

    • Amarelo: a implantação não tem disponibilidade mínima nem problemas de imagem;
    • Verde: a implantação está normal e tem disponibilidade mínima.
Ícones de implantação verde indicando status de integridade

Nós

Os nós do cluster terão marcas de status coloridas ao lado dos nomes:

  • Amarelo: o nó apresenta um problema de recurso, como disponibilidade de memória ou disco;
  • Verde: o nó está normal.

Definições de recursos personalizados (CRDs)

A seção Kubernetes lista todas as definições de recursos personalizados (CRDs) instaladas e disponíveis no cluster:

Lista de definições de recursos personalizados na seção

A seguir