Document Tree
Document Properties
Kbid
31N174
Last Modified
22-Apr-2024
Added to KB
15-Apr-2024
Public Access
Everyone
Status
Online
Doc Type
Release Notes
Product
  • ICM 11
  • Solr
  • ICM 12
Public Release Note - SolrCloud Search Service Adapter 4

Introduction

The SolrCloud Search Service Adapter connects the Intershop Commerce Management (ICM) with a Solr server that runs in cloud mode. The search index configuration and maintenance in the ICM back office uses the Schema- and ConfigSet-REST-APIs provided by Solr. Thus, the Solr server is separate and independent of the ICM application server cluster.

References

Version Information and Dependencies

Intershop Commerce Management

SolrCloud Search Service Adapter

Solr Server

11.0+

4.7.1

8.11

Please see Reference - ICM 11 Release Versions for versions that are released and tested together.

Delivery

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

Cartridge

Description

Required

ac_solr_cloud

The main implementation cartridge of the adapter defining and registering the search service.

(tick)

ac_solr_cloud_bo

Additional functionality for the Commerce Management application. It provides additional configuration options for the index management, especially for suggest and spell-check.

Setup

  1. Follow the basic setup of ICM 11 customization described in Concept - Customization ICM 11 - Deployment to add the customization cartridges to ICM and to the cartridge list.

  2. Add the ft_solr_cloud feature to the cartridge list:

      environment:
        CARTRIDGE_LIST: "ft_demo_search ft_headless ft_solr_cloud"
  3. Add the Solr adapter to the customizations section of the helm chart:

    ...
    customizations:
        solrcloud:
          repository: intershophub/icm-as-customization-f_solrcloud:4.7.0
    ....
    

The following environment variables show the setup of the most common options:

  environment:
    SOLR_CLOUDSOLRSERVERURLS: "https://slr-test-slr-test-solrcloud.test.intershop.com/solr"
    SOLR_CLUSTERINDEXPREFIX: "cstmr-int-ed"
    SOLR_COLLECTIONREPLICATIONFACTOR: 2
    SOLR_CLOUDBACKUPLOCATION: "/var/solr/data/backup-restore/local-collection-backups-1"   
    SOLR_BASICAUTH: "solr:SolrIsAwesome!"

The environment variables in detail (from top to bottom):

  • With SolrCloud Adapter 4 it is required to configure a common Solr service URL with SOLR_CLOUDSOLRSERVERURLS instead of a connection to a list of zookeeper hosts. (required)

  • The cluster index prefix is required to distinguish the indexes from multiple ICM systems, e.g., if data replication is used. (optional on development environment)

  • The recommendation for the replication factor is 2 to have redundancy of indexes on two nodes. This way, there is always an index online even if the Solr cluster is re-started with a rolling restart. (Set to 1 if there is only a single Solr, e.g., in development environments.)

  • A backup location is needed if data replication for search indexes is used.

  • In general, basic authentication is used for the connection from ICM to the Solr server. To set the user/password for the basic authentication, add it to the environment.

The basic authentication user and password string can also be used from a generic secret instead of adding it as plain text in the environment:

  secrets:
    - env: SOLR_BASICAUTH
      name: icm-secrets
      key: solr_basicauth
 

The adapter comes with an initial Solr configset configuration that is prepared into sites/root/1/solrcloud. If the customization is added after database initialization, it is important to execute the initialization for the ac_solr_cloud to make this configuration available.

Configuration

  1. Enable the managed services in Operations, see Intershop Organization Management Help | Managing Services.

  2. Create search services in the organization and channels, see Intershop Commerce Management Help | Managing Search Index Services.

  3. Create and Manage Search Indexes, see InterShop Commerce Management Help | Managing Search Indexes.

Feature Overview

The Solrcloud Search Service Adapter 4 connects the Intershop Commerce Management (ICM) Platform with Apache Solr to provide integrated search and navigation capabilities based on ICM's managed search service integration framework. The adapter provides the full backend feature-set as known from ICM 7.10 Search and Navigation. However, some of the features (display of spell-checking results, search redirects, object suggest search) are not integrated out of the box into the ICM 11 standard storefront (PWA) anymore.

Changelog

Release 4.7.1

Bugfixes

ID

Title

94700

No update of ish-config.xml after search index config changes

Release 4.7.0

Features

ID

Title

90316

Support multiple value attributes in object suggest search indexing

Bugfixes

ID

Title

92323

SolrAdapter ConcurrentModificationException in "BackupAndRestoreSolrCloudIndexesDecorator" during staging

91139

Object suggest index build - offline content index causes NullPointerException

90245

SKU is not usable as separate entry in object suggest type search

Release 4.6.0

Features

ID

Title

88736

Add property to change Solr client to use HTTP/1.1 or HTTP/2

Release 4.5.0

Features

ID

Title

85890

Improve DELETE request handling

Release 4.4.0

Features

ID

Title

87503

Parallelize restore & backup of search indexes during replication

86951

Rebuild inconsistent search indexes during replication

Bugfixes

ID

Title

88378

Automatic search index update after product deletion via back office is not reflected in search index list

87853

Restore collection fails with server exception

87729

Concurrent upload of default config set fails with "configuration already exists in zookeeper"

87520

Replication fails on BackupAndRestoreSolrCloudIndexesDecorator.onPostReplicationHook due to Solr Cloud OverseerCollectionMessageHandler.waitForCoreNodeName method exception

Release 4.3.0

Release for referencing updated icm-as/11.3.x

Release 4.2.0

Bugfixes

ID

Title

86162

Wrong collection alias set when entry in aliases is missing before replication but a collection exists

86068

Collection named like the alias is not deleted

85538

Solr Cloud adapter code throws "Closing JDBC connection via finalize method" exception

85186

ac_solr_cloud cannot reference intershop.EnterpriseBackoffice.Cartridges

Release 4.1.3

Initial version that was re-synced from the Solr Adapter Version 3.4.0

Disclaimer
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.