Oak-run supports all indexing use cases on the command line without having to operate from the JMX level. Advantages of the oak-run approach are:
Below is a list of use cases that can be used when performing indexing operations by way of the oak-run
tool.
For more detailed information regarding this scenario, see Use Case 1 - Index Consistency Check.
oak-run.jar
quickly determines if Lucene Oak indexes are corrupt.For more detailed information regarding this scenario, see Use Case 2 - Index Statistics
oak-run.jar
dumps all index definitions, important index stats, and index contents for offline analysis.This diagram is a decision tree for when to use the various reindexing approaches.
For more detailed information regarding this scenario, see Use Case 3 - Reindexing.
Text pre-extraction (a feature that has existed with AEM 6.3) can be used to reduce the time to reindex. Text pre-extraction can be used with all reindexing approaches.
Depending on the oak-run.jar
indexing approach, there are various steps on either side of the Perform Reindex step in the diagram below.
Orange denotes activities where AEM must be in a maintenance window.
For more detailed information regarding this scenario, see Reindex - DocumentNodeStore.
This is the recommended method for reindexing MongoMK (and RDBMK) AEM installations. No other method should be used.
Run this process only against a single AEM instance in the cluster.
For more detailed information regarding this scenario, see Reindex - SegmentNodeStore.
Cold Standby considerations (TarMK)
AEM Publish Farms (AE Publish Farms should always be TarMK)
For more detailed information regarding this scenario, see Online Reindex - SegmentNodeStore.
This is the method used before the introduction of the new indexing capabilities of oak-run.jar. It is done by setting the reindex=true
property on the Oak index.
This approach can be used if the time and performance effects to index are acceptable to the customer. This is often the case for small to medium-sized AEM installations.
For more detailed information regarding this scenario, see Online Reindex - SegmentNodeStore - The AEM Instance is Running.
Online reindexing of TarMK using the oak-run.jar is faster than the Online Re-Indexing for TarMK described above. However, it also requires execution during a maintenance window; with the mention that the window is shorter, and more steps are required to perform the reindexing.
Orange denotes operations where AEM must be performed in a maintenance period.
For more detailed information regarding this scenario, see Online Reindex - SegmentNodeStore - The AEM Instance is Shut Down.
Offline reindexing of TarMK is the simplest oak-run.jar
based reindexing approach for TarMK as it requires a single oak-run.jar
comment. However, it requires the AEM instance to be shut down.
Red denotes operations where AEM must be shut down.
For more detailed information regarding this scenario, see Out of Band Reindex - SegmentNodeStore.
Out-of-band reindexing minimizes the impact of reindexing on in-use AEM instances.
Red denotes operations where AEM may be shut down.
For more detailed information about this scenario, see Use Case 4 - Updating Index Definitions.
ACS Ensure Index is a community-supported project, and is not supported by Adobe Support.
This allows shipping index definition by way of the content package which later results in reindexing by way of the setting the reindex flag to true
. This works for smaller setups where reindexing does not take a long time.
For more info, see the ACS Ensure Index documentation for details.
If the time or performance impact of reindexing using non-oak-run.jar
methods is too high, the following oak-run.jar
based approach can be used to import and reindex Lucene Index definitions in a TarMK based AEM installation.
If the time or performance impact of reindexing using non-oak-run.jar
methods is too high, the following oak-run.jar
based approach can be used to import and reindex Lucene Index definitions in MongoMK based AEM installations.