Acelere o desenvolvimento no Cloud Code para VS Code

Para acelerar o desenvolvimento local no Cloud Code para VS Code, aproveite a sincronização de arquivos, a recarga automática, a implantação automática ao salvar e os módulos do Skaffold para desenvolver partes de um aplicativo separadamente.

Ativar a sincronização e a recarga automática de arquivos do Skaffold

Para melhorar a eficiência do fluxo de trabalho de desenvolvimento local e evitar a necessidade de recriar, reimplantar e reiniciar seus pods, o Skaffold é compatível com a cópia de arquivos alterados para um contêiner implantado. Isso significa que, ao fazer alterações em arquivos estáticos e de código-fonte, as alterações entram em vigor em segundos, criando um feedback loop 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 automática configurada, o Skaffold detecta alterações nos arquivos compatíveis e sincroniza essas alterações com o contêiner em execução no cluster. As mudanças nos tipos de arquivo que não são compatíveis com a recarga automática acionam uma recompilação de imagem e uma reinicialização do 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, é possível especificar 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: especifique os arquivos no espaço de trabalho local e o destino deles no contêiner em execução.

A seção sync de exemplo 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 automática, inicie um ciclo de iteração e adicione mais recursos ao projeto. As alterações são implantadas no cluster do Kubernetes sem interromper e remover a implantação, criar e incluir tags manualmente na imagem ou atualizar o cluster.

Um ciclo de iteração padrão é semelhante ao seguinte:

  1. Faça uma alteração no seu projeto. Por exemplo, se você estiver usando o aplicativo Livro 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 configurações do Skaffold

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

É possível desenvolver e depurar partes do seu aplicativo de maneira independente dividindo-o em módulos do Skaffold. Por exemplo, a amostra do Banco do Anthos é um aplicativo que contém dez microsserviços. O arquivo skaffold.yaml do exemplo agrupa esses serviços em cinco módulos 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, especifique a seguinte linha para transformar uma configuração em um módulo do Skaffold:

    metadata:
      name: MODULE_NAME_1
    

    Por exemplo, no banco do Anthos skaffold.yaml, 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 atual, adicione a configuração às dependências. Para especificar uma dependência de configuração, adicione uma lista de 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 seu arquivo skaffold.yaml, em que DEPENDENCY_NAME é o nome da sua dependência.

    requires:
        - configs: DEPENDENCY_NAME
    

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

  5. Teste as dependências de configuração criando cada um dos módulos do Skaffold separadamente para garantir que sejam implantados com as dependências deles. Basta seguir as etapas em Criar módulos específicos do Skaffold e as dependências deles.

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

Depois de definir seus módulos e as dependências deles, você pode especificar quais módulos quer executar com o código da nuvem no arquivo launch.json.

Se o projeto não tiver um arquivo launch.json definido, ao executar Cloud Code: Run on Kubernetes ou Cloud Code: Debug on Kubernetes, você precisará selecionar os módulos a serem criados:

  1. Abra a Paleta de comandos (Ctrl/Cmd+Shift+P) e execute o Cloud Code: Run on Kubernetes.
  2. Clique em Select modules.
  3. Escolha os módulos que você quer implantar e clique em OK. Cada módulo é criado com as próprias dependências.
  4. Quando solicitado, escolha um registro de imagem e pressione Enter.

Se o projeto tiver um launch.json, siga estas etapas para escolher os módulos do Skaffold a serem criados:

  1. Abra o arquivo launch.json do projeto.

  2. Edite a configuração de inicialização para adicionar a opção skaffoldFlags com uma lista delimitada por vírgulas de modules para criar. Se skaffoldFlags for omitido, todos os módulos serão criados.

      {
        "name": "Run on Kubernetes",
        "type": "cloudcode.kubernetes",
        "request": "launch",
        "skaffoldConfig": "${workspaceFolder}/skaffold.yaml",
        "skaffoldFlags": {
           "modules": ["MODULE_NAME_2,MODULE_NAME_2"],
        "watch": true,
        "cleanUp": true,
        }
      }
    
  3. Execute a configuração de inicialização que você editou.

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 as mudanças feitas na origem e nas dependências do aplicativo ativo.

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

  1. Personalize sua implantação usando as opções de configuração disponíveis.
  2. Se o aplicativo estiver configurado para usar módulos do Skaffold, será possível selecionar módulos específicos para criar ou implantar.
  3. Abra a paleta de comandos (pressione Ctrl/Cmd+Shift+P) e execute o comando Cloud Code: Run on Kubernetes.
  4. Confirme se você quer usar o contexto do Kubernetes atual para executar o aplicativo (ou alternar para um preferido). Para mais informações sobre como configurar um contexto do Kubernetes, consulte Como configurar.
  5. Se você escolheu um cluster remoto como contexto, quando solicitado, escolha um registro de imagem para enviar as imagens. Se você estiver usando o Container Registry, poderá navegar até um registro atual ou especificar o nome de um registro a ser criado. Se o projeto tiver a API Artifact Registry ativada e pelo menos um repositório do Artifact Registry, é possível navegar e selecionar um repositório existente do Artifact Registry. de dados.

    O Cloud Code, em seguida, cria os contêineres, os envia para o registro, aplica as configurações do Kubernetes ao cluster e aguarda o lançamento.

A seguir

Receber suporte

Acesse o GitHub (em inglês) para enviar feedback e informar problemas ou faça uma pergunta no Stack Overflow.