使用离线重新索引以减少升级期间的停机时间 offline-reindexing-to-reduce-downtime-during-upgrades

简介 introduction

升级Adobe Experience Manager的主要挑战之一是执行就地升级时与创作环境相关的停机时间。 内容作者在升级期间将无法访问环境。 因此，希望最小化执行升级所需的时间。 对于大型存储库，特别是AEM Assets项目，通常具有大型数据存储和每小时高级别的资源上传，重新索引Oak索引需要花费大量升级时间。

本节介绍如何使用Oak-run工具在执行升级之前​ 重新索引存储库，从而减少实际升级期间的停机时间。 所介绍的步骤可以应用于AEM 6.4及更高版本的Lucene索引。

概述 overview

随着功能集的扩展，新版本的AEM引入了Oak索引定义的更改。 对Oak索引所做的更改会在升级AEM实例时强制重新编制索引。 由于资源中的文本（例如PDF文件中的文本）被提取并编制索引，因此重新索引对于资源部署而言代价高昂。 使用MongoMK存储库，数据通过网络保留，从而进一步增加重新索引所花费的时间。

大多数客户在升级过程中面临的问题是缩短停机时间。 解决方案是在升级期间​ 跳过 ​重新索引活动。 这可以通过创建新指令​ prior ​来执行升级，然后在升级期间直接导入这些指令来实现。

方针 approach

其思想是在升级之前使用Oak-run工具针对目标AEM版本的索引定义创建索引。 上图显示了离线重新索引方法。

此外，这是方法中描述的步骤顺序：

文本提取 text-extraction

要在AEM中启用完全索引，将提取二进制文件(如PDF)中的文本并将其添加到索引中。 在索引过程中，这通常是代价高昂的步骤。 文本提取是一个优化步骤，尤其适合在资产存储库存储大量二进制文件时对其重新编制索引。

使用带有tika库的oak-run工具，可以提取存储在系统中的二进制文件中的文本。 可以在升级之前克隆生产系统，并可用于此文本提取过程。 然后，此过程将执行以下步骤来创建文本存储：

1. 遍历存储库并收集二进制文件的详细信息

此步骤会生成一个包含二进制文件元组的CSV文件，其中包含一个路径和一个blob ID。

从要创建索引的目录执行以下命令。 以下示例假定存储库主目录。

java java -jar oak-run.jar tika <nodestore path> --fds-path <datastore path> --data-file text-extraction/oak-binary-stats.csv --generate

其中nodestore path是mongo_ur或crx-quickstart/repository/segmentstore/

请使用--fake-ds-path=temp参数而不是–fds-path来加快进程。

2。重用现有索引 ​中可用的二进制文本存储

从现有系统中转储索引数据并提取文本存储。

可以使用以下命令转储现有的索引数据：

java -jar oak-run.jar index <nodestore path> --fds-path=<datastore path> --index-dump

其中nodestore path是mongo_ur或crx-quickstart/repository/segmentstore/

然后，使用上述索引转储填充存储：

java -jar oak-run.jar tika --data-file text-extraction/oak-binary-stats.csv --store-path text-extraction/store --index-dir ./indexing-result/index-dumps/<oak-index-name>/data populate

其中oak-index-name是全文索引的名称，例如“lucene”。

3。 使用针对上述步骤 ​中遗漏的二进制文件的tika库运行文本提取进程

java -cp oak-run.jar:tika-app-1.21.jar org.apache.jackrabbit.oak.run.Main tika --data-file text-extraction/oak-binary-stats.csv --store-path text-extraction/store --fds-path <datastore path> extract

其中datastore path是二进制数据存储的路径。

创建的文本存储区可以更新，并可在将来重新索引方案。

有关文本提取过程的更多详细信息，请参阅Oak运行文档。

脱机重新索引 offline-reindexing

在升级前脱机创建Lucene索引。 如果使用MongoMK，则建议直接在某个MongoMk节点上运行它，因为这可避免网络开销。

要脱机创建索引，请执行以下步骤：

1. 为目标AEM版本 ​生成Oak Lucene索引定义

转储现有的索引定义。 发生更改的索引定义是使用目标AEM版本的AdobeGranite存储库包和oak-run生成的。

