Install a search provider in a scaled solution

Prerequisites

Before you deploy the ConfigSets to SolrCloud, you must:

• Download the Solr 10.0 for Windows installation archive and save it locally, for example, C:\solr.

  You use this file to access the solr.cmd.zookeeper command line interface. If you have already installed the required version of Solr you can skip this step.

  To use SolrCloud, you do not need to install Solr as a local service.

• Install SolrCloud 10.0.

• Locate the Sitecore 10.X.X rev. XXXXXX (WDP XM1 packages).zip package and in the XM1 Configuration files 10.X.X rev. XXXXXX.zip file extract the following configuration files:

  • SolrCloud-SitecoreConfigSets.json

Install the SolrCloud

To deploy SolrCloud:

1. In a Powershell command line, go to the folder where you saved the installation configuration files and run the following cmdlet with the appropriate parameters:

   Install-SitecoreConfiguration `
      -Path .\Solr-SingleDeveloper.json `
      -SolrInstallRoot <path to solr binaries, default C:\> `
      -SolrDomain <Solr domain name, default: localhost> `
      -SolrPort <Solr port, default: 8983> `
      -SolrAdminUserName <username for solr admin, default: admin> `
      -SolrAdminPassword <password for solr admin, optional. Random password is generated if left empty> `
      -SolrCloud true

Install the Sitecore content ConfigSets

To deploy the Sitecore content ConfigSets to SolrCloud:

1. In a PowerShell command line, go to the folder where you saved the installation configuration files and run the following cmdlet with the appropriate parameters:

   Install-SitecoreConfiguration `
      -Path .\SolrCloud-SitecoreConfigSets.json `
      -SolrInstallRoot <path to solr binaries from step 1, default: c:\> `
      -SolrDomain <zookeeper domain name, default: localhost> `
      -ZookeeperPort <zookeeper port, default: 9983>  `
      -CorePrefix <prefix for configSet names, default: sitecore> `
      -DefaultConfigSetName <config set to use as base, default: _default>

2. Verify that the ConfigSets are deployed to Zookeeper.

Deploy the SolrCloud content collections

To deploy the SolrCloud content collections:

1. In a PowerShell command line, go to the folder where you saved the installation configuration files and run the following cmdlet with the appropriate parameters:

   Install-SitecoreConfiguration `
      -Path .\SolrCloud-Sitecore-Collections.json `
      -SolrDomain <solrcloud domain name, default: localhost> `
      -SolrPort <solrcloud port, default: 8983> `
      -SolrAdminUserName <admin’s username, default: admin> `    
      -SolrAdminPassword <admin’s password, required to be provided, can be taken from installation above> `
      -SolrConnectionUserName <user name used in connection string, default to corePrefix if not provided> `  
      -SolrConnectionPassword <user password used in connection string, default to random generated password if not provided> `   
      -CorePrefix <prefix for collection name, default: sitecore> `
      -NumShards <number of shards for the collection, default: 1> `
      -ReplicationFactor <number of replicas for each shard, default: 1> `
      -AutoCreateFields <automatically add new fields to schema, default: false>

   Note

   SolrConnectionUserName and SolrConnectionPassword should be noted to be used in subsequent role’s deployment.

2. Verify that the following CMS collections are deployed to SolrCloud:

   • <prefix>_core_index
   • <prefix>_master_index
   • <prefix>_web_index
   • <prefix>_marketingdefinitions_master
   • <prefix>_marketingdefinitions_web
   • <prefix>_marketing_asset_index_master
   • <prefix>_marketing_asset_index_web
   • <prefix>_testing_index
   • <prefix>_suggested_test_index
   • <prefix>_fxm_master_index
   • <prefix>_fxm_web_index
   • <prefix>_personalization_index

Deploy Sitecore with SolrCloud

After you have configured SolrCloud, before you install Sitecore XP, you must ensure that the SolrCloud parameter is configured correctly in the connection string.

To install the Sitecore platform with a connection to the newly configured SolrCloud instance, in the SIF deployment script, in the SolrUrl parameter, add the ;solrCloud=true setting.

If you are going to deploy the server roles separately, update the SolrUrl parameter in following deployment configuration files:

• sitecore-XM1-cd.json
• sitecore-XM1-cm.json