Upgrade Identity Server

Upgrade the database

Upgrade the security database before you install the latest version of Sitecore Identity Server.

To upgrade the security database:

1. Unpack the Sitecore.IdentityServer.UpgradeScripts.9.0.zip file.
2. Run the CMS_security_IdentityServer.sql script on the security database.

The database upgrade script contains the changes applied to the security database. It modifies tables to support new versions of dependent software.

Configure Application Insights Connection String

Starting with Sitecore Identity Server 8.0, a Connection String needs to be entered when configuring Azure Application Insights. The use of Instrumentation Keys is no longer supported. Instrumentation Keys will be deprecated in a future Sitecore Identity Server version.

For further information, refer to Sitecore KB article: Application Insights – end of support for Instrumentation Key Ingestion.

To obtain the Application Insights Connection String, you can copy the value from your Application Insights resource overview page. You will need this value while upgrading Sitecore Identity Server 9 with ARM Templates, as described in the next section.

Upgrade Identity Server with ARM Templates

To upgrade Sitecore Identity Server:

1. Upload the following files to your Azure Storage Account:

   • Sitecore.IdentityServer.9.0.X.scwdp.zip. You will need the URL to this blob for parameter siMsDeployPackageUrl in the table below.
   • azuredeploy.json. You will need the URL to this blob in the PowerShell script.

2. Update the parameter values in the azuredeploy.parameters.json file, as described here:

   • sqlServer - The name of Azure SQL server.
   • sqlDatabasePrefix - The prefix name of the SQL databases.
   • securitySqlDatabaseUserName - The user name used in Security database connection string.
   • securitySqlDatabasePassword - The SQL password for the Security database connection string.
   • cmInstanceUrl - The HTTP(s) URL to a Sitecore Content Management Web App.
   • siApplicationSuffixName - The suffix name of the Sitecore Identity Server Web App and Sitecore Identity Server App Service plan.
   • siClientSecret - The client secret to a Sitecore Identity Server, which is the same value as for the ...\App_Config\ConnectionStrings.config file, in the sitecoreidentity.secret connection string, on the Sitecore Content Management instance.
   • siMsDeployPackageUrl - The HTTP(s) URL to a Sitecore Identity Server Web Deploy package.
   • applicationInsightsConnectionString - Optional. The connection string to the Application Insights application.
   • certificateThumbprint - The thumbprint to an existing authentication certificate.
   • templateLinkAccessToken - Optional. An access token for the storage account, if the storage is not set to public. If public, then there is no need to pass this parameter. For example, ?st=2019-03-185Z&se=2019-03-220Z&sp=rl&sv=2018-03-28&sr=c&sg=4cM%3D or " "

   The deploymentId and licenseXml parameters are filled in by the PowerShell script.

   If the siApplicationSuffixName parameter matches the suffix name of the existing Sitecore Identity Server web app or Sitecore Identity Server app service plan, then resources will be overwritten with the provided suffix name. By default, the Sitecore environment PaaS deployment uses si as suffix.

3. If you are overwriting the existing Sitecore Identity Server web app, stop the Identity Server App service.

4. Execute the PowerShell script described in the README.md file from GitHub – Sitecore Azure Quickstart Templates.

5. If you are deploying a dedicated Identity Server web app, then update the: ...\App_Config\Sitecore\Owin.Authentication.IdentityServer\Sitecore.Owin.Authentication.IdentityServer.config file in your Sitecore Content Management (CM) instance.

   Set identityServerAuthority to the URL of the new Sitecore Identity Server.

6. Restart the Sitecore instance to apply changes.

You should now be able to log in to the CM server and log out without any errors displayed.