Implantação do AEM as a Cloud Service

Última atualização em 2024-01-05
  • Tópicos
  • Deploying
    Exibir mais informações sobre este tópico

Introdução

Os fundamentos do desenvolvimento de código são semelhantes no AEM as a Cloud Service em comparação às soluções locais do AEM e Managed Services. Desenvolvedores(as) criam o código e o testam localmente, e depois o enviam para ambientes remotos do AEM as a Cloud Service. O uso do Cloud Manager, que era uma ferramenta opcional de entrega de conteúdo do Managed Services, é obrigatório. Esta ferramenta de entrega é agora o único mecanismo para implantar código nos ambientes de desenvolvimento, preparo e produção do AEM as a Cloud Service. Para uma rápida validação e depuração de recursos antes da implantação desses ambientes mencionados, o código pode ser sincronizado de um ambiente local para um ambiente de desenvolvimento rápido.

A atualização da versão do AEM é sempre um evento de implantação separado do envio de código personalizado. Vistas de outra maneira, as versões de código personalizado devem ser testadas em relação à versão do AEM que está em produção, pois esta será implantada primeiro. As atualizações da versão do AEM que ocorrem depois disso são frequentes e aplicadas automaticamente. Elas são feitas para serem compatíveis com versões anteriores do código do cliente já implantado.

O resto deste documento descreverá como os desenvolvedores devem adaptar suas práticas para que possam trabalhar com as atualizações da versão do AEM as a Cloud Service e as atualizações do cliente.

Versões do cliente

Codificar na versão correta do AEM

Para soluções anteriores do AEM, a versão mais recente era alterada com pouca frequência (geralmente de forma anual com pacotes de serviços trimestrais) e os clientes atualizavam as instâncias de produção para o Quickstart mais recente no seu próprio ritmo, referenciando o Jar da API. No entanto, os aplicativos do AEM as a Cloud Service são atualizados automaticamente para a versão mais recente com mais frequência, portanto, o código personalizado para versões internas deve ser criado baseado na versão mais recente do AEM.

Assim como nas versões fora da nuvem do AEM já existentes, haverá suporte para um desenvolvimento local e offline com base em um Quickstart específico, e essa deve ser a ferramenta preferencial para depuração na maioria dos casos.

OBSERVAÇÃO

Existem algumas diferenças operacionais sutis entre a maneira como o aplicativo funciona em um computador local comparado à Adobe Cloud. Essas diferenças de arquitetura devem ser respeitadas durante o desenvolvimento local e podem resultar em um comportamento diferente ao implantar na infraestrutura em nuvem. Devido a essas diferenças, é importante executar testes exaustivos nos ambientes de desenvolvimento e de preparo antes de implantar o novo código personalizado na produção.

Para desenvolver um código personalizado para uma versão interna, a versão relevante do SDK do AEM as a Cloud Service deve ser baixada e instalada. Para obter informações adicionais sobre o uso das ferramentas do Dispatcher do AEM as a Cloud Service, consulte esta página.

O vídeo a seguir fornece uma visão geral de alto nível sobre como implantar código no AEM as a Cloud Service:

Implantação de pacotes de conteúdo por meio do Cloud Manager e do Gerenciador de pacotes

Implantações por meio do Cloud Manager

Clientes implantam código personalizado em ambientes na nuvem por meio do Cloud Manager. O Cloud Manager transforma pacotes de conteúdo montados localmente em um artefato compatível com o modelo de recurso do Sling, que é a forma como um aplicativo do AEM as a Cloud Service é descrito ao ser executado em um ambiente na nuvem. Como resultado, ao examinar os pacotes do Gerenciador de pacotes em ambientes na nuvem, o nome incluirá “cp2fm” e os pacotes transformados terão todos os metadados removidos. Não é possível interagir com eles, o que significa que não podem ser baixados, replicados ou abertos. A documentação detalhada sobre o conversor pode ser encontrada aqui.

Os pacotes de conteúdo criados para aplicativos do AEM as a Cloud Service devem ter uma separação clara entre conteúdo imutável e mutável, e o Cloud Manager só instalará o conteúdo mutável, além de exibir uma mensagem como esta:

Generated content-package <PACKAGE_ID> located in file <PATH> is of MIXED type

