Como trabalhar com arquivos YAML do Google Cloud e do Kubernetes

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 o Skaffold, não será 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 (em inglês)
• Kubernetes
• Kustomize (em inglês)
• Migrate para Anthos
• Skaffold

Além disso, 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ê precisará da versão mais recente do Cloud Code.

Como usar esquema personalizado

Além disso, com o Cloud Code, é possível fornecer seu próprio esquema CRD com as configurações do IntelliJ (Arquivo > Configurações > Tools > Cloud Code (em inglês) > Kubernetes ou para Mac OS X, IntelliJ IDEA (em inglês) > Preferências > Tools > Cloud Code (em inglês) > Kubernetes e acesse Locais do esquema CRD).

É 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.

Como extrair o esquema de um cluster

Quando você muda para um cluster que executa o Kubernetes v1.16 e versões posteriores 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, o que ajuda a criar, enviar e implantar seu 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 solicita (por meio do log de eventos) quando uma atualização de versão do esquema do Skaffold está disponível para o YAML do Skaffold atual.

Outra opção é navegar até Ferramentas > Cloud Code > Kubernetes e selecionar Verificar atualizações de esquemas do Skaffold para conferir se há upgrades de esquema disponíveis.

Como configurar com snippets

Os snippets prontos para uso no esquema YAML comum (usando Ctrl+Space para visualizar opções) tornam mais fácil iniciar um novo arquivo YAML ou adicionar um arquivo existente sem erros, basta seguir as práticas recomendadas. Além disso, é mais fácil trabalhar com campos repetitivos. Basta preencher um, e o Cloud Code incluirá as instâncias restantes.

Atualmente, os seguintes snippets são oferecidos:

• 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 for Anthos - Export
• Migrate for Anthos - PersistentVolumeClaim
• Migrate for Anthos - StatefulSet
• Skaffold - Bazel
• Skaffold - Getting-started
• Skaffold - Helm deployment
• Skaffold - Kaniko

Como concluir com contexto

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

Como validar o esquema YAML

O Cloud Code é compatível com a validação de esquema sinalizando tags e valores inválidos nos arquivos YAML e sugerindo correções, quando possível.

Como validar arquivos YAML do Skaffold

O Cloud Code fornece suporte adicional de edição de arquivos de configuração do Skaffold e modelos inteligentes, permitindo validar facilmente seus arquivos skaffold.yaml. Consulte este guia sobre como usar um app com o Cloud Code.

Como 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.

Como ativar a sincronização de arquivos do Skaffold e a recarga dinâmica

Para melhorar a eficiência do fluxo de trabalho de desenvolvimento local e evitar a necessidade de recriar, reimplantar e reiniciar os pods, o Skaffold aceita copiar arquivos alterados para um contêiner implantado. Isso significa que, ao fazer alterações em arquivos de código-fonte e estáticos, você pode ver as alterações entrarem em vigor em questão de segundos, criando um loop de feedback acelerado.

Em arquivos estáticos, como HTML e CSS, o comportamento de cópia desse arquivo é chamado de sincronização de arquivos.

Nos arquivos de código-fonte, esse comportamento é chamado de recarga dinâmica e funciona para os seguintes tipos de arquivo:

• Go: *.go
• Java: *.java, *.kt, *.scala, *.groovy, *.clj.
• NodeJS: *.js, *.mjs, *.coffee, *.litcoffee, *.json

Com a recarga dinâmica configurada, o Skaffold detecta alterações nos arquivos compatíveis e sincroniza essas alterações com o contêiner em execução no cluster, ignorando a necessidade de reconstrução difícil de imagem e reinicialização do pod. No entanto, alterações em outros tipos de arquivo acionam a recriação de uma imagem.

A sincronização automática de arquivos e a recarga dinâmica são ativadas por padrão quando você está trabalhando com o Buildpacks como o builder preferido. Para outros builders como o Docker, especifique uma seção sync no skaffold.yaml para o artefato que você está personalizando.

A configuração de sincronização pode ser uma das seguintes (em ordem de preferência):

• auto (apenas para artefatos Jib e Buildpacks)
• infer
• manual

Se você especificar uma sincronização manual para sincronizar todos os arquivos HTML /static-html com a pasta static no contêiner, seu skaffold.yaml conterá esta seção sync:

build:
  artifacts:
    - image: gcr.io/k8s-skaffold/node-example
      context: node
      sync:
        manual:
          - src: 'static-html/*.html'
            dest: static

Para uma análise detalhada sobre a sincronização de arquivos e a especificação de regras de sincronização, consulte o guia do Skyffold sobre sincronização de arquivos.

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

Ao destacar uma linha no arquivo de configuração e acessar Visualizar > Documentação rápida, o Cloud Code exibe os documentos relevante de um recurso.

Como inspecionar o YAML para problemas de estrutura e validação

O Cloud Code oferece suporte a inspeção de problemas comuns de esquema e fornece erros descritivos.

Como aplicar um arquivo YAML

Para executar kubectl apply -f para 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 levará a uma visualização de diferenças para você revisar as alterações antes de clicar em Aplicar.

Como diferenciar arquivos YAML

Para ver as diferenças entre um arquivo YAML no controle de origem e um arquivo YAML implantado, use o ícone de ação do kubectl disponível no gutter do seu editor. Escolha a opção Diff para abrir uma visualização de diferenças para comparar e comparar dois arquivos de esquema.

Como 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 selecionarSimulação no servidor ou Simulação no cliente de dados. 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.

Como 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.

Você também pode participar do canal #cloud-code, que faz parte da comunidade do Google Cloud no Slack.