Pesquisa e indexação de conteúdo indexing

Alterações no AEM as a Cloud Service changes-in-aem-as-a-cloud-service

Com o AEM as a Cloud Service, a Adobe está passando de um modelo centrado em instâncias do AEM para uma visualização baseada em serviços com containers n-x do AEM, impulsionada por pipelines de CI/CD no Cloud Manager. Em vez de configurar e manter índices em instâncias únicas do AEM, a configuração de índice deve ser especificada antes de uma implantação. As mudanças de configuração na produção estão claramente quebrando as políticas de CI/CD. O mesmo vale para as alterações de índice, pois podem afetar a estabilidade e o desempenho do sistema se não forem especificadas, testadas e reindexadas antes de serem trazidas para a produção.

Abaixo está uma lista das principais alterações em comparação ao AEM 6.5 e versões anteriores:

Limitações:

Como usar how-to-use

As definições de índice podem ser categorizadas em três casos de uso principais, da seguinte maneira:

Para ambos os itens 1 e 2 acima, é necessário criar uma definição de índice como parte da base de código personalizada no cronograma de lançamento respectivo do Cloud Manager. Para obter mais informações, consulte a documentação Implantação no AEM as a Cloud Service.

Nomes de índice index-names

Uma definição de índice pode se enquadrar em uma das seguintes categorias:

Preparação da nova definição de índice preparing-the-new-index-definition

Para personalizações de um índice OOTB, prepare um novo pacote que contenha a definição de índice real que siga esse padrão de nomenclatura:

<indexName>-<productVersion>-custom-<customVersion>

Para um índice totalmente personalizado, prepare um novo pacote de definição de índice que contenha a definição de índice que siga esse padrão de nomenclatura:

<prefix>.<indexName>-<productVersion>-custom-<customVersion>

Implantação de definições de índice personalizadas deploying-custom-index-definitions

Para ilustrar a implantação de uma versão personalizada do índice pronto para uso damAssetLucene-8, forneceremos um guia passo a passo. Neste exemplo, vamos renomeá-lo para damAssetLucene-8-custom-1. Então, o processo é o seguinte:

Configuração do projeto

É altamente recomendável usar a versão >= 1.3.2 do Jackrabbit filevault-package-maven-plugin. As etapas para incorporá-lo ao seu projeto são as seguintes:

Depois de adicionar a nova definição de índice, implante o novo aplicativo usando o Cloud Manager. Essa implantação inicia dois trabalhos, responsáveis por adicionar (e mesclar, se necessário) as definições de índice ao MongoDB e ao Azure Segment Store para criação e publicação, respectivamente. Antes da mudança, os repositórios subjacentes passam por reindexação com as definições de índice atualizadas.

Gerenciamento de Índice usando Implantações Móveis index-management-using-rolling-deployments

O que é o gerenciamento de índice what-is-index-management

O gerenciamento de índice trata da adição, remoção e alteração de índices. Alterar a definição de um índice é uma tarefa rápida, mas aplicar essa alteração (o que geralmente é chamado de “criação de um índice” ou, para índices existentes, “reindexação”) requer tempo. Não é instantâneo: o repositório deve ser verificado para que os dados sejam indexados.

O que são Implantações Móveis what-are-rolling-deployments

Uma implantação contínua pode reduzir o tempo de inatividade. Ela também permite atualizações sem tempo de inatividade e reversões rápidas. A versão antiga do aplicativo é executada ao mesmo tempo que a nova versão do aplicativo.

Áreas Somente de leitura e de Leitura e gravação read-only-and-read-write-areas

Determinadas áreas do repositório (partes somente de leitura) podem ser diferentes na versão antiga e na nova do aplicativo. As áreas somente leitura do repositório normalmente são /app e /libs. No exemplo a seguir, o itálico é usado para marcar áreas somente de leitura, enquanto o negrito é usado para áreas de leitura e gravação.

