Trabalhar com arquivos YAML do Google Cloud e do Kubernetes no Cloud Code para IntelliJ

O Cloud Code foi projetado para ajudar na edição de arquivos de configuração relacionados ao Kubernetes e ao Google Cloud, incluindo validação baseada em esquema, diagnóstico e documentação rápida.

Observação: por motivos de compatibilidade, os recursos de edição do Kubernetes serão desativados automaticamente se o plug-in JetBrains Kubernetes for detectado. Substitua esse plug-in manualmente no menu de configurações do Cloud Code. Para isso, acesse Cloud Code > Kubernetes > Recursos de edição do Kubernetes e selecione a opção Ativar os recursos de edição da configuração do YAML do Kubernetes. Essas medidas de compatibilidade afetam apenas arquivos YAML do Kubernetes. Suporte a outros tipos de configuração YAML tipos de arquivo como o Skaffold não são afetados.

Observação: o suporte à edição YAML do Cloud Build está disponível apenas para arquivos chamados cloudbuild.yaml.

Arquivos de configuração YAML compatíveis

• Anthos Config Management
• Cloud Build
• Config Connector
• Knative (em inglês)
• Kubernetes
• Kustomize (em inglês)
• Migrate to Containers
• Skaffold

O Cloud Code também é compatível com CRDs populares do Kubernetes, como o Kubeflow, pronto para uso.

Observação: para usar a agregação de recursos mais atualizada, você vai precisar da versão mais recente do Cloud Code.

Ativar ou desativar o suporte a YAML

Para ativar ou desativar o suporte a YAML, acesse File > Settings > Tools > Gemini + Google Cloud Code > Kubernetes (para Windows e Linux) ou IntelliJ IDEA > Settings > Tools > Gemini + Google Cloud Code > Kubernetes (para macOS) e selecione ou desmarque a caixa de seleção Enable YAML support para ativar ou desativar o recurso.

Usar esquema personalizado

Com o Cloud Code, é possível fornecer seu próprio esquema de CRD com o IntelliJ Configurações em Arquivo > Configurações > Ferramentas > Gemini + Google Cloud Code > Kubernetes (para Windows e Linux) ou IntelliJ IDEA > Configurações > Ferramentas > Gemini + Google Cloud Code > Kubernetes (para macOS) e depois consulte o esquema de CRD de localização.

É possível apontar para um arquivo local ou um URL. Os URLs que apontam para github.com são convertidos automaticamente em raw.githubusercontent.com.

Extrair esquema de um cluster

Quando você alterna para um cluster que executa o Kubernetes v1.16+ no Kubernetes Explorer, O Cloud Code extrai automaticamente o esquema de todos os CRDs instalados.

Compatibilidade adicional com o Skaffold

O Skaffold é o mecanismo que alimenta Cloud Code, que ajuda você a criar, enviar e implantar seu aplicativo além de fornecer suporte para criar pipelines de CI/CD.

O Cloud Code é compatível com o gerenciamento de arquivos de configuração do Skaffold. Quando você abre um projeto, o Cloud Code detecta Esquemas do Skaffold que não estão atualizados e enviam notificações por meio do log de eventos quando um upgrade da versão do esquema do Skaffold estiver disponível para o Skaffold arquivos de configuração YAML.

Outra opção é navegar até Tools > Gemini + Cloud Code > Kubernetes > Check for Skaffold Schemas Upgrades para conferir se há upgrades de esquema disponíveis.

Configurar com snippets

Snippets prontos para uso para esquemas YAML comuns (usando Ctrl+Espaço para visualizar opções) permitem iniciar um novo arquivo YAML ou adicionar a um já existente sem erros e seguindo as práticas recomendadas. Além disso, é mais fácil trabalhar com campos repetitivos. Basta preencher um, e o Cloud Code preenche as instâncias restantes.

O Cloud Code oferece os seguintes snippets:

• Cloud Build - Cloud Run deployment
• Cloud Build - Docker container build
• Cloud Build - GKE deployment
• Cloud Build - GKE Skaffold deployment
• Cloud Build - Go build
• Cloud Build - Terraform plan + apply
• Config Connector - BigQueryDataset
• Config Connector - BigQueryTable
• Config Connector - BigtableCluster
• Config Connector - BigtableInstance
• Config Connector - PubSubSubscription
• Config Connector - PubSubTopic
• Config Connector - RedisInstance
• Config Connector - SpannerInstance
• Kubernetes - ConfigMap
• Kubernetes - Deployment
• Kubernetes - Ingress
• Kubernetes - Pod
• Kubernetes - Service
• Migrate to Containers - Export
• Migrate to Containers - PersistentVolumeClaim
• Migrate to Containers - StatefulSet
• Skaffold - Bazel
• Skaffold - Getting-started
• Skaffold - Helm deployment
• Skaffold - Kaniko

Completar com contexto

Com base no esquema atual, o Cloud Code fornece conclusões para ajudar você a escolher a opção certa.

Validar esquema YAML

O Cloud Code oferece suporte à validação de esquema sinalizando tags e valores nos arquivos YAML e sugerindo correções quando possível.

Validar arquivos YAML do Skaffold

O Cloud Code oferece suporte adicional de edição de arquivos de configuração do Skaffold e modelos inteligentes que permitem validar seus arquivos skaffold.yaml. Consulte este guia sobre como usar um aplicativo atual com o Cloud Code.

Concluir arquivos de configuração do Skaffold com contexto

Com base no esquema atual, o Cloud Code fornece conclusões contextuais e documentações relevantes para ajudar você a escolher a opção certa.

Descubra definições usando a documentação rápida

O Cloud Code mostra a documentação relevante de um recurso quando você destaca uma linha no arquivo de configuração e navega até Visualizar > Documentação rápida.

Verificar o YAML para problemas de estrutura e validade

O Cloud Code oferece suporte a linting para problemas comuns de esquema e fornece erros descritivos.

Aplicar um arquivo YAML

Para executar kubectl apply -f e aplicar uma alteração de configuração usando o arquivo atual, use o ícone de ações kubectl , disponível no gutter do seu ambiente de desenvolvimento integrado, e selecione Apply. Isso mostra uma diferença para analisar as alterações antes de clicar em Aplicar.

Diferença entre arquivos YAML

Para conferir as diferenças entre um arquivo YAML no controle de origem e um arquivo YAML implantado, use o ícone de ações do kubectl disponível no gutter do editor. Selecione a opção Diff para ver as diferenças. para você comparar e contrastar dois arquivos de esquema.

Executar uma simulação de um arquivo YAML

Para executar uma simulação do arquivo e verificar a validade dele, use o ícone de ações do kubectl , disponível no gutter do seu ambiente de desenvolvimento integrado, para selecionar Simulação no servidor ou Simulação no cliente. Isso executa kubectl apply -f dry-run=server (ou kubectl apply -f dry-run=client, na opção "Cliente") e notifica se seu arquivo pode ser criado na janela de Terminal.

A seguir

• Crie um arquivo skaffold.yaml de configuração de execução do Kubernetes do Cloud Code.
• Crie manualmente uma configuração do Skaffold para seu aplicativo.
• Consulte os documentos de referência do Skaffold.yaml.

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.