Document Properties
Last Modified
Added to KB
Public Access
Doc Type
Guidelines, Concepts & Cookbooks
  • ICM 7.10
  • Intershop SaaS

Guide - CaaS - Migration Solr4 to SolrCloud Adapter

Table of Contents

Product Version


Product To Version



1 Introduction

This guide describes the steps to follow for migrating from Solr4 to SolrCloud in the CaaS context. It is written for developers.

1.1 Glossary

OPSIntershop Operations
DEVDeveloper, implementation partner
Software part
ICMIntershop Commerce Management

Apache Solr

INTIntegration environment
PRDProduction environment
UATUser acceptance test environment, also known as Preproduction environment

1.2 Reference

2  Technical Steps

2.1  Prerequisites

Intershop recommends to follow the keep current strategy, meaning that it is advisable to use the highest possible version for all components.

Depending on the Search Service Adapter version, a different ICM version is required, as can be seen in the validity of the following Public Release Notes:

For Search Service Adapter version 2 the following compatibility matrix applies:

ICMSolrCloud Search Service AdapterSolr Server
7.10.10+ to 8.6.2
7.10.23+ to 8.7.0

For more details, see: Overview - Search Service Adapters and Public Release Note - SolrCloud Search Service Adapter 2.

Older versions of SolrCloud Search Service Adapter than those listed here should not be selected for the migration.

2.2 Procedure

In the present configuration, INT and UAT share the same SOLR cloud server, it means that the migration from SOLR4 to SOLR cloud should be performed on INT and UAT at the same moment.

The following steps are to be performed for the INT and UAT environment for testing purposes first. Once INT and UAT have been migrated and tested, the steps are to be repeated for PRD.

To give a rough orientation regarding the timeframe to be planned for the migration, a duration is added to the steps which will take longer.

1Ask OPS to schedule the deployment of the SolrCloud Server(s), and agree a common timeline.DEV

As a prerequisite for the subsequent step, OPS needs to:

a. Ensure that DEV is able to export a database dump from the Production Edit environment.

b. Check that DEV workers have the required accesses to the project code repository in case they use Intershop preconfigured CI/CD solution.


Determine and migrate any custom changes (optional).

a. Set up a local environment that includes Solr 8.

b. Test the code with SolrCloud and proceed with the adaptions.


This step is surely the most complex and difficult to plan, as it is related to customization. This step should be performed by DEV on a local environment where a Solr 8 server is set up.

To install Solr locally, please follow the official documentation from A container can also be used.

We advise to read the documentation, starting with Guide - Migration Solr4 to Solr Cloud Adapter. In case of difficulties, please open a service desk ticket.



2 weeks


Deploy SolrCloud Server(s). See Guide - Deployment Solr Cloud Server.


Ideally steps 3 and 4 are coordinated in such a way that they are completed at the same time so that the infrastructure is available when DEV finished their code changes and tests.

OPS3-4 days

Change ICM deployment and configuration according to Cookbook - Deployment of Solr Search Adapters (Recipe: Use Solr Cloud Adapter). In other words, SolrCloud cartridges should be added to the assembly.

DEV1 day
6Deploy the changes.OPS1 day
7Change configuration of application servers to point to SolrCloud server. OPS1 day

Rebuild search indexes to re-create indexes at the SolrCloud server, see Job - Rebuild Search Indexes.

DEV1 day
9Delete old Solr4 indexes (data directory) and Solr4 configuration (conf directory) from the shared file system.DEV


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