As áreas de leitura e gravação do repositório são compartilhadas entre todas as versões do aplicativo, enquanto para cada versão do aplicativo há um conjunto específico de /apps e /libs.

Gerenciamento de índice sem implantações graduais index-management-without-rolling-deployments

Durante o desenvolvimento ou ao usar instalações locais, os índices podem ser adicionados, removidos ou alterados em tempo de execução. Os índices são usados quando estão disponíveis. Se um índice ainda não for usado na versão antiga do aplicativo, ele normalmente será criado durante um tempo de inatividade programado. O mesmo ocorre ao remover um índice ou ao alterar um índice existente. Ao remover um índice, ele fica indisponível quando é removido.

Gerenciamento de índice com implantações graduais index-management-with-rolling-deployments

Com implantações contínuas, não há tempo de inatividade. Por algum tempo durante uma atualização, a versão antiga (por exemplo, a versão 1) do aplicativo e a nova versão (versão 2) são executadas simultaneamente no mesmo repositório. Se a versão 1 exigir que um determinado índice esteja disponível, esse índice não deverá ser removido na versão 2. O índice deve ser removido posteriormente, por exemplo, na versão 3, momento em que se garante que a versão 1 do aplicativo não estará mais em execução. Além disso, os aplicativos devem ser programados de modo que a versão 1 funcione bem, mesmo se a versão 2 estiver em execução e se os índices da versão 2 estiverem disponíveis.

Após a conclusão da atualização para a nova versão, os índices antigos podem ser coletados pela lixeira do sistema. Os índices antigos ainda podem permanecer por algum tempo, para acelerar as reversões (caso elas sejam necessárias).

A tabela a seguir mostra cinco definições de índice: o índice cqPageLucene é usado em ambas as versões, enquanto o índice damAssetLucene-custom-1 é usado somente na versão 2.

O número da versão é incrementado sempre que o índice é alterado. Para evitar que os nomes de índice personalizados colidam com os nomes de índice do produto em si, os índices personalizados e as alterações nos índices prontos para uso devem terminar com -custom-<number>.

Alterações nos índices prontos para uso changes-to-out-of-the-box-indexes

Depois que o Adobe altera um índice pronto para uso, como "damAssetLucene" ou "cqPageLucene", um novo índice chamado damAssetLucene-2 ou cqPageLucene-2 é criado. Ou, se o índice já tiver sido personalizado, a definição dele será mesclada com as alterações no índice pronto para uso, conforme mostrado abaixo. A mesclagem de alterações ocorre automaticamente. Isso significa que você não precisa fazer nada se um índice pronto para uso for alterado. No entanto, é possível personalizar o índice novamente mais tarde.

Limitações atuais current-limitations

Só há suporte para o gerenciamento de índice para índices do tipo lucene, com compatVersion definido como 2. Internamente, outros índices podem ser configurados e usados para consultas, por exemplo, índices Elasticsearch. As consultas gravadas no índice damAssetLucene podem, no AEM as a Cloud Service, ser executadas em uma versão Elasticsearch desse índice. Essa diferença é invisível para o usuário do aplicativo, no entanto, certas ferramentas, como o recurso explain, reportam um índice diferente. Para ver as diferenças entre os índices Lucene e Elasticsearch, consulte a documentação do Elasticsearch no Apache Jackrabbit Oak. Os clientes não podem e não precisam configurar os índices de Elasticsearch diretamente.

Somente os analisadores incorporados são compatíveis (ou seja, os analisadores enviados com o produto). Não há compatibilidade com analisadores personalizados.

Para obter o melhor desempenho operacional, os índices não devem ser excessivamente grandes. O tamanho total de todos os índices pode ser usado como guia. Se esse tamanho aumentar em mais de 100% após a adição de índices personalizados e os índices padrão forem ajustados em um ambiente de desenvolvimento, as definições de índice personalizado deverão ser ajustadas. O AEM as a Cloud Service pode impedir a implantação de índices que afetariam negativamente a estabilidade e o desempenho do sistema.