要转储​ 源 AEM实例的索引定义，请运行此命令：

java -jar oak-run.jar index --fds-path <datastore path> <nodestore path> --index-definitions

其中datastore path和nodestore path来自​ 源 AEM实例。

然后，使用目标版本的Granite存储库包从​ 目标 AEM版本生成索引定义。

java -cp oak-run.jar:bundle-com.adobe.granite.repository.jar org.apache.jackrabbit.oak.index.IndexDefinitionUpdater --in indexing-definitions_source.json --out merge-index-definitions_target.json --initializer com.adobe.granite.repository.impl.GraniteContent

以上步骤创建一个名为merge-index-definitions_target.json的JSON文件，该文件是索引定义。

2。在存储库 ​中创建检查点

在生产​ 源 AEM实例中创建生命周期较长的检查点。 此操作应在克隆存储库之前完成。

通过位于http://serveraddress:serverport/system/console/jmx的JMX控制台，转到CheckpointMBean并创建一个具有足够长的生命周期（例如，200天）的检查点。 为此，调用CheckpointMBean#createCheckpoint，并将17280000000作为生命周期持续时间（以毫秒为单位）的参数。

完成此操作后，复制新创建的检查点ID并使用JMX CheckpointMBean#listCheckpoints验证生命周期。

有关更多详细信息，请参阅Oak文档中的检查点创建。

为生成的索引定义执行脱机索引

可以使用oak-run离线完成Lucene重新索引。 此进程在indexing-result/indexes下的磁盘中创建索引数据。 它​ 不 ​写入存储库，因此不需要停止正在运行的AEM实例。 创建的文本存储将馈送到此进程：

java -Doak.indexer.memLimitInMB=500 -jar oak-run.jar index <nodestore path> --reindex --doc-traversal-mode --checkpoint <checkpoint> --fds-path <datastore path> --index-definitions-file merge-index-definitions_target.json --pre-extracted-text-dir text-extraction/store

Sample <checkpoint> looks like r16c85700008-0-8
—fds-path: path to data store.
--pre-extracted-text-dir: Directory of pre-extracted text.
merge-index-definitions_target: JSON file having merged definitions for the target AEM instance. indexes in this file will be re-indexed.

在MongoMK安装中使用--doc-traversal-mode参数非常方便，因为它通过将存储库内容假脱机到本地平面文件来显着缩短重新索引时间。 但是，它需要两倍于存储库大小的额外磁盘空间。

如果存在MongoMK，则如果在更靠近MongoDB实例的实例中执行此步骤，则可以加快此进程。 如果在同一台计算机上运行，则可以避免网络开销。

有关索引🔗的Oak-run文档中可找到其他技术详细信息。

导入索引 importing-indexes

使用AEM 6.4及更高版本，AEM具有按启动顺序从磁盘导入索引的内置功能。 启动期间观察文件夹<repository>/indexing-result/indexes是否存在索引数据。 在开始新版本的​ target AEM jar之前，您可以在升级过程期间将预创建的索引复制到上述位置。 AEM会将其导入到存储库中，并从系统中删除相应的检查点。 因此，完全避免了重新索引。

其他提示和疑难解答 troubleshooting

在下方，您将找到一些有用的提示和故障排除说明。

减少对实时生产系统的影响 reduce-the-impact-on-the-live-production-system

建议克隆生产系统并使用克隆创建离线索引。 这消除了对生产系统的任何潜在影响。 但是，生产系统中需要存在导入索引所需的检查点。 因此，在获取克隆之前创建检查点至关重要。

准备Runbook并试运行 prepare-a-runbook-and-trial-run

建议先准备runbook并执行一些试验，然后再在生产环境中运行升级。

带脱机索引的文档遍历模式 doc-traversal-mode-with-offline-indexing

离线索引需要遍历整个存储库。 使用MongoMK安装时，通过网络访问存储库会影响索引过程的性能。 一种选择是在MongoDB副本本身上运行离线索引过程，这将消除网络开销。 另一个选项是使用文档遍历模式。

通过将命令行参数—doc-traversal添加到oak-run命令以离线编制索引，可以应用文档遍历模式。 此模式将本地磁盘中整个存储库的副本作为平面文件卷动，并使用它来运行索引。