O resto desta seção descreverá a composição e as implicações dos pacotes imutáveis e mutáveis.

Pacotes de conteúdo imutáveis

Todo conteúdo e código persistente no repositório imutável deve ser verificado no Git e implantado por meio do Cloud Manager. Em outras palavras, ao contrário das soluções atuais do AEM, o código nunca é implantado diretamente em uma instância em execução do AEM. Esse fluxo de trabalho garante que o código executado para determinada versão seja idêntico em qualquer ambiente da nuvem, o que elimina o risco de uma variação não intencional do código na produção. Como exemplo, a configuração do OSGI deve ser enviada para o controle de origem em vez de ser gerenciada no tempo de execução por meio do gerenciador de configuração do console da web do AEM.

Visto que o aplicativo muda devido ao padrão de implantação que é habilitado por um botão, ele não pode depender de alterações no repositório mutável, com exceção das alterações nos usuários de serviço, seus ACLs, tipos de nó e definições de índice.

Para clientes com bases de código já existentes, é muito importante realizar o exercício de reestruturação de repositório descrito na documentação do AEM para garantir que o conteúdo anteriormente contido em /etc seja movido para o local correto.

Algumas restrições adicionais se aplicam a esses pacotes de código, por exemplo, instalar ganchos não são compatíveis.

Configuração OSGI

Como mencionado acima, a configuração do OSGI deve ser confirmada pelo controle de origem em vez do console da web. As técnicas para fazer isso incluem:

  • Fazer as alterações necessárias no ambiente local do desenvolvedor do AEM com o gerenciador de configuração do console da web do AEM e então exportar os resultados para o projeto do AEM no sistema de arquivos local
  • Criar a configuração do OSGI manualmente no projeto do AEM no sistema de arquivos local, e então referenciar o gerenciador de configuração do console do AEM para os nomes de propriedades.

Leia mais sobre a configuração do OSGI em Configuração do OSGi para o AEM as a Cloud Service.

Conteúdo mutável

Em alguns casos, pode ser útil preparar as alterações de conteúdo no controle de origem para que elas possam ser implantadas pelo Cloud Manager sempre que um ambiente for atualizado. Por exemplo, pode ser razoável propagar determinadas estruturas de pastas raiz. Ou, é possível alinhar as alterações nos modelos editáveis para habilitar componentes de políticas que foram atualizados pela implantação do aplicativo.

Há duas estratégias para descrever o conteúdo que é implementado pelo Cloud Manager no repositório mutável: pacotes de conteúdo mutável e instruções repoinit.

Pacotes de conteúdo mutáveis

Conteúdos como hierarquias de caminho de pasta, usuários de serviço e controles de acesso (ACLs) normalmente são confirmados em um projeto do AEM baseado no arquétipo Maven. As técnicas incluem exportar do AEM ou gravar diretamente como XML. Durante o processo de criação e implantação, o Cloud Manager compacta o pacote de conteúdo mutável resultante. O conteúdo mutável é instalado em três momentos diferentes durante a fase de implantação no pipeline:

Antes da inicialização da nova versão do aplicativo:

  • definições de índice (adicionar, modificar, remover)

Durante a inicialização da nova versão do aplicativo, mas antes da mudança:

  • Usuários do serviço (adicionar)
  • ACLs do usuário do serviço (adicionar)
  • tipos de nó (adicionar)

Após a mudança para a nova versão do aplicativo:

  • Todos os outros conteúdos podem ser definidos por meio do Jackrabbit Vault. Por exemplo:
    • Pastas (adicionar, modificar, remover)
    • Modelos editáveis (adicionar, modificar, remover)
    • Configuração sensível ao contexto (qualquer item abaixo de /conf) (adicionar, modificar, remover)
    • Scripts (os pacotes podem acionar ganchos de instalação em vários estágios do processo de instalação do pacote. Consulte a documentação do Jackrabbit Filevault sobre ganchos de instalação. O AEM CS usa atualmente a versão 3.4.0 do Filevault, que limita os ganchos de instalação a admins, usuários do sistema e membros do grupo de admins).

É possível limitar a instalação de conteúdo mutável para criar ou publicar incorporando pacotes em uma pasta install.author ou install.publish sob /apps. A reestruturação para refletir esta separação foi efetuada no AEM 6.5 e os detalhes sobre a reestruturação de projetos recomendada podem ser encontrados na documentação do AEM 6.5.

