Public Release Note - SolrCloud Search Service Adapter 2


1 Introduction

The SolrCloud Search Service Adapter connects the Intershop Commerce Management (ICM) with a Solr server that runs in cloud mode. It replaces the Solr search service adapter delivered with the ICM release and uses a more recent version of Solr and its features. The search index configuration and maintenance in Intershop Commerce Management is almost the same but uses the Schema API and Configsets API provided by the newer Solr server version. Thus, the Solr Server is separated and independent of the ICM application server cluster.

1.1 References

1.2 Version Information and Dependencies

Intershop Commerce ManagementSolrCloud Search Service AdapterSolr Server
7.10.10+2.0.3 -
7.10.10+ to 8.6.2
7.10.23+ - - to 8.7.0

Solr 8.8.* does not work with the adapter yet. There is an issue with the configuration Set Backup/Restore that prevents a successful replication of configuration changes. In 8.8.0 there is a backward compatibility issue with SolrJ, see SOLR-15145. Solr 8.6.3/Solr 8.7 requires additional configuration, see ISSEA-167 - Can't Create a Configset - Solr Cloud 8.6.3 8.7.

Listed Solr server versions were tested to work with the listed SolrCloud Adapter version. In general, minor and patch version upgrades of the Solr server are usually compatible with the adapter.

The following table lists the cartridges contained in the SolrCloud Adapter:

ac_solr_cloudThe main implementation cartridge of the adapter defining and registering the search service.(tick)
ac_solr_cloud_boAdditional functionality for the Commerce Management application. It provides additional configuration options for the index management, especially for suggest and spell-check.(tick)
solrcloud_configAdditional configuration to be deployed to share.(tick)

2 Deployment

The cartridges need to be deployed as a replacement of the Solr cartridges delivered by default (ac_search_solr, ac_search_solr_bo). These are part of the ICM component set f_business or (better to say) intershop7 assembly. Starting with ICM version, the Responsive Starter Store is preconfigured to use the SolrCloud Search Service Adapter by default. Please see the Cookbook - Deployment of Solr Search Adapters on how to setup your project using ICM and higher. For previous ICM versions please follow the Recipe - Setup Project Using Solr Cloud. The deployment of the SolrCloud Adapter 2.0.0 requires additional deployment of solrcloud_config. Add the 'com.intershop.solrcloud:solrcloud_config' line to the includes of the share host type.

The SolrCloud Search Service Adapter requires a Solr server that runs in cloud mode. Please see the Guide - Deployment Solr Cloud Server on how to setup a Solr server for development or production. This guide also provides information on how to configure ICM to use a Solr server.

3 Data Replication

The data replication of indexes has changed with this adapter implementation. The standard ICM file replication is not used anymore to replicate the index data. Instead, the adapter comes with its own replication decorator that uses the backup/restore collection API functionality of Solr. Please see Guide - Solr Replication for the description and configuration of the index replication with the SolrCloud server.


Data replication with a Solr Cloud cluster requires to mount a shared file system at the same path on each Solr node. The ICM must configure the property solr.cloudBackupLocation to point to this shared location.

4 Changelog

4.1 Release 2.3.5

4.1.1 Bugfixes


AlreadyClosedException during Search Index Build

4.2 Release 2.3.4

4.2.1 Bugfixes

4.3 Release 2.3.3

4.3.1 Bugfixes

4.4 Release 2.3.2

4.4.1 Bugfixes

4.5 Release 2.3.1

4.5.1 Improvements

4.5.2 Bugfixes

4.6 Release 2.3.0

4.6.1 Updated Intershop Commerce Management Base Version

The base ICM version of the adapter is now The adapter is built and tested with this version. Thus it is recommended to update ICM or higher to use this adapter.

4.6.2 Custom Code Migration

With reworking the SolrCloudClient caching to use a single client object, the following changes were required. Custom code based on these classes must be changed:

  • com.intershop.adapter.search_solr.server.SolrServerProvider
    Removed methods: get(SolrIndex index) and get(Domain domain, String indexName, String node) Always use the added method get() instead.
  • com.intershop.adapter.search_solr.server.Server was moved to com.intershop.adapter.search_solr.server.SolrServer
  • Methods that send requests to the Solr server that require a collection name do have an additional string parameter. The collection name is to be retrieved with SolrCollectionAdmin.getCollectionName(domainName, indexID).
  • Instead of:

    Old Code
    	QueryResponse queryResponse = provider.get(idx).query(solrQuery, METHOD.POST);


    New Code
    	String collectionName = SolrCollectionAdmin.getCollectionName(idx.getDomain().getDomainName(), idx.getIndexID());	
    	QueryResponse queryResponse = provider.get().query(collectionName, solrQuery, METHOD.POST);

The BackupAndRestoreSolrCloudIndexesDecorator was changed:

  • The deprecated method com.intershop.adapter.search_solr.server.staging.BackupAndRestoreSolrCloudIndexesDecorator#readAndInstantiateSearchIndexesOfSite(Domain site) is removed.

  • The BackupAndRestoreSolrCloudIndexesDecorator keeps track of the backed up edit system indexes now. Indexes that are deleted in the edit system are not available in the backup anymore and will be deleted in the live system as well. In addition, the restored collections are now checked to contain the document count of the backup. The respective methods for restoring the index in the decorator and in the com.intershop.adapter.search_solr.server.impl.SolrCollectionAdmin do have an additional parameter expectedNumFound and old restore methods are deprecated now. (ISSEA-155 - Data Replication Fails Trying to Restore Live Index Deleted on Edit)

4.6.3 Improvements

4.6.4 Bug Fixes

4.7 Release 2.2.1

4.7.1 Bug Fixes

4.8 Release 2.2.0

4.8.1 Solr Server 8.6

The Solr Server version 8.6.0 in conjunction with data replication requires to set the backup location as an allowed path for the Solr server cluster. You can specify the allowed paths by setting a system property via environment in the startup script:
SOLR_OPTS="$SOLR_OPTS -Dsolr.allowPaths=/mnt/solr_backup"

Please see also the respective Solr Upgrade Notes.

4.8.2 Improvements

4.8.3 Bug Fixes

4.9 Release 2.1.2

4.9.1 Bug Fixes

4.10 Release 2.1.1

4.10.1 Bug Fixes

4.11 Release 2.1.0

4.11.1 Improvements

4.11.2 Bug Fixes

4.12 Release 2.0.3

4.12.1 Bug Fixes

4.13 Release 2.0.2

4.13.1 Improvements

4.13.2 Bug Fixes

4.14 Release 2.0.0

4.14.1 Improvements

4.14.2 Bug Fixes


The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources