Implantação do AEM as a Cloud Service

Introdução

Os fundamentos do desenvolvimento de código são semelhantes em AEM em comparação às soluções AEM no local e Managed Services. Os desenvolvedores gravam o código e o testam localmente, que é então enviado para o AEM remoto como um ambiente Cloud Service. O Cloud Manager, que era uma ferramenta de delivery de conteúdo opcional para Managed Services, é necessário. Esse agora é o único mecanismo para implantar código para AEM como ambientes Cloud Service.

A atualização da AEM versão é sempre um evento de implantação separado do código personalizado. De outra forma, as versões de código personalizadas devem ser testadas em relação à versão AEM que está em produção, já que isso é o que será implantado no topo. AEM atualizações de versão que ocorrem depois disso, que serão frequentes e automaticamente aplicadas. Eles são compatíveis com o código do cliente já implantado.

O restante desse documento descreverá como os desenvolvedores devem adaptar suas práticas para que trabalhem com as atualizações de versão do Cloud Service e com as atualizações do cliente.

NOTE

Recomenda-se que os clientes com bases de código existentes passem pelo exercício de reestruturação do repositório descrito na AEM documentação.

Versões do cliente

Codificação na versão AEM direita

Para as soluções AEM anteriores, a versão AEM mais atual era alterada com pouca frequência (aproximadamente uma vez por ano com service packs trimestrais) e os clientes atualizavam as instâncias de produção para o início rápido mais recente em seu próprio tempo, referenciando o API Jar. No entanto, AEM como aplicativos Cloud Service são atualizados automaticamente para a versão mais recente do AEM com mais frequência, portanto, o código personalizado para versões internas deve ser criado em relação à versão AEM mais recente.

Assim como para versões AEM não-na-nuvem existentes, um desenvolvimento local e offline baseado em um início rápido específico será suportado e deverá ser a ferramenta preferida para depuração na maioria dos casos.

NOTE

Existem diferenças operacionais sutis entre o comportamento do aplicativo em uma máquina local e a Adobe Cloud. Essas diferenças arquitetônicas devem ser respeitadas durante o desenvolvimento local e podem levar a um comportamento diferente ao implantar na infraestrutura de nuvem. Devido a essas diferenças, é importante executar testes exaustivos em ambientes dev e stage 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 AEM como um SDK Cloud Service deve ser baixada e instalada. Para obter informações adicionais sobre como usar o AEM como ferramentas do Dispatcher Cloud Service, consulte esta página.

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

NOTE

Recomenda-se que os clientes com bases de código existentes passem pelo exercício de reestruturação do repositório descrito na AEM documentação.

Implantação de pacotes de conteúdo pelo Cloud Manager e pelo Package Manager

Implantações pelo Cloud Manager

Os clientes implantam código personalizado para ambientes em nuvem por meio do Cloud Manager. Observe que o Cloud Manager transforma pacotes de conteúdo montados localmente em um artefato que está em conformidade com o Modelo de recurso Sling, que é como um AEM como um aplicativo Cloud Service é descrito ao executar um ambiente em nuvem. Como resultado, ao analisar os pacotes no Package Manager em ambientes da Cloud, o nome incluirá "cp2fm" e os pacotes transformados terão todos os metadados removidos. Eles não podem ser interagidos, 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 escritos para AEM como aplicativos Cloud Service devem ter uma separação clara entre conteúdo imutável e mutável e o Cloud Manager a imporá ao falhar na criação, enviando uma mensagem como:

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

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

Pacotes de conteúdo imutáveis

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

À medida que as alterações do aplicativo devido ao padrão de implantação Blue-Green são ativadas por um switch, elas não podem depender de alterações no repositório mutável, com exceção dos usuários do serviço, de suas ACLs, tipos de nó e alterações na definição do índice.

Para os clientes com bases de código existentes, é essencial passar pelo exercício de reestruturação do repositório descrito em AEM documentação para garantir que o conteúdo anteriormente sob o /etc seja movido para o local correto.

Configuração do OSGI

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

  • Efetuar as alterações necessárias no ambiente de AEM local do desenvolvedor com o gerenciador de configuração do console da Web AEM e, em seguida, exportar os resultados para o projeto AEM no sistema de arquivos local
  • Criando a configuração OSGI manualmente no projeto AEM no sistema de arquivos local, a referência ao gerenciador de configuração do console AEM para os nomes das propriedades.