OBSERVAÇÃO

Os pacotes de conteúdo são implantados em todos os tipos de ambiente (desenvolvimento, preparo, produção). Não é possível limitar a implantação a um ambiente específico. Esta limitação está em vigor para garantir a opção de uma execução de teste automatizada. Um conteúdo específico de um ambiente requer instalação manual por meio do Gerenciador de pacotes.

Além disso, não há mecanismo para reverter as alterações no pacote de conteúdo mutável depois de terem sido aplicadas. Se clientes detectarem um problema, poderão optar por corrigi-lo na próxima versão do código ou, como último recurso, restaurar o sistema inteiro para um determinado estado antes da implantação.

Todos os pacotes de terceiros incluídos devem ser validados como compatíveis com o AEM as a Cloud Service, caso contrário, sua inclusão resultará em uma falha na implantação.

Como mencionado acima, clientes que já possuem suas bases de código devem estar em conformidade com o exercício de reestruturação do repositório, que é necessário para as alterações do repositório 6.5 descritas na documentação do AEM 6.5.

Repoinit

Nos casos a seguir, é preferível adotar a abordagem de codificação manual para criação de conteúdo explícito com instruções repoinit em configurações de fábrica do OSGI:

  • Criar/excluir/desativar usuários do serviço

  • Criar/excluir grupos

  • Criar/excluir usuários

  • Adicionar ACLs

    OBSERVAÇÃO

    A definição de ACLs requer que as estruturas de nó já estejam presentes. Portanto, talvez sejam necessárias instruções de criação de caminho anteriores.

  • Adicionar caminho (por exemplo, para estruturas de pastas raiz)

  • Adicionar CNDs (definições de tipo de nó)

O repoinit é recomendado nesses casos de uso de modificação de conteúdo compatíveis devido aos seguintes benefícios:

  • O Repoinit cria recursos na inicialização para que a lógica possa tomar a existência desses recursos como garantida. Na abordagem do pacote de conteúdo mutável, os recursos são criados após a inicialização, portanto, o código do aplicativo que depende deles pode falhar.
  • O Repoinit é um conjunto de instruções relativamente seguro, pois você controla explicitamente a ação a ser tomada. Além disso, as únicas operações compatíveis são aditivas, exceto em alguns casos relacionados à segurança que permitem a remoção de usuários, usuários de serviço e grupos. Em contrapartida, a remoção de algo na abordagem do pacote de conteúdo mutável é explícita; ao definir um filtro, qualquer item presente que seja coberto por um filtro é excluído. Ainda assim, deve-se ter cuidado, pois com qualquer conteúdo há cenários em que a presença de novo conteúdo pode alterar o comportamento do aplicativo.
  • O Repoinit realiza operações rápidas e precisas. Em contraste, os pacotes de conteúdo variável podem depender muito do desempenho das estruturas cobertas por um filtro. Mesmo que você atualize um único nó, um instantâneo de uma árvore grande pode ser criado.
  • É possível validar as instruções repoinit em um ambiente de desenvolvimento local no tempo de execução, porque elas são executadas quando a configuração OSGi é registrada.
  • As instruções Repoinit são exatas e explícitas e são ignoradas se o estado já for equivalente.

Quando o Cloud Manager implanta o aplicativo, ele executa essas instruções, independentemente da instalação de qualquer pacote de conteúdo.

Para criar instruções repoinit, siga o procedimento abaixo:

  1. Adicione a configuração OSGi para PID de fábrica org.apache.sling.jcr.repoinit.RepositoryInitializer em uma pasta de configuração do projeto. Use um nome descritivo para a configuração, como org.apache.sling.jcr.repoinit.RepositoryInitializer~initstructure.
  2. Adicione instruções repoinit à propriedade de script da configuração. A sintaxe e as opções estão documentadas na Documentação do Sling. Observe que deve haver a criação explícita de uma pasta principal antes de suas pastas secundárias. Por exemplo, uma criação explícita de /content antes de /content/myfolder, antes de /content/myfolder/mysubfolder. Para ACLs configuradas em estruturas de baixo nível, é recomendável defini-las em um nível superior e trabalhar com uma restrição rep:glob. Por exemplo, (allow jcr:read on /apps restriction(rep:glob,/msm/wcm/rolloutconfigs)).
  3. Valide no ambiente de desenvolvimento local no tempo de execução.
