Install the Sitecore XM scaled topology

Version: 10.5

Once you have obtained the required certificates, you can run SIF and install the Sitecore XM scaled topology. You can install any of the configurations for dedicated server roles, on single or multiple servers.

The server roles are defined as a part of your desired scaling configuration.

Important

You must first install the sitecore-solr.json deployment configuration on your Solr search server. Then you must install the rest of the Sitecore server roles deployment configurations.

Use SIF to install the Sitecore XM Scaled topology

To run SIF and install the Sitecore XM Scaled topology:

  1. If you have not already done so, as an administrator, in a PowerShell command line, run the following cmdlet:

    Import-Module SitecoreInstallFramework
  2. Download the OnPrem XM Scaled WDP archive and unzip to a folder of your choice.

  3. To install the Solr cores, run the following cmdlets with the required parameters for your server roles:

    Install-SitecoreConfiguration –Path "C:\SitecoreInstaller\Configurations\Platform\Solr\sitecore-solr.json"
  4. To install the server roles, run the following cmdlets with the required parameters for your server roles:

    
    Install-SitecoreConfiguration –Path "C:\SitecoreInstaller\Configurations\IdentityServer\IdentityServer.json"
    
    Install-SitecoreConfiguration –Path "C:\SitecoreInstaller\Configurations\Platform\XM1\sitecore-XM1-cm.json"
    
    Install-SitecoreConfiguration –Path "C:\SitecoreInstaller\Configurations\Platform\XM1\sitecore-XM1-cd.json"
    

Specify the certificates during installation

To install Sitecore with your pre-installed certificates, when you run the Install-SitecoreConfiguration cmdlet, you must provide the certificates as parameters.

SIF searches for the certificates in the following path, by default:

Cert:\Localmachine\My

You can change the storage location.

Change the default location of the certificates

To change the default location of the certificates used for the deployment:

  • In a text editor, open the relevant .json file, and in the Variables section, change the default store value:

    "Security.CertificateStore": "Cert:\\Localmachine\\My"

Specify the names or thumbprints of the certificates

You must specify the names or thumbprints of the certificates that you created and installed earlier in this guide as parameters.

  • For the SSL authentication certificate, for example, of an instance with the name "CM_test":

    -SSLCert "‎‎CM_test"

    or

    -SSLCert "‎‎2205A94867EE99E3B29EA7A9AC5A7646D43FD88B"
    Note

    In the PowerShell command line parameter, you must specify the client certificate thumbprint in capital letters.

Skip database deployment when you install a server role

When you install a server role, you do not have to install the databases when you deploy the WDP packages.

A new the SkipDatabaseInstallation parameter has been added to the following deployment configuration file:

  • sitecore-XM1-cm.json

The SkipDatabaseInstallation parameter is set to false by default and all the databases are installed when you deploy the WDP packages.

Note

The SkipDatabaseInstallation parameter is not supported by the SingleDeveloper or the other XM Scaled deployment configuration files.

To deploy a Sitecore server role without installing the databases:

  1. Ensure that you already have already installed the databases that you need for the server role.

  2. Ensure that the database names contain the prefixes that you are going to use for this deployment.

  3. In the Powershell deployment command, enter all the required parameters.

  4. In the c:\resourcefiles\Role-Remote.json file, ensure that the SIFVersion parameter matches the latest version of SIF.

  5. In the Powershell deployment command, enter following parameter in the corresponding config files:

    • SkipDatabaseInstallation: true
  6. Pass the database user names and passwords, for example:

    
    “SqlCoreUser” : “mycoreuser”
    
    “SqlCorePassword” : “mycorepassword”
    

Install to a custom website folder

Since Sitecore XP 10.0.0, you can specify the folder where the website is installed.

A new SitePhysicalRoot parameter has been added to the deployment configuration files for each server role.

When you set this parameter, the website is installed in the [SitePhysicalRoot]\[SiteName] folder.

If you leave this parameter with the default value, the website is installed in the default IIS wwwroot folder.

Note

This parameter is supported by the SingleDeveloper and the Distributed deployment configuration files and the SitePhysicalRoot path that you provide is created for every website.

If you have suggestions for improving this article, let us know!