Leia mais sobre a configuração de OSGI em Configuração de OSGi para AEM como um Cloud Service.

Conteúdo variável

Em alguns casos, pode ser útil preparar alterações de conteúdo no controle de origem para que ele possa ser implantado pelo Gerenciador de nuvem sempre que um ambiente for atualizado. Por exemplo, pode ser razoável implantar determinadas estruturas de pastas raiz ou alinhar alterações em modelos editáveis para ativar políticas nesses componentes que foram atualizados pela implantação do aplicativo.

Há duas estratégias para descrever o conteúdo que será implantado pelo Cloud Manager no repositório mutável, pacotes de conteúdo mutável e declarações de redirecionamento.

Pacotes de conteúdo variável

Conteúdo como hierarquias de caminho de pasta, usuários de serviço e controles de acesso (ACLs) são normalmente comprometidos em um projeto de AEM baseado em arquétipo de pasta. As técnicas incluem exportar de AEM ou gravar diretamente como XML. Durante o processo de criação e implantação, o Cloud Manager agrupa o pacote de conteúdo mutável resultante. O conteúdo mutável é instalado em 3 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 alternar para a nova versão do aplicativo:

  • Todos os outros conteúdos definíveis através do cofre do Jackrabbit. Por exemplo:
    • Pastas (adicionar, modificar, remover)
    • Modelos editáveis (adicionar, modificar, remover)
    • Configuração sensível ao contexto (qualquer item em /conf) (adicionar, modificar, remover)
    • Scripts (os pacotes podem acionar os ganchos de instalação em vários estágios do processo de instalação da instalação do pacote)

É 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 em /apps. Detalhes a serem encontrados em AEM documentação sobre a reestruturação recomendada do projeto.

NOTE

Os pacotes de conteúdo são implantados em todos os tipos de ambientes (dev, stage, prod). Não é possível limitar a implantação a um ambiente específico. Essa limitação está em vigor para garantir a opção de uma execução de teste de execução automatizada. O conteúdo específico a um ambiente requer instalação manual por meio do Package Manager.

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

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

Como mencionado acima, os clientes com bases de código existentes devem estar em conformidade com o exercício de reestruturação do repositório descrito em AEM documentação.

Repontar

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

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

  • Criar/excluir grupos

  • Criar/excluir usuários

  • Adicionar ACLs

    NOTE

    A definição de ACLs exige que as estruturas de nó já estejam presentes. Portanto, as declarações de criação de caminho anteriores podem ser necessárias.

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

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

É preferível reapontar para esses casos de uso de modificação de conteúdo suportado devido aos seguintes benefícios:

  • A opção de realocação cria recursos na inicialização para que a lógica possa tomar a existência desses recursos como adquiridos. 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 realocamento é um conjunto de instruções relativamente seguro, já que você controla explicitamente a ação a ser tomada. Além disso, as únicas operações suportadas são aditivas, com exceção de alguns casos relacionados à segurança, que permitem a remoção de Usuários, Usuários do serviço e Grupos. Pelo contrário, a eliminação de algo na abordagem do pacote de conteúdos mutáveis é explícita; conforme você define um filtro, qualquer item presente coberto por um filtro será excluído. Ainda assim, deve-se ter cuidado, pois com qualquer conteúdo há cenários nos quais a presença de novo conteúdo pode alterar o comportamento do aplicativo.
  • Repontar realiza operações rápidas e atômicas. Em contraste, os pacotes de conteúdo variável podem depender muito do desempenho das estruturas cobertas por um filtro. Mesmo se você atualizar um único nó, um instantâneo de uma árvore grande pode ser criado.
  • É possível validar instruções repoinit em um ambiente dev local em tempo de execução, uma vez que serão executadas quando a configuração OSGi for registrada.
  • As declarações de redirecionamento são atômicas e explícitas e ignorarão se o estado já corresponde.

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

Para criar declarações de recondução, siga o procedimento abaixo:

  1. Adicione a configuração OSGi para o 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 script da configuração. A sintaxe e as opções estão documentadas em Documentação do Sling. Observe que deve haver uma criação explícita de uma pasta pai antes de suas pastas filhas. Por exemplo, uma criação explícita de /content antes de /content/myfolder, antes de /content/myfolder/mysubfolder. Para ACLs sendo definidas em estruturas de nível baixo, é recomendável definir essas 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 dev local no tempo de execução.