AVISO

Para ACLs definidas para nós abaixo de /apps ou /libs a repoinit, a execução começa em um repositório em branco. Os pacotes são instalados após repoinit, portanto, as declarações não podem se basear em nada definido nos pacotes, mas devem definir as pré-condições como as estruturas principais abaixo.

DICA

Para ACLs, a criação de estruturas profundas pode ser complicada. Portanto, é mais razoável definir uma ACL em um nível mais alto e restringir onde ela deve atuar por meio de uma restrição rep:glob.

Mais detalhes sobre repoinit podem ser encontrados na documentação do Sling

Gerenciador de Pacotes “únicos” para Pacotes de conteúdo variável

Há casos de uso em que um pacote de conteúdo deve ser instalado como “único”. Por exemplo, importação de conteúdo específico da produção para o preparo a fim de depurar um problema de produção. Para esses cenários, o Gerenciador de pacotes pode ser usado em ambientes do AEM as a Cloud Service.

Como o Gerenciador de pacotes é um conceito de tempo de execução, não é possível instalar conteúdo ou código no repositório imutável, portanto, esses pacotes de conteúdo devem ter apenas conteúdo mutável (principalmente /content ou /conf). Se o pacote de conteúdo incluir conteúdo misto (conteúdo mutável e imutável), somente o conteúdo mutável será instalado.

IMPORTANTE

A interface do Gerenciador de Pacotes pode retornar uma mensagem de erro indefinido se um pacote demorar mais de dez minutos para ser instalado.

Esse tempo não se deve a um erro na instalação, mas a um tempo limite que o Cloud Service tem para todas as solicitações.

Não repita a instalação se esse erro aparecer. A instalação está ocorrendo corretamente em segundo plano. Se você reiniciar a instalação, alguns conflitos poderão ser introduzidos por vários processos de importação simultâneos.

Todos os pacotes de conteúdo instalados por meio do Cloud Manager (mutáveis e imutáveis) aparecem em um estado congelado na interface de usuário do Gerenciador de pacotes do AEM. Esses pacotes não podem ser reinstalados, recriados ou mesmo baixados, e são listados com um sufixo "cp2fm", indicando que sua instalação foi gerenciada pelo Cloud Manager.

Incluindo pacotes de terceiros

É comum que os clientes incluam pacotes pré-criados de origem de terceiros, como fornecedores de software, por exemplo, os parceiros de tradução da Adobe. A recomendação é hospedar esses pacotes em um repositório remoto e referenciá-los no pom.xml. Esse método é possível para repositórios públicos e também para repositórios privados com proteção por senha, conforme descrito em repositórios maven protegidos por senha.

Se não for possível armazenar o pacote em um repositório remoto, os clientes podem colocá-lo em um repositório Maven local, baseado no sistema de arquivos, que é confirmado no SCM como parte do projeto. Ele será referenciado por qualquer coisa que dependa dele. O repositório é declarado no pom do projeto, conforme ilustrado abaixo:

<repository>
    <id>project.local</id>
    <name>project</name>
    <url>file:${maven.multiModuleProjectDirectory}/repository</url>
</repository>

Todos os pacotes de terceiros incluídos devem seguir as diretrizes de codificação e compactação do AEM as a Cloud Service descritas neste artigo, caso contrário, sua inclusão resultará em uma falha na implantação.

O seguinte trecho do Maven POM.xml mostra como os pacotes de terceiros podem ser incorporados ao pacote “Container” do projeto, normalmente denominado “todos”, por meio da configuração do plug-in filevault-package-maven-plugin do Maven.

...
<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <extensions>true</extensions>
  <configuration>
      ...
      <embeddeds>

          ...

          <!-- Include any other extra packages  -->
          <embedded>
              <groupId>com.vendor.x</groupId>
              <artifactId>vendor.plug-in.all</artifactId>
              <type>zip</type>
              <target>/apps/vendor-packages/container/install</target>
          </embedded>
      <embeddeds>
  </configuration>
</plugin>
...

