Introduction
This guide is aimed at developers and describes the steps to migrate from Solr4 to SolrCloud in the Intershop Commerce Platform context.
Glossary
Abbreviation | Description |
|---|---|
OPS | Intershop Operations |
DEV | Developer, implementation partner |
Software part | |
ICM | Intershop Commerce Management |
Solr | Apache Solr |
Environments | |
INT | Integration environment |
PRD | Production environment |
UAT | User acceptance test environment, also known as preproduction environment |
References
Technical Steps
Prerequisites
Intershop recommends following the "keep-current" strategy, meaning that it is advisable to use the highest possible version for all components (ICM and Solr Adapter).
It is important to chose the right Solr Adapter for your ICM version. Please see the compatibility matrix here: Search Service Adapters - Compatibility.
Please also be aware of the older Solr Adapters "expiration date". See more details here: Announcement - Approaching End of Support for Old Solr Adapters.
Procedure
In the present configuration, INT and UAT share the same SolrCloud server, therefore the migration from Solr4 to SolrCloud should be performed on INT and UAT at the same time.
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, repeat these steps 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.
Step | Responsible | Duration | |
|---|---|---|---|
| 1 | Ask OPS to schedule the deployment of the SolrCloud server(s) and agree on a common timeline. The migration will probably be on PRD side development path. | DEV | |
| 2 | 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 access to the project code repository in case they use Intershop preconfigured CI/CD solution. | OPS | |
| 3 | 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 https://solr.apache.org/. A container can also be used. We advise to read the documentation, starting with Guide - Migration Solr4 to SolrCloud Adapter. In case of difficulties, please open a service desk ticket. | DEV | about 2 weeks |
| 4 | Deploy SolrCloud Server(s). See Guide - Deployment SolrCloud 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 finishes their code changes and tests. | OPS | 3-4 days |
| 5 | Change ICM deployment and configuration according to Cookbook - Deployment of Solr Search Adapters (Recipe: Use SolrCloud Adapter). In other words, SolrCloud cartridges should be added to the assembly. | DEV | 1 day |
| 6 | Change configuration of application servers to point to SolrCloud server. | OPS | 1 day |
| 7 | Deploy the changes. | DEV | 1 day |
| 8 | Rebuild search indexes to re-create indexes on the SolrCloud server, see Job - Rebuild Search Indexes. | DEV | 1 day |
| 9 | Delete old Solr4 indexes (data directory) and Solr4 configuration (conf directory) from the shared file system. | DEV |