WARNING

Para ACLs definidas para nós abaixo de /apps ou /libs, a execução de redirecionamento será start em um repositório em branco. Os pacotes são instalados após o redirecionamento, de modo que as instruções não podem depender de nada definido nos pacotes, mas devem definir as condições prévias como as estruturas pai abaixo.

TIP

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 o local onde ela deve agir por meio de uma restrição rep:glul.

Mais detalhes sobre a recomendação podem ser encontrados na documentação Sling

Gerenciador de pacotes "one-offs" para pacotes de conteúdo variável

Há casos de uso em que um pacote de conteúdo deve ser instalado como um "one off". Por exemplo, importar conteúdo específico da produção para o armazenamento temporário para depurar um problema de produção. Para esses cenários, o Gerenciador de pacotes pode ser usado em AEM como ambientes Cloud Service.

Como o Package Manager é 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 consistir apenas em 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.

Todos os pacotes de conteúdo instalados pelo Cloud Manager (mutáveis e imutáveis) serão exibidos em um estado congelado AEM interface do usuário do Package Manager. Esses pacotes não podem ser reinstalados, recriados ou mesmo baixados e serã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 fontes terceirizadas, como fornecedores de software como parceiros de tradução Adobe. A recomendação é hospedar esses pacotes em um repositório remoto e referenciá-los no pom.xml. Isso é 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 o armazenamento do pacote em um repositório remoto não for possível, os clientes poderão colocar em um repositório Maven local baseado em sistema de arquivos, que é enviado para SCM como parte do projeto e referenciado pelo que depender dele. O repositório seria declarado nos exemplos de projeto a seguir:

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

Todos os pacotes de terceiros incluídos devem estar em conformidade com o AEM como um código de serviço de Cloud Service e diretrizes de empacotamento descritos neste artigo, caso contrário sua inclusão resultará em uma falha de implantação.

O trecho Maven POM XML a seguir mostra como os pacotes de terceiros podem ser incorporados ao pacote "Contêiner" do projeto, normalmente denominado 'all', por meio da configuração de plug-in filevault-package-maven-plugin do Maven.

...
<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <extensions>true</extensions>
  <configuration>
      ...
      <subPackages>
           
          <!-- Include the application's ui.apps and ui.content packages -->
          ...
 
          <!-- Include any other extra packages such as AEM WCM Core Components -->
          <!-- Set the version for all dependencies, including 3rd party packages, in the project's Reactor POM -->
          <subPackage>
              <groupId>com.adobe.cq</groupId>
              <artifactId>core.wcm.components.all</artifactId>
              <filter>true</filter>
          </subPackage>
 
 
          <subPackage>
              <groupId>com.3rdparty.groupId</groupId>
              <artifactId>core.3rdparty.artifactId</artifactId>
              <filter>true</filter>
          </subPackage>
      <subPackages>
  </configuration>
</plugin>
...

Como funcionam as implantações em andamento

Como as atualizações AEM, as versões de clientes são implantadas usando uma estratégia de implantação móvel para eliminar o tempo ocioso do cluster do autor nas circunstâncias certas. A sequência geral de eventos é a descrita abaixo, onde Blue é a versão antiga do código do cliente e Green é a nova versão. Azul e Verde estão executando a mesma versão do código AEM.

  • A versão azul está ativa e um candidato a lançamento para Verde está criado e disponível
  • Se houver definições de índice novas ou atualizadas, os índices correspondentes serão processados. Observe que a implantação azul sempre usará os índices antigos, enquanto o verde sempre usará os novos índices.
  • O verde está começando enquanto o Blue ainda serve
  • O azul está funcionando e servindo enquanto o Verde está sendo verificado quanto à prontidão por meio de verificações de integridade
  • Nós verdes que estão prontos para aceitar o tráfego e substituir os nós Azul, que são desativados
  • Com o tempo, os nós de azul são substituídos por nós de verde até que apenas o verde permaneça, concluindo assim a implantação
  • Qualquer conteúdo mutável novo ou modificado é implantado

Índices

Índices novos ou modificados causarão uma etapa adicional de indexação ou reindexação antes que a nova versão (verde) possa entrar no tráfego. Detalhes sobre o gerenciamento de índice em AEM como Cloud Service pode ser encontrado em este artigo. Você pode verificar o status do trabalho de indexação na página de criação do Cloud Manager e receberá uma notificação quando a nova versão estiver pronta para receber tráfego.