Como funcionam as implantações contínuas

Assim como as atualizações do AEM, as versões do cliente são implantadas usando uma estratégia de implantação contínua para eliminar o tempo de inatividade do cluster do autor nas circunstâncias certas. A sequência geral de eventos é descrita abaixo, onde os nós com as versões antiga e nova do código do cliente estão executando a mesma versão de código do AEM.

  • Os nós com a versão antiga ficam ativos e um candidato a lançamento para a nova versão é criado e disponibilizado.
  • Se houver definições de índice novas ou atualizadas, os índices correspondentes serão processados. Os nós da versão antiga sempre usarão os índices antigos, enquanto os nós da nova versão sempre usarão os novos índices.
  • Os nós da nova versão são inicializados, enquanto as versões antigas ainda fornecem tráfego.
  • Os nós da versão antiga ficam em execução e continuam funcionando, enquanto os nós com a nova versão são verificados quanto à prontidão por meio de verificações de integridade.
  • Os nós com a nova versão que estão prontos para aceitar o tráfego, substituem os nós com a versão antiga, que são desativados.
  • Com o tempo, os nós da versão antiga são substituídos por nós da nova versão até que apenas estes permaneçam, concluindo assim a implantação.
  • Qualquer conteúdo mutável novo ou modificado é então implantado.

Índices

Os índices novos ou modificados geram uma etapa extra de indexação ou reindexação antes que a nova versão possa receber tráfego. Detalhes sobre a gestão de índices no AEM as a Cloud Service podem ser encontrados neste artigo. É possível verificar o status de indexação das páginas de criação no Cloud Manager e receber uma notificação quando a nova versão estiver pronta para receber tráfego.

OBSERVAÇÃO

O tempo necessário para uma implantação contínua varia dependendo do tamanho do índice. A razão é que a nova versão não pode aceitar o tráfego até que o novo índice seja gerado.

No momento, o AEM as a Cloud Service não funciona com ferramentas de gerenciamento de índice, como a ferramenta ACS Commons Ensure Oak Index.

Replicação

O mecanismo de publicação é compatível com versões anteriores das APIs Java™ de Replicação do AEM.

Para desenvolver e testar a replicação com o início rápido do AEM pronto para nuvem, os recursos clássicos de replicação precisam ser usados com uma configuração de Autor/Publicação. Se o ponto de entrada da interface no AEM Author for removido da nuvem, os usuários irão para o http://localhost:4502/etc/replication para configuração.

Código compatível com versões anteriores para implantações em andamento

Como detalhado acima, a estratégia de implantação contínua do AEM as a Cloud Service implica que as versões antigas e novas possam estar funcionando ao mesmo tempo. Portanto, tenha cuidado com alterações de código que não sejam compatíveis com a versão antiga do AEM que ainda está em operação.

Além disso, a versão antiga deve ser testada quanto à compatibilidade com qualquer nova estrutura de conteúdo mutável aplicada pela nova versão em caso de reversão, já que o conteúdo mutável não é removido.

Usuários do serviço e alterações de ACL

Alterar os usuários do serviço ou as ACLs que acessam o conteúdo ou o código pode levar a erros nas versões anteriores do AEM, resultando no acesso a esse conteúdo ou código com usuários de serviço desatualizados. Para lidar com esse comportamento, é recomendado fazer alterações distribuídas em pelo menos duas versões, com a primeira versão funcionando como uma ponte antes da limpeza da versão subsequente.

Alterações de índice

Se forem feitas alterações nos índices, é importante que a nova versão continue a usar seus índices até que seja encerrada, enquanto a versão antiga use seu próprio conjunto modificado de índices. O desenvolvedor deve seguir as técnicas de gerenciamento de índice descritas neste artigo.

Codificação conservadora para reversões

Se uma falha for relatada ou detectada após a implantação, pode ser necessário reverter para a versão antiga. Certifique-se de que o novo código seja compatível com quaisquer novas estruturas criadas pela nova versão, uma vez que essas estruturas (qualquer conteúdo mutável) não serão revertidas. Se o código antigo não for compatível, as correções precisarão ser aplicadas nas versões subsequentes do cliente.

Ambientes de desenvolvimento rápido (RDE)

