Nesta página, você encontra uma visão geral do desenvolvimento do Kubernetes no Cloud Code.
Usar o Kubernetes Explorer no Cloud Code
Com o Kubernetes Explorer, é possível 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, abrir um terminal interativo e pesquisar descrições de recursos com o Kubernetes Explorer.
![Explorador do Kubernetes do Cloud Code](https://cloud.google.com/static/code/docs/intellij/images/kubernetes-explorer-panel.png?authuser=0&hl=pt)
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
no Kubernetes Explorer. 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 kubeconfig padrão, consulte o guia Trabalhar com arquivos kubeconfig.
Acessar o Kubernetes Explorer
Para visualizar e gerenciar os recursos do Kubernetes, use o Kubernetes Explorer, acessível no painel lateral à direita. Outra opção é acessá-lo em Ferramentas > Cloud Code > Kubernetes > Visualizar o Cluster Explorer.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.
Ações básicas
O explorador do Kubernetes usa a tecnologia do kubectl
. Se você tiver configurado o arquivo de configuração kubectl
para acessar seus clusters, será possível usar o Kubernetes Explorer para adicionar clusters e navegar por todos os namespaces, recursos e nós disponíveis para os clusters, independentemente de estarem no contexto ativo ou inativo.
As ações gerais do Kubernetes disponíveis, acessíveis por meio dos ícones no Kubernetes Explorer, são:
Criar um novo aplicativo do Kubernetes com base em uma amostra
Atualizar o Explorador
Abrir a documentação do Kubernetes do Cloud Code em um navegador da Web
Outras ações comuns de depuração do Kubernetes, acessíveis por meio dos ícones no Kubernetes Explorer, são:
Executa a configuração atual de execução/depuração.
Inicia a configuração de execução no modo de depuração.
Interrompe 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 (incluindo nomes de contêiner e cluster). Para copiar um nome de recurso, clique com o botão direito do mouse nele e escolha Copiar nome do recurso.
![Copiar um nome de recurso usando o menu do botão direito do mouse](https://cloud.google.com/static/code/docs/intellij/images/copy-resource-name.png?authuser=0&hl=pt)
Atualizar recursos
O Kubernetes Explorer monitora as alterações e é atualizado automaticamente para refletir as atualizações. Para forçar uma atualização de qualquer recurso do Kubernetes a fim de 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](https://cloud.google.com/static/code/docs/intellij/images/refresh-resource.png?authuser=0&hl=pt)
![Botão de atualização do Kubernetes Explorer](https://cloud.google.com/static/code/docs/intellij/images/kubernetes-explorer-refresh.png?authuser=0&hl=pt)
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. As informações do recurso são apresentadas no painel do console do Kubernetes Explorer.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.
Opções do Skaffold
- Configuração do Skaffold: seleciona um arquivo de configuração
skaffold.yaml
. Será detectado automaticamente se você tiver umskaffold.yaml
no projeto. - Perfil de implantação: seleciona um perfil das opções disponíveis configuradas no seu 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
oufatal
. 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.
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
arquivo skaffold.yaml
.
Ver YAML remoto
Para visualizar o YAML de um recurso no cluster diretamente do 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 Ver YAML remoto.O arquivo YAML correspondente ao recurso especificado será aberto em uma nova guia do editor.
ver registros
É possível fazer streaming e visualizar 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.
Também é possível ver registros de um serviço específico navegando até o Kubernetes Explorer.
Para selecionar o recurso do qual você quer ver registros, como um pod, uma implantação ou um serviço:
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 ver 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.
Descrições de recursos implantados: é possível executar um
kubectl describe
nos recursos implantados para exibir os detalhes clicando com o botão direito do mouse e escolhendo Descrever.
Inicie um terminal
Para pods e contêineres, abra um terminal interativo clicando com o botão direito do mouse no pod ou contêiner e selecionando Obter terminal.
![Como abrir um terminal interativo](https://cloud.google.com/static/code/docs/intellij/images/get-terminal.png?authuser=0&hl=pt)
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.
Acesse o Kubernetes Explorer no painel lateral ou selecione Ferramentas > Cloud Code > Kubernetes > Visualizar o Cluster Explorer.
Para exibir 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.
Clusters
- Adicionar um cluster do Google Kubernetes Engine: adicione um cluster GKE Standard ou Autopilot atual ou crie um novo clicando em + Adicionar cluster do GKE no Kubernetes Explorer.
A caixa de diálogo "Adicionar cluster" é exibida. Escolha o projeto e o cluster que quer usar ou crie um novo cluster.
Depois, clique em OK e acesse o cluster escolhido e os recursos dele por meio do Kubernetes Explorer.Definir como contexto atual: defina o cluster especificado como ativo para que o contexto
kubectl
configurado acesse esse cluster por padrão.
O Kubernetes Explorer é atualizado 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 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](https://cloud.google.com/static/code/docs/intellij/images/multiple-context.png?authuser=0&hl=pt)
Namespaces
Definir como contexto atual: defina um namespace como ativo para que o contexto
kubectl
configurado acesse esse namespace por padrão.
Observe que um contexto do Kubernetes é um atalho que oferece acesso rápido
a um namespace no seu cluster. Em geral, os contextos são criados de modo automático quando você inicia um minikube ou um cluster do GKE. Se você não encontrar a opção Definir como contexto atual para um determinado namespace e quiser criar um contexto para ela, use o comando kubectl config set-context
no terminal para definir um contexto com seu cluster, usuário e namespace preferidos.
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](https://cloud.google.com/static/code/docs/intellij/images/kubernetes-explorer-healthy-pod.png?authuser=0&hl=pt)
Contêineres
- Ver registros: visualize os registros de um contêiner no console do Kubernetes Explorer.
- Ver terminal:acesse o terminal de um contêiner no console do Kubernetes Explorer.
![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](https://cloud.google.com/static/code/docs/intellij/images/stream-container-logs.png?authuser=0&hl=pt)
Implantações
Ver registros: veja 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](https://cloud.google.com/static/code/docs/intellij/images/deploy-status-green.png?authuser=0&hl=pt)
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](https://cloud.google.com/static/code/docs/intellij/images/crd-list.png?authuser=0&hl=pt)
A seguir
- Comece a usar o Cloud Code para IntelliJ para Kubernetes criando e implantando um aplicativo do Kubernetes a partir de uma exemplo de código.
- Use a sincronização de arquivos e a recarga automática para acelerar o desenvolvimento.
- Depurar seu aplicativo no Cloud Code