NOTE

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

No momento, a AEM como Cloud Service não funciona com ferramentas de gerenciamento de índice, como a ferramenta ACS Commons Garanta índice de carvalho.

Replicação

O mecanismo de publicação é compatível com as APIs de Java de replicação AEM.

Para desenvolver e testar a replicação com a nuvem pronta AEM início rápido, os recursos de replicação clássicos precisam ser usados com uma configuração de Autor/Publicação. No caso de o ponto de entrada da interface do usuário no autor de AEM ter sido removido para a nuvem, os usuários iriam para http://localhost:4502/etc/replication para a configuração.

Código compatível com versões anteriores para implantações contínuas

Como detalhado acima, AEM como uma estratégia de implantação móvel implica que tanto as versões antigas quanto as novas possam estar operando ao mesmo tempo. Portanto, tenha cuidado com as alterações de código que não são retroativamente 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 para compatibilidade com qualquer nova estrutura de conteúdo mutável aplicada pela nova versão no evento de reverter, já que o conteúdo mutável não é removido.

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

A alteração dos usuários do serviço ou das ACLs necessárias para acessar o conteúdo ou o código pode levar a erros nas versões mais antigas AEM resultando no acesso a esse conteúdo ou código com usuários desatualizados do serviço. Para lidar com esse comportamento, uma recomendação é fazer alterações distribuídas em pelo menos duas versões, com a primeira versão funcionando como uma ponte antes de limpar a versão subsequente.

Alterações de índice

Se forem feitas alterações nos índices, é importante que a versão Azul continue a usar seus índices até que seja encerrada, enquanto a versão Verde usa 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 retornos

Se uma falha for relatada ou detectada após a implantação, é possível que uma reversão para a versão Azul seja necessária. Seria aconselhável garantir que o código azul seja compatível com quaisquer novas estruturas criadas pela versão verde, uma vez que as novas 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.

Runmode

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

AEM como Cloud Service, por outro lado, tem mais opinião 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 a dev, stage, prod para o ambiente ou autor, publish para o serviço. Uma combinação de <service>.<environment_type> está sendo suportada, embora seja necessário usá-la 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 environment_type no tempo de execução. Para obter mais informações, consulte Configuração do OSGi para AEM como Cloud Service.
  • Os modos de execução de pacotes OSGI são limitados ao serviço (autor, publicação). Os pacotes OSGI de modo por execução devem ser instalados no pacote de conteúdo em install/author ou install/publish.

Como as soluções AEM existentes, não há como usar os modos de execução para instalar apenas o conteúdo de ambientes ou serviços específicos. Se fosse desejado implantar um ambiente dev com dados ou HTML que não esteja no estágio ou na produção, o gerenciador de pacotes poderia ser usado.

As configurações de modo de execução suportadas são:

  • config (o padrão se aplica a todos os AEM Services)
  • config.author (Aplica-se a todos os serviços de autor de AEM)
  • config.author.dev (Aplica-se ao serviço de autor de desenvolvedor AEM)
  • config.author.stage (Aplica-se ao serviço Autor de preparo AEM)
  • config.author.prod (Aplica-se ao serviço Autor de produção AEM)
  • config.publish (Aplica-se ao serviço de publicação do AEM)
  • config.publish.dev (Aplica-se ao serviço de publicação de desenvolvedor AEM)
  • config.publish.stage (Aplica-se ao serviço de publicação de preparo AEM)
  • config.publish.prod (Aplica-se ao serviço de publicação de produção AEM)
  • config.dev (*Aplica-se aos serviços AEM Dev)
  • config.stage (*Aplica-se a AEM serviços de armazenamento temporário)
  • config.prod (*Aplica-se aos serviços de produção AEM)

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

Ao desenvolver localmente, um parâmetro de inicialização do modo de execução pode ser passado para ditar qual configuração do modo de execução OSGI será usada.

Configuração do Tarefa de Manutenção no Controle de Origem

As configurações de Tarefa de manutenção devem ser mantidas no controle de origem, pois a tela Ferramentas > Operações não estará mais disponível nos ambientes da Cloud. Isto tem o benefício de assegurar que as mudanças sejam intencionalmente persistentes, em vez de aplicadas de forma reativa e talvez esquecidas. Consulte o artigo Tarefa de manutenção para obter mais informações.

Nesta página