Visão geral do Kubernetes do Cloud Code para IntelliJ

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

Usar o Kubernetes Explorer no Cloud Code

O Kubernetes Explorer 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, fazer streaming e visualizar registros, abra um terminal interativo e procurar descrições de recursos com a biblioteca Explorador.

Explorador do Kubernetes do Cloud Code

O Cloud Code usa o arquivo kubeconfig padrão, localizado em 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 no Kubernetes Explorer. Os arquivos Kubeconfig são arquivos YAML contendo os detalhes do cluster, o certificado e o token secreto do cluster do Kubernetes para autenticando no cluster.

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

Acessar o Kubernetes Explorer

Para acessar e gerenciar os recursos do Kubernetes, use a API Explorer, que pode ser acessado no painel lateral à direita. Também é possível acessá-lo usando Ferramentas > Cloud Code > Kubernetes > Visualizar Cluster Explorer.

Ao iniciar uma sessão de desenvolvimento ou depuração, a A seção Sessões de desenvolvimento exibe a visualização da geração de registros estruturada.

Painel de sessões de desenvolvimento

Ações básicas

O Kubernetes Explorer usa a tecnologia kubectl. Contanto que você configurou seu arquivo de configuração kubectl para acessar seus clusters, é possível usar o do Kubernetes Explorer para adicionar clusters, procurar todos os namespaces, recursos e nós dos clusters, independentemente de estarem o contexto ativo ou inativo.

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

  • Novo app Kubernetes em um ícone de amostra Criar um novo aplicativo do Kubernetes com base em um exemplo
  • Atualizar ícone do explorador Atualizar a Análise
  • opencone "Abrir Documentos" Abra a documentação do Kubernetes do Cloud Code em um navegador da Web

Outras ações comuns de depuração do Kubernetes, acessíveis pelos ícones no Kubernetes Explorer, são:

  • Ícone do Run Execute a configuração de execução/depuração atual.
  • Ícone de depuração Inicie a configuração de execução no modo de depuração.
  • Ícone de parada de depuração Interromper uma sessão de depuração ativa.

Copiar um nome de 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 um nome de recurso, clique com o botão direito do mouse no recurso e Selecione Copiar nome do recurso.

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

Atualizar recursos

O Kubernetes Explorer detecta alterações e automaticamente é atualizado para refletir as atualizações. Para forçar uma atualização de qualquer recurso do Kubernetes a buscar as informações mais recentes, clique com o botão direito do mouse no recurso e selecione Atualizar.

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

Também é possível forçar a atualização de todo o Kubernetes Explorer usando o botão de atualização do Kubernetes Explorer. Botão de atualização do Kubernetes Explorer

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. As informações do recurso são apresentadas no painel do console do Kubernetes Explorer.

Opção "Descrever" disponível ao clicar com o botão direito do mouse em um recurso apropriado no Kubernetes Explorer e selecionar "Descrever"

Para visualizar os detalhes do recurso, também é possível clicar em qualquer recurso. Caso tenha anexado metadados, os metadados estarão disponíveis no painel "Detalhes do recurso" no Kubernetes Explorer.

Visualização de metadados de recursos no painel "Detalhes do recurso", disponível na segunda metade do Kubernetes Explorer

Opções do Skaffold

  • Configuração do Skaffold: seleciona um arquivo de configuração skaffold.yaml. Será detectado automaticamente se você tiver um skaffold.yaml no projeto.
  • Perfil de implantação: seleciona um perfil das opções disponíveis configuradas no arquivo skaffold.yaml.
  • Variáveis de ambiente: permite configurar variáveis de ambiente extras para serem transmitidas ao processo de implantação do Skaffold. As sinalizações do Skaffold também podem ser configuradas como variáveis de ambiente a serem usadas nesse campo. Consulte a documentação de referência da CLI do Skaffold para uma lista abrangente de variáveis de ambiente disponíveis do Skaffold.
  • Nível de detalhes: permite definir o nível de detalhamento da saída como trace, debug, info, warn, error ou fatal. O nível de detalhes padrão é warn.

Opções do Kubernetes

  • Contexto de implantação: representa o contexto do Kubernetes em que o aplicativo foi implantado. O comportamento padrão, se um contexto de implantação não for especificado, será implantado no contexto atual do sistema, se houver.

    Se preferir não implantar no contexto atual, na seção "Implantação" das configurações de execução/depuração, você pode optar por:

    • Implantar localmente em um cluster do minikube: inicia um cluster do minikube gerenciado pelo Cloud Code para executar o app e interrompe o cluster após a interrupção da implantação. Se um cluster do minikube já estiver em execução, o Cloud Code usará o cluster atual para implantação.
    • Mudar o contexto e implantar para: altera o contexto atual no sistema para o contexto especificado na implantação.

      Como selecionar o contexto de implantação do Kubernetes em uma configuração de execução do Cloud Code

  • Delete deployments when finished: exclui as implantações do Kubernetes quando o processo é finalizado. Esse é o comportamento padrão. Também é possível alternar essa configuração para impedir que as implantações sejam excluídas.

