Walkthrough: Upgrading SCCH 4.0 to 5.0 on Docker
This section explains how to upgrade Sitecore Connect for Content Hub (SCCH) to version 5.0 on a container platform.
Before you perform the upgrade for SCCH container to version 5.0, you must have the following:
-
Sitecore Experience Platform (SXP) 10.1 deployed on Docker
-
SCCH 4.0 deployed on Docker
-
An up to date back up of the current SCCH 4.0 container files
This walkthrough describes how to:
-
Build new docker images for SXP 10.2 and SCCH 5.0.
-
Build the mssql-upgrade image
-
Perform the upgrade
Build new Docker images
You must build the Docker images for the new versions of SXP and SCCH.
To build the SXP 10.2 and SCCH 5.0 Docker images:
-
Download the SXP container deployment 10.2 package from the Sitecore download page. Extract it to a new folder on your local workstation with the folder structure intact. Name the new folder, for example,
SCCH7
. -
Download the SCCH container deployment 5.0 package from the Sitecore download page. Extract it to your local workstation with the folder structure intact. Copy the files in the
Chub.Asset\compose\<windows version>\<topology>
folder and paste them into the\compose\<windows version>\<topology>
folder in the SXP 10.2 deployment structure. -
Navigate to your Sitecore 10.1 container deployment folder. Copy the databases from the
mssql-data
folder and paste them in the Sitecore 10.2 container deploymentmssql-data
folder. -
To deploy Sitecore 10.2, open a PowerShell window with administrator rights, navigate to the SC 10.2 Container deployment folder, and run the following commands:
RequestResponseshelldocker-compose build docker-compose up
-
Verify that Sitecore Container 10.2 is up and running successfully.
Build the mssql-upgrade image
You use a custom mssql-upgrade image to upgrade a Sitecore solution that has SCCH installed. To build a custom mssql-upgrade image, you must download the latest Sitecore XP mssql-upgrade image from the container registry and create a custom Dockerfile on top of it.
-
From the Resource files for Modules 1.0.0 section on the Sitecore download page, download the Sitecore Connect for Content Hub Upgrade resources 1.0.0 package. Extract it to a folder on your local machine.
-
From the upgrade resources, copy the
\<current version>\Data
folder and paste it into the upgrade folder for the Windows version and topology you are using, for example,ltsc2019\upgrade\xp1
. -
In the
<current version>
folder, create a docker file and name itDockerfile
. In the file, add instructions to point its base image to the 10.2 mssql-upgrade image. The file will look, for example, like this:RequestResponseshellARG BASE_IMAGE=ideftdevacr.azurecr.io/sxp/sitecore-xp1-mssql-upgrade:10.2.0.006572.994-10.0.17763.2183-ltsc2019-unstable FROM ${BASE_IMAGE} SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"] # Add chub module COPY < SCCH Module Upgrade Resource file path> "C:\data\ResourceItems\10.1.0\modules\"
NoteIn the Dockerfile, ensure that ARG BASE_IMAGE parameter points to the mssql-upgrade image, and that the Data folder local path is set to the 6.0.0\Data folder in the folder you created in step 1.
-
To build the mssql-upgrade image, open a PowerShell window, navigate to the folder where you placed the Dockerfile, and run the following command:
RequestResponseshelldocker build . -t "<imageName>:<available port number>”
-
Verify that Docker has created an image with the name you specified.
Perform the upgrade
When you have prepared the container images, you can perform the upgrade.
To perform the upgrade:
-
On your local machine, in a PowerShell window, navigate to the SCCH Deployment 5.0 folder. Navigate to the upgrade folder for the Windows version and topology you are using, for example,
ltsc2019\upgrade\xp1
. -
In the topology folder, run the
compose-init.ps1 script
. This script updates the environment configuration file with the appropriate values for all the environment variables including the SQL username, SQL password, SQL Server address, and the Sitecore license file.NoteFor more information about running the script to prepare for the deployment, see the Installation Guide for Developer Workstation with Containers on the Sitecore download page.
-
In the upgrade folder, verify that the
upgrade.env
file has the correct details. For more details, see the Upgrade Container Deployment Guide for SXP 10.2.0. -
In the
docker-compose.upgrade.yml
file, update theimage
setting with the mssql-upgrade image you created previously. -
Open a new PowerShell window with administrator rights. Navigate to the upgrade directory.
-
Verify that the mssql container is up and running.
-
To perform the upgrade, run this command:
RequestResponseshelldocker-compose.exe -f .\docker-compose.upgrade.yml --env-file .\upgrade.env up
-
To check the status of the upgrade, run this command:
RequestResponseshelldocker-compose.exe -f .\docker-compose.upgrade.yml --env-file .\upgrade.env ps