Visão geral do Cloud Code para VS Code do Kubernetes

Nesta página, você terá uma visão geral do desenvolvimento do Kubernetes no Cloud Code.

Usar a seção Kubernetes no Cloud Code

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

Seção do Kubernetes no 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 do Kubernetes. Kubeconfig são arquivos YAML que contêm detalhes do cluster do Kubernetes, certificado e token secreto para autenticação no cluster.

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

Acessar a seção Kubernetes

Para visualizar e gerenciar os recursos do Kubernetes, acesse a seção Kubernetes clicando em Cloud Code e expandindo a seção Kubernetes. Para conferir as sessões de depuração ou criar um app de exemplo, expanda 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 exibe 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 expanda a seção Sessões de desenvolvimento.

Ações básicas

A seção Kubernetes usa a tecnologia kubectl. Contanto que você tenha configurado o arquivo de configuração kubectl para acessar os clusters, será possível usar a seção Kubernetes para adicionar clusters e procurar todos os namespaces, recursos e nós disponíveis para os clusters, independentemente de estarem no contexto ativo ou inativo.

Seção do Kubernetes

As ações gerais do Kubernetes disponíveis, que podem ser acessadas por meio dos ícones na seção Kubernetes, são:

  • adicionar KubeConfig
  • refresh Atualizar 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 disponíveis do Kubernetes, que podem ser acessadas por meio dos ícones na seção Sessões de desenvolvimento do Kubernetes, são:

  • Ícone de amostra para abrir o Kubernetes Abra um aplicativo de amostra do Kubernetes
  • play_arrow Executar o aplicativo
  • Ícone de depuração Depurar o app

Copiar o nome de um recurso

Qualquer nome de recurso do Kubernetes pode ser copiado para a área de transferência, incluindo nomes de contêiner e cluster. Para copiar o nome de um recurso, clique com o botão direito nele e escolha Copy resource name.

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

Atualizar recursos

A seção Kubernetes detecta alterações e é atualizada automaticamente para refletir as atualizações. Para forçar a 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

Você também pode forçar a 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 exibir 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 exibe as informações do recurso. Descreva os detalhes do recurso no menu do botão direito

Personalizar a configuração de inicialização

Para configurar como o aplicativo é executado, 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 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 Ver YAML. Selecione o botão Ver YAML para abrir o arquivo YAML correspondente ao recurso especificado em uma nova guia do editor.

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

Mostrar registros

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

Para abrir o visualizador de registros, abra a paleta de comandos pressionando Ctrl/Cmd+Shift+P ou clicando em Visualizar > Paleta de comandos e selecione Cloud Code: visualizar registros.

Caixa de diálogo "Ver 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 visualizar registros de um pod

Inicie um terminal

Para pods e contêineres, clique com o botão direito do mouse no pod ou contêiner e selecione Receber terminal para abrir um terminal interativo.

Como abrir um terminal interativo

Ações específicas de recursos

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

Clusters

  • Adicionar um cluster ao Kubeconfig: adicione um cluster atual do GKE ou do minikube ou crie um novo.

A caixa de diálogo "Adicionar cluster" é exibida. Nela, é possível escolher o projeto e o cluster que você quer usar ou criar um novo.

Como escolher a plataforma de clusters

Crie ou escolha um cluster do GKE

  • Definir como cluster ativo: define o cluster especificado como ativo para que o contexto de 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 Kubernetes é atualizada automaticamente, e você verá o símbolo do Kubernetes ao lado do cluster apropriado.

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

Namespaces

  • Definir como namespace ativo:define um namespace como ativo para que o contexto de 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 namespace como o contexto atual usando o menu do botão direito

Se essa ação for bem-sucedida, a seção do Kubernetes será atualizada automaticamente e você 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 minikube ou um cluster do GKE. Se a opção Definir como contexto atual não for exibida para um determinado namespace e você quiser criar um contexto para ele, use o comando kubectl config set-context no terminal para definir um contexto com seu cluster, usuário e namespace preferidos.

Pods

  • Visualizar registros:acesse os registros de um pod no console da seção do Kubernetes.
  • Acessar o terminal:acesse o terminal de um pod no Console da seção do 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 de integridade

Contêineres

  • Visualizar registros:acesse os registros de um contêiner no console da seção do Kubernetes.
  • Acessar o terminal:acesse o terminal de um contêiner no console da seção do Kubernetes.

Implantações

  • Visualizar registros: visualize 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 verdes de implantação indicando o 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, na sigla em inglês) instaladas e disponíveis no cluster:

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

A seguir