Personalizar a configuração de inicialização

Para configurar como o aplicativo é executado, personalize o skaffold.yaml.

Também é possível configurar a inicialização nas configurações de execução/depuração. Para editar as configurações, acesse Run > Edit configurations.

Ver YAML remoto

Para conferir o YAML de um recurso no cluster, acesse o Kubernetes Explorer. Navegue até um recurso no Kubernetes Explorer, como um pod, clique com o botão direito do mouse no nome do recurso e selecione Visualizar YAML remoto.

O arquivo YAML correspondente ao recurso especificado será aberto em um novo editor .

Visualizar o YAML de um pod clicando com o botão direito do mouse no rótulo dele no Kubernetes Explorer e escolher "Ver YAML remoto"

Ver registros

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

Depois que o aplicativo for criado e executado no modo normal ou de desenvolvimento, será possível monitorar o streaming de registros do app no seu ambiente de desenvolvimento integrado.

Como visualizar registros transmitidos do aplicativo Hello World Java

Também é possível conferir os registros de um serviço específico navegando até o Kubernetes Explorer.

Para selecionar o recurso do qual você quer ver os registros, como um pod, uma implantação ou um serviço:

  1. Clique com o botão direito do mouse no recurso e selecione Registros de stream. Como alternativa, é possível transmitir registros de contêineres individuais executados em pods.

    Isso gera registros para o console do Kubernetes Explorer.

Para conferir o status dos recursos na implantação:

  • Status de pod, implantação e nó: esses recursos do Kubernetes terão marcações de status coloridas ao lado dos rótulos. Vermelho para o estado com falha, amarelo para início/encerramento/alerta e verde para o estado íntegro e pretendido.

    A marca de seleção verde ao lado do rótulo do pod indica que o status é íntegro

  • Descrições de recursos implantadas: é possível executar kubectl describe nos implantados para exibir os detalhes, clicando com o botão direito do mouse e escolhendo Descrever.

    Descrever opção disponível ao clicar com o botão direito do mouse em um recurso apropriado
no painel do Kubernetes Explorer e escolher "Descrever"

Inicie um terminal.

Para pods e contêineres, abra um terminal interativo clicando com o botão direito do mouse. pod ou contêiner e selecionando Ver terminal.

Como abrir um terminal interativo

Ações específicas de recursos

O Kubernetes Explorer 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 o Kubernetes Explorer, é possível executar ações exclusivas em alguns desses recursos.

Você pode acessar o Kubernetes Explorer no painel lateral ou acessar Ferramentas > Cloud Code > Kubernetes > Veja o Cluster Explorer.

Painel do Kubernetes Explorer aberto usando a guia na barra de tarefas do lado direito

Para mostrar os detalhes dos recursos implantados, clique com o botão direito do mouse em um rótulo de recurso no Kubernetes Explorer e clique em Descrever.

Opção "Descrever" disponível ao clicar com o botão direito do mouse em um recurso apropriado no painel do Kubernetes Explorer

Clusters

  • Adicionar um cluster do Google Kubernetes Engine:adicione um cluster padrão ou Autopilot do GKE ou crie um novo clicando em + Adicionar cluster do GKE no Kubernetes Explorer.

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

Depois disso, clique em OK e acesse o cluster escolhido e os recursos subjacentes por meio do Kubernetes Explorer.

Como adicionar um cluster do GKE com a caixa de diálogo do Kubernetes Explorer, com campos para nomes de projeto e de cluster

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

    Como definir um cluster como o contexto atual com o Kubernetes Explorer

O Kubernetes Explorer é atualizado automaticamente, e você verá Símbolo do Kubernetes ao lado do cluster apropriado.

Se um cluster tiver vários contextos configurados, será possível para escolher um dos contextos disponíveis para definir como o contexto atual.

Como escolher e configurar um cluster ativo em uma lista de vários contextos com o Kubernetes Explorer

Namespaces

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

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

Se essa ação for bem-sucedida, o Kubernetes Explorer será atualizado automaticamente, e um asterisco vai aparecer ao lado do namespace para indicar que ele é parte do contexto atual.

O contexto do Kubernetes é um atalho que oferece 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: visualize os registros de um pod no console do Kubernetes Explorer.
  • Obter terminal: receba um terminal para um pod no Console do Kubernetes Explorer.

    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 status de integridade da indicação de pod

Contêineres

Como fazer streaming de registros de um contêiner usando o menu do botão direito do mouse para gerar registros no Console do Kubernetes Explorer

Implantações

  • Acessar registros: acesse os registros de uma implantação no console do Kubernetes Explorer.

    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 verdes indicando status íntegro

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)

O Kubernetes Explorer 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 no Explorer

A seguir

Receber suporte

Para enviar um feedback ou informar um problema no ambiente de desenvolvimento integrado do IntelliJ, acesse Tools > Cloud Code > Help / About > Envie feedback ou informe um problema para informar um problema no GitHub ou faça uma pergunta no Stack Overflow.