- Deploying User Guide
- Introduction to the AEM Platform
- Deploying AEM
- Deploying and Maintaining
- Recommended Deployments
- Application Server Install
- Custom Standalone Install
- Command Line Start and Stop
- Configuring node stores and data stores in AEM 6
- Revision Cleanup
- Oak Queries and Indexing
- How to Run AEM with TarMK Cold Standby
- RDBMS Support in AEM 6.5
- Indexing via the Oak-run Jar
- Oak-run.jar Indexing Use Cases
- Troubleshooting Oak Indexes
- Opting Into Aggregated Usage Statistics Collection
- Troubleshooting
- Configuring AEM
- Basic Configuration Concepts
- Logging
- Configuring OSGi
- OSGi Configuration Settings
- Run Modes
- Web Console
- Replication
- Replicating Using Mutual SSL
- Troubleshooting Replication
- Expiration of Static Objects
- Version Purging
- Monitoring and Maintaining Your AEM instance
- Offloading Jobs
- Single Sign On
- Resource Mapping
- Enabling HTTP Over SSL
- Consistency and Traversal Checks
- Performance Guidelines
- Performance Optimization
- Assets Performance Guide
- Configuration How-To Articles
- Configuring Web Console
- Upgrading to AEM 6.5
- Upgrading to AEM 6.5
- Planning Your Upgrade
- Assessing the Upgrade Complexity with the Pattern Detector
- Backward Compatibility in AEM 6.5
- Upgrade Procedure
- Performing an In-Place Upgrade
- Using Offline Reindexing To Reduce Downtime During an Upgrade
- Lazy Content Migration
- Using the CRX2Oak Migration Tool
- Pre-Upgrade Maintenance Tasks
- Post Upgrade Checks and Troubleshooting
- Upgrading Custom Search Forms
- Sustainable Upgrades
- Upgrading Code and Customizations
- Upgrade Steps for Application Server Installations
- List of Obsolete Bundles Uninstalled After the Upgrade
- Repository Restructuring
- Repository Restructuring in AEM 6.5
- Common Repository Restructuring in AEM 6.5
- Sites Repository Restructuring in AEM 6.5
- Assets Repository Restructuring in AEM 6.5
- Dynamic Media Repository Restructuring in AEM 6.5
- Forms Repository Restructuring in AEM 6.5
- E-Commerce Repository Restructuring in AEM 6.5
- Repository Restructuring for AEM Communities in 6.5
- Best Practices
Indexing by way of the Oak-run Jar
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:
- It is a new indexing toolset for AEM 6.4
- It decreases time-to-re-index which beneficially impacts reindex times on larger repositories
- It is reducing resource consumption during reindexing in AEM which results in better system performance for other AEM activities
- Oak-run provides Out-of-band support: If production conditions do not let you run reindex on production instances, a cloned environment can be used for reindexing to avoid critical performance impact.
Below is a list of use cases that can be used when performing indexing operations by way of the oak-run tool.
Index Consistency Checks
For more detailed information regarding this scenario, see Use Case 1 - Index Consistency Check.
oak-run.jarquickly determines if Lucene Oak indexes are corrupt.- It is safe to run on an in-use AEM instance for consistency check levels 1 and 2.
Index Statistics
For more detailed information regarding this scenario, see Use Case 2 - Index Statistics
oak-run.jardumps all index definitions, important index stats, and index contents for offline analysis.- Safe to execute on an in-use AEM instance.
Reindexing Approach Decision Tree
This diagram is a decision tree for when to use the various reindexing approaches.
Reindexing MongoMK / RDMBMK
For more detailed information regarding this scenario, see Use Case 3 - Reindexing.
Text Pre-extraction for SegmentNodeStore and DocumentNodeStore
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.
Online reindexing for MongoMK or RDBMK using oak-run.jar
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.
Reindexing TarMK
For more detailed information regarding this scenario, see Reindex - SegmentNodeStore.
-
Cold Standby considerations (TarMK)
- There are no special considerations for Cold Standby; the Cold Standby instances sync changes as usual.
-
AEM Publish Farms (AE Publish Farms should always be TarMK)
- For publish farm, it must be done for all OR execute the steps on a single publish. Then, clone the setup for others (taking all the usual precations when cloning AEM instances; sling.id - should link to something here).
Online Re-Indexing for 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.
Online Re-Indexing TarMK using oak-run.jar
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.
Offline Re-Indexing TarMK using oak-run.jar
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.
Out-of-band Re-Indexing TarMK using oak-run.jar
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.
Updating Indexing Definitions
For more detailed information about this scenario, see Use Case 4 - Updating Index Definitions.
Creating and Updating index definitions on TarMK using ACS Ensure Index
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.
Creating and Updating index definitions on TarMK using oak-run.jar
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.
Creating and Updating Index Definitions on MonogMK using oak-run.jar
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.
Resources
Adobe Account
