Acelerar o desenvolvimento no Cloud Code para IntelliJ

Para acelerar o desenvolvimento local no Cloud Code for IntelliJ, aproveite a sincronização de arquivos e o recarregamento em tempo real, a implantação automática ao salvar e use módulos Skaffold para desenvolver partes de um aplicativo separadamente.

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 mudanças em arquivos estáticos e de código-fonte, é possível ver as alterações 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.

Para arquivos de código-fonte, esse comportamento é chamado de recarga dinâmica e é compatível com os seguintes tipos de arquivo:

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

Com a recarga dinâmica configurada, o Skaffold detecta alterações nos arquivos compatíveis e sincroniza essas mudanças com o contêiner em execução no cluster. Alterações nos tipos de arquivo que não são compatíveis com a recarga dinâmica acionam uma recriação de imagem e uma reinicialização de pod.

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 arquivo 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: o Skaffold configura a sincronização automaticamente. (apenas para artefatos Jib e Buildpacks.) Esse é o padrão para Buildpacks.
  • infer: os destinos de cada arquivo alterado são inferidos do builder.
  • manual: é necessário especificar os arquivos no seu espaço de trabalho local e o destino deles no contêiner em execução.

A seção sync de amostra a seguir em um arquivo skaffold.yaml especifica uma sincronização manual para sincronizar todos os arquivos HTML /static-html com a pasta static em um contêiner:

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.

Adicionar novos recursos ao desenvolver no Kubernetes

Depois de configurar a sincronização de arquivos e a recarga dinâmica, inicie um ciclo de iteração e adicione mais recursos ao seu projeto. As mudanças são implantadas no cluster do Kubernetes sem interromper e remover a implantação, criar e marcar a imagem manualmente ou atualizar o cluster.

Um ciclo de iteração padrão é parecido com este:

  1. Faça uma mudança no projeto. Por exemplo, se você estiver usando o app de lista de visitas Java do Cloud Code, adicione um novo endpoint à classe FrontendController da seguinte maneira:

    1. Abra o arquivo FrontendController.java em src/main/java/cloudcode/guestbook/frontend e adicione o seguinte:

      @RequestMapping("/greeting")
      @ResponseBody
      public String greeting(@RequestParam(value="name", defaultValue="World") String name) {
         return String.format("Hello from Kubernetes with IntelliJ, %s!", name);
      }
      
    2. Adicione as importações necessárias para as novas anotações, RequestMapping e ResponseBody.

  2. Salve as mudanças (Ctrl/Cmd+S) ou crie o projeto.

    É possível visualizar os registros de progresso e implantação na janela do console. Depois que as mudanças forem implantadas, confirme as atualizações.

  3. Para encerrar a sessão de desenvolvimento contínuo, clique no ícone Stop.

    O Cloud Code exclui todos os recursos do Kubernetes usados na sessão de desenvolvimento.

Desenvolver aplicativos de microsserviços usando as configurações do Skaffold

Ao desenvolver aplicativos de microsserviço, pode ser útil trabalhar em seções separadas de forma independente para simplificar a depuração e a implantação.

É possível desenvolver e depurar partes do seu aplicativo de forma independente dividindo-o em módulos Skaffold. Por exemplo, o exemplo Bank of Anthos é um aplicativo que contém dez microsserviços. O arquivo skaffold.yaml do exemplo agrupa esses serviços em cinco módulos do skaffold chamados setup, db, frontend, backend e loadgenerator.

Definir módulos e dependências de configuração do Skaffold

