DocumentationAEM 6.4Deploying Guide

Storage Elements in AEM 6.4 storage-elements-in-aem

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

In this article, we will cover:

Overview of Storage in AEM 6 overview-of-storage-in-aem

One of the most important changes in AEM 6 are the innovations at the repository level.

Currently, there are two node storage implementations available in AEM6: Tar storage, and MongoDB storage.

Tar Storage tar-storage

Running a freshly installed AEM instance with Tar Storage running-a-freshly-installed-aem-instance-with-tar-storage

CAUTION
The PID for the Segment node store has changed from org.apache.jackrabbit.oak.plugins.segment.SegmentNodeStoreService in previous versions of AEM 6 to org.apache.jackrabbit.oak.segment.SegmentNodeStoreService in AEM 6.3. Make sure you make the necessary configuration adjustments to reflect this change.

By default, AEM 6 uses the Tar storage to store nodes and binaries, using the default configuration options. To manually configured its storage settings, follow the below procedure:

  1. Download the AEM 6 quickstart jar and place it in a new folder.

  2. Unpack AEM by running:

    java -jar cq-quickstart-6.jar -unpack

  3. Create a folder named crx-quickstart\install in the installation directory.

  4. Create a file called org.apache.jackrabbit.oak.segment.SegmentNodeStoreService.cfg in the newly created folder.

  5. Edit the file and set the configuration options. The following options are available for Segment Node Store, which is the basis of AEM’s Tar storage implementation:

    • repository.home: Path to repository home under which various repository related data is stored. By default segment files would be stored under the crx-quickstart/segmentstore directory.
    • tarmk.size: Maximum size of a segment in MB. The default is 256MB.

  6. Start AEM.

Mongo Storage mongo-storage

Running a freshly installed AEM instance with Mongo Storage running-a-freshly-installed-aem-instance-with-mongo-storage

AEM 6 can be configured to run with MongoDB storage by following the below procedure:

  1. Download the AEM 6 quickstart jar and place it into a new folder.

  2. Unpack AEM by running the following command:

    java -jar cq-quickstart-6.jar -unpack

  3. Make sure that MongoDB is installed and an instance of mongod is running. For more info, see Installing MongoDB.

  4. Create a folder named crx-quickstart\install in the installation directory.

  5. Configure the node store by creating a configuration file with the name of the configuration you want to use in the crx-quickstart\install directory.

    The Document Node Store (which is the basis for AEM’s MongoDB storage implementation) uses a file called org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreService.cfg

  6. Edit the file and set your configuration options. The following options are available:

    • mongouri: The MongoURI required to connect to Mongo Database. The default is mongodb://localhost:27017
    • db: Name of the Mongo database. By default new AEM 6 installations use aem-author as the database name.
    • cache: The cache size in MB. This is distributed among various caches used in DocumentNodeStore. The default is 256.
    • changesSize: Size in MB of capped collection used in Mongo for caching the diff output. The default is 256.
    • customBlobStore: Boolean value indicating that a custom data store will be used. The default is false.

  7. Create a configuration file with the PID of the data store you wish to use and edit the file in order to set the configuration options. For more info, please see Configuring Node Stores and Data Stores.

  8. Start the AEM 6 jar with a MongoDB storage backend by running:

    code language-shell 
    java -jar cq-quickstart-6.jar -r crx3,crx3mongo

    Where -r is the backend runmode. In this example, it will start with MongoDB support.

Disabling Transparent Huge Pages disabling-transparent-huge-pages

Red Hat Linux uses a memory management algorithm called Transparent Huge Pages (THP). While AEM performs fine-grained reads and writes, THP is optimized for large operations. Because of this, it is recommended that you disable THP both on Tar and Mongo storage. To disable the algorithm, follow these steps:

  1. Open the /etc/grub.conf file in the text editor of your choice.

  2. Add the following line to the grub.conf file:

    code language-none 
    transparent_hugepage=never

  3. Finally, check if the setting has taken effect by running:

    code language-none 
    cat /sys/kernel/mm/redhat_transparent_hugepage/enabled

    If THP is disabled, the output of the above command should be:

    code language-none 
    always madvise [never]
NOTE
Addtionally, you can also consult the following resources:
  • For more information regarding Transparent Huge Pages on Red Hat Linux, see this article.
  • For Linux tuning tips, see this article.

Maintaining the Repository maintaining-the-repository

Each update to the repository creates a new content revision. As a result, with each update the size of the repository grows. To avoid uncontrolled repository growth, old revisions need to be be cleaned up to free disk resources. This maintenance functionality is called Revision Cleanup. The Revision Cleanup mechanism will reclaim disk space by removing obsolete data from the repository. For further details about Revision Cleanup, read the Revision Cleanup page.

recommendation-more-help
6a71a83d-c2e0-4ce7-a6aa-899aa3885b56