Trabalhar com arquivos YAML do Google Cloud e do Kubernetes no Cloud Code for 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. A compatibilidade com outros tipos de arquivos de configuração YAML, como Skaffold, não é afetada.

Observação: o suporte à edição de 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
• Kubernetes
• Kustomize (em inglês)
• Migrate to Containers
• Skaffold

O Cloud Code também oferece suporte a CRDs conhecidos do Kubernetes, como o Kubeflow, prontos para uso.

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

Ativar ou desativar o suporte a YAML

Para ativar ou desativar o suporte ao 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 Windows e Linux) ou IntelliJ IDEA > Settings > Tools > Gemini + Google Cloud Code ou desmarque a caixa de seleção Gemini + Google Cloud Code ou desmarque a caixa de seleção Gemini + Google Cloud Code>

Usar esquema personalizado

Com o Cloud Code, você pode fornecer seu próprio esquema de CRD com as configurações do IntelliJ navegando até File > Settings > Tools > Gemini + Google Cloud Code > Kubernetes (para Windows e Linux) ou IntelliJ IDEA > Settings > Gemini Tools >>

É 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 subjacente que alimenta o Cloud Code. Ele ajuda a criar, enviar e implantar o aplicativo, além de fornecer suporte para a criação de pipelines de CI/CD.

O Cloud Code é compatível com o gerenciamento de arquivos de configuração do Skaffold. Ao abrir um projeto, o Cloud Code detecta esquemas do Skaffold que não estão atualizados e avisa, por meio do log de eventos, quando um upgrade da versão do esquema do Skaffold está disponível para os arquivos de configuração YAML atuais do Skaffold.

Como alternativa, acesse Ferramentas > Gemini + Cloud Code > Kubernetes > Verificar upgrades de esquema do Skaffold para conferir se há upgrades de esquema disponíveis.

Configurar com snippets

Os snippets prontos para uso no esquema YAML comum (usando Ctrl+Espaço para ver as opções) permitem que você inicie um novo arquivo YAML ou adicione a um existente sem erros, seguindo as práticas recomendadas. Além disso, é mais fácil trabalhar com campos repetitivos. Basta preencher um, e o Cloud Code preencherá 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 preenchimentos contextuais para ajudar você a escolher a opção certa.

Validar esquema YAML

O Cloud Code oferece suporte à validação de esquema ao sinalizar tags e valores inválidos nos seus arquivos YAML e sugerir correções quando possível.

Validar arquivos YAML do Skaffold

O Cloud Code oferece suporte extra à edição de arquivo 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 os arquivos de configuração do Skaffold com contexto

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

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

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

YAML de lint para problemas estruturais e de validade

O Cloud Code oferece suporte a inspeção 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 do kubectl , disponível no gutter do ambiente de desenvolvimento integrado, e selecione Aplicar. Isso vai mostrar as diferenças para você analisar as mudanças antes de clicar em Aplicar.

Diferença entre arquivos YAML

Para visualizar 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 conferir as diferenças e comparar 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 da kubectl , disponível no gutter do 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 o aplicativo.
• Veja 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.