Para definir os módulos e as dependências de configuração do Skaffold:

  1. Abra o projeto em que você quer definir os módulos.

  2. Abra o arquivo skaffold.yaml.

  3. Se o arquivo skaffold.yaml tiver várias configurações, para fazer uma configuração um módulo Skaffold, especifique a seguinte linha:

    metadata:
      name: MODULE_NAME_1
    

    Por exemplo, no skaffold.yaml do Bank of Anthos, o módulo db define implantações de banco de dados:

    apiVersion: skaffold/v3
    kind: Config
    metadata:
      name: db # module defining database deployments
    requires:
    - configs:
      - setup
    build:
      artifacts:
      - image: accounts-db
        context: src/accounts-db
      - image: ledger-db
        context: src/ledger-db
    manifests:
      rawYaml:
      - dev-kubernetes-manifests/accounts-db.yaml
      - dev-kubernetes-manifests/ledger-db.yaml
    deploy:
      kubectl: {}
  4. Para configurações que dependem da implantação de outra configuração antes da implantação da configuração atual, adicione a configuração às dependências. Para especificar uma dependência de configuração, adicione uma lista configs à seção requires do arquivo skaffold.yaml.

    Por exemplo, o arquivo skaffold.yaml do Bank of Anthos inclui a dependência de configuração setup.

    Para definir uma dependência, adicione o seguinte ao arquivo skaffold.yaml, em que DEPENDENCY_NAME é o nome da dependência.

    requires:
        - configs: DEPENDENCY_NAME
    

    As configurações listadas dessa forma podem referenciar dependências definidas no mesmo arquivo ou em outros arquivos skaffold.yaml no projeto atual.

  5. Teste suas dependências de configuração criando cada um dos módulos do Skaffold separadamente para garantir que eles sejam implantados com as dependências. Para isso, siga as etapas em Criar módulos específicos do Skaffold e as respectivas dependências.

Criar módulos específicos do Skaffold e as respectivas dependências

Depois de definir os módulos e as dependências deles, você pode especificar quais módulos quer executar na guia Build / Deploy ao selecionar Run > Edit configurations.

  1. Instale as versões mais recentes do Insiders.

  2. Acesse Run > Edit configurations e abra a guia Build / Deploy.

  3. Em Configuração do Skaffold, selecione skaffold.yaml.

    Escolha uma destas opções:

    • Criar e implantar com todos os módulos e dependências
    • Crie e implante com (se os módulos estiverem disponíveis) e selecione os módulos que você quer criar e implantar.

Sua seleção será mantida para as implantações subsequentes. Se você selecionar um subconjunto de módulos, o Cloud Code vai mostrar um aviso sobre a implantação de um subconjunto de módulos, e não de todo o sistema.

Desenvolvimento contínuo no Kubernetes

Depois de configurar o destino de execução com as opções desejadas, você pode optar por uma execução regular do aplicativo ou iniciar um ciclo de iteração de desenvolvimento no ambiente de desenvolvimento integrado para propagar qualquer alteração feita na origem e nas dependências para o aplicativo ativo.

O destino de execução Desenvolver no Kubernetes inicia o ciclo de desenvolvimento no cluster do Kubernetes. Depois de iniciar o ciclo de desenvolvimento, o Cloud Code, usando o Skaffold, cria uma imagem para o projeto, marca essa imagem, envia-a para o repositório configurado e usa o kubectl para implantar os manifestos do Kubernetes do projeto.

  1. Clique no ícone Develop on Kubernetes e em Edit Configurations para abrir a caixa de diálogo Run/Debug Configurations.
  2. Personalize sua implantação usando as opções de configuração disponíveis.
  3. Se você quiser que o Cloud Code reimplante o aplicativo automaticamente após as alterações serem salvas, em Watch mode - rebuild and redeploy, selecione On file save. Os novos aplicativos do Kubernetes têm a opção Sob demanda selecionada por padrão. Para mais informações sobre os modos de exibição, consulte Modos de exibição.
  4. Se o aplicativo estiver configurado para usar módulos Skaffold, você poderá selecionar para criar ou implantar módulos específicos.
  5. Quando estiver satisfeito com a configuração, clique em OK e no ícone Run.

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 > Submit feedback or report an issue para informar um problema no GitHub.