Adicionar um índice adding-an-index

Para adicionar um índice totalmente personalizado chamado /oak:index/acme.product-custom-1, para ser usado em uma nova versão do aplicativo e posteriores, o índice deve ser configurado da seguinte maneira:

acme.product-1-custom-1

Essa configuração funciona anexando um identificador personalizado ao nome do índice, seguido por um ponto (.). O identificador deve ter de 2 a 5 caracteres de comprimento.

Como descrito acima, essa configuração garante que o índice seja usado somente pela nova versão do aplicativo.

Alterar um índice changing-an-index

Quando um índice existente é alterado, um novo índice deve ser adicionado com a definição de índice alterada. Por exemplo, considere que o índice existente /oak:index/acme.product-custom-1 seja alterado. O índice antigo é armazenado em /oak:index/acme.product-custom-1 e o novo índice é armazenado em /oak:index/acme.product-custom-2.

A versão antiga do aplicativo usa a seguinte configuração:

/oak:index/acme.product-custom-1

A nova versão do aplicativo usa a seguinte configuração (alterada):

/oak:index/acme.product-custom-2

Desfazer uma alteração undoing-a-change

Às vezes, é necessário desfazer uma modificação em uma definição de índice. Isso pode ocorrer devido a um erro inadvertido ou que a modificação não é mais necessária. Pegue, por exemplo, a definição de índice damAssetLucene-8-custom-3, que foi criada por engano e já foi implantada. Consequentemente, você deseja reverter para a definição de índice anterior, damAssetLucene-8-custom-2. Para fazer isso, é necessário introduzir um novo índice chamado damAssetLucene-8-custom-4, que incorpora a definição do índice anterior, damAssetLucene-8-custom-2.

Remover um índice removing-an-index

O seguinte se aplica somente a índices personalizados. Os índices de produto não podem ser removidos, pois são usados pelo AEM.

Se um índice for removido em uma versão posterior do aplicativo, você poderá definir um índice vazio (um índice vazio que nunca é usado e que não contém dados) com um novo nome. Neste exemplo, você pode nomeá-lo como /oak:index/acme.product-custom-3. Este nome substitui o índice /oak:index/acme.product-custom-2. Depois que /oak:index/acme.product-custom-2 for removido pelo sistema, o índice vazio /oak:index/acme.product-custom-3 poderá ser removido. Um exemplo de índice vazio é:

<acme.product-custom-3
        jcr:primaryType="oak:QueryIndexDefinition"
        async="async"
        compatVersion="2"
        includedPaths="/dummy"
        queryPaths="/dummy"
        type="lucene">
        <indexRules jcr:primaryType="nt:unstructured">
            <rep:root jcr:primaryType="nt:unstructured">
                <properties jcr:primaryType="nt:unstructured">
                    <dummy
                        jcr:primaryType="nt:unstructured"
                        name="dummy"
                        propertyIndex="{Boolean}true"/>
                </properties>
            </rep:root>
        </indexRules>
</acme.product-custom-3>

Se não precisar mais de uma personalização de um índice pronto para uso, você deverá copiar a definição desse índice. Por exemplo, se você já implantou o índice damAssetLucene-8-custom-3, mas não precisa mais das personalizações e deseja voltar para o índice padrão (damAssetLucene-8), você deve adicionar um índice damAssetLucene-8-custom-4 que contém a definição de índice de damAssetLucene-8.

Otimizações de índice e consulta index-query-optimizations

O Apache Jackrabbit Oak permite configurações de índice flexíveis para lidar com consultas de pesquisa com eficiência. Os índices são especialmente importantes para repositórios maiores. Certifique-se de que todas as consultas sejam apoiadas por um índice apropriado. Consultas sem um índice adequado podem ler milhares de nós, que são então registrados como um aviso.

Consulte este documento para obter informações sobre como consultas e índices podem ser otimizados.