Os ambientes de desenvolvimento rápido (ou RDEs, sigla em inglês) permitem que os desenvolvedores implantem e revisem alterações rapidamente, minimizando o tempo necessário para testar recursos que já comprovadamente funcionam em um ambiente de desenvolvimento local.

Diferentemente dos ambientes de desenvolvimento comuns, que implantam código por meio do pipeline do Cloud Manager, os desenvolvedores usam ferramentas de linha de comando para sincronizar o código de um ambiente de desenvolvimento local com o RDE. Depois que as alterações forem testadas com sucesso em um RDE, implante-as em um ambiente de desenvolvimento na nuvem normal por meio do pipeline do Cloud Manager, que coloca o código pelos portais de qualidade apropriados.

Modos de execução

Nas soluções do AEM existentes, os clientes têm a opção de executar instâncias com modos de execução arbitrários e aplicar a configuração OSGI ou instalar pacotes OSGI nessas instâncias específicas. Os modos de execução definidos normalmente incluem o serviço (autor e publicação) e o ambiente (RDE, desenvolvimento, preparo, produção).

O AEM as a Cloud Service, por outro lado, é mais opinativo sobre quais modos de execução estão disponíveis e como os pacotes OSGI e a configuração OSGI podem ser mapeados para eles:

  • Os modos de execução da configuração OSGI devem fazer referência ao RDE, desenvolvimento, preparo e produção, no caso do ambiente ou do autor, e à publicação, no caso do serviço. Uma combinação de <service>.<environment_type> O é compatível, enquanto esses ambientes precisam ser usados nessa ordem específica (por exemplo, author.dev ou publish.prod). Os tokens OSGI devem ser referenciados diretamente do código, em vez de usar o método getRunModes, que não incluirá mais o environment_type no tempo de execução. Para obter mais informações, consulte Configuração do OSGi para o AEM as a Cloud Service.
  • Os modos de execução de pacotes OSGI são limitados ao serviço (autor, publicação). Os pacotes OSGI do modo por execução devem ser instalados no pacote de conteúdo em install.author ou install.publish.

O AEM as a Cloud Service não permite o uso de modos de execução para instalar conteúdo em ambientes ou serviços específicos. Se um ambiente de desenvolvimento precisar ser semeado com dados ou HTML que não estejam nos ambientes de preparo ou produção, o Gerenciador de pacotes poderá ser usado.

As configurações compatíveis do modo de execução são:

  • config (o padrão, que se aplica a todos os serviços do AEM)
  • config.author (Aplica-se a todos os serviços AEM Author)
  • config.author.dev (Aplica-se ao serviço do AEM Dev Author)
  • config.author.rde (aplica-se ao serviço de autor do RDE do AEM)
  • config.author.stage (Aplica-se ao serviço Autor de preparação AEM)
  • config.author.prod (Aplica-se ao serviço Autor de produção AEM)
  • config.publish (Aplica-se ao serviço Publicação AEM)
  • config.publish.dev (Aplica-se ao serviço Desenvolvimento e Publicação AEM)
  • config.publish.rde (aplica-se ao serviço de publicação do RDE do AEM)
  • config.publish.stage (Aplica-se ao serviço Preparação de publicação AEM)
  • config.publish.prod (Aplica-se serviço Produção de publicação AEM)
  • config.dev (Aplica-se a serviços de Desenvolvimento AEM)
  • config.rde (aplica-se aos serviços do RDE)
  • config.stage (Aplica-se a serviços de Preparo AEM)
  • config.prod (Aplica-se a serviços de Produção AEM)

A configuração OSGI que tem mais modos de execução correspondentes é usada.

Ao desenvolver localmente, um parâmetro de inicialização do modo de execução, -r, é usado para especificar a configuração OSGI do modo de execução.

$ java -jar aem-sdk-quickstart-xxxx.x.xxx.xxxx-xxxx.jar -r publish,dev

Configuração das tarefas de manutenção no controle de origem

As configurações da Tarefa de manutenção precisam ser mantidas no controle de origem já que a tela Ferramentas > Operações não estará disponível nos ambientes na nuvem. Esse benefício garante que as alterações sejam intencionalmente mantidas, em vez de reativamente aplicadas e esquecidas. Consulte o artigo Tarefa de manutenção para informações adicionais.

Nesta página