Walkthrough: Upgrading SCCH 4.0 to 5.0 on Kubernetes

Abstract

How to upgrade the Sitecore Connect for Content Hub connector on Azure Kubernetes service.

This section explains how you upgrade Sitecore Connect for Content Hub (SCCH) container in Kubernetes to 5.0.

Before you perform the upgrade for Container SCCH Container to version 5.0, you must have a Sitecore AKS 10.1 deployment with SCCH 4.0 and an up to date backup of the 10.1 database.

This walkthrough describes how to:

  • Build and push the mssql-upgrade image

  • Perform the upgrade

To upgrade SCCH you must build an mssql-upgrade image. To do so:

  1. Build the images for SCCH as explained in the Build the mssql-upgrade image section in ???.

  2. In a PowerShell window, navigate to the folder containing the Dockerfile and build and tag the image. For example:

    docker build . -t sitecore-scch-xp1-cm:<imageVersionTag> $registry/sitecore-scch-xp1-cm:<newTag>
  3. Check that Docker has created the image.

  4. Push the created image to your Azure registry. For example:

    docker push $registry/sitecore-scch-xp1-cm:<newTag>

When you have built the container images, you can upgrade SCCH.

To upgrade to SCCH 5.0 on Sitecore 10.2:

  1. Download and extract Sitecore 10.2 Sitecore Container Deployment Package from the Sitecore download page. Extract it to your local workstation with the folder structure intact.

  2. Navigate to the upgrade folder for the Windows version and topology you are using, for example, k8s\ltsc2019\upgrade\xp1. In the kustomization.yaml file, update the images section with newName and newTag of the custom mssql-upgrade image you created and pushed previously.

  3. In the configuration folder, update the secrets files. For more information on the secrets files, please refer to the Installation Guide for Production Environment with Kubernetes guide available on the Sitecore download page.

  4. 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 SCCH\k8s\<windows version>\overrides folder and paste it into the \k8s\<windows version>\ folder in the SXP 10.2 deployment structure.

  5. In the secrets folder in the SXP 10.2 structure, for example, k8s\ltsc2019\overrides\xp1\secrets, update these secrets files:

    • sitecore-cmp-content-hub.txt

    • sitecore-cmp-service-bus-entity-path-in.txt

    • sitecore-cmp-service-bus-entity-path-out.txt

    • sitecore-cmp-service-bus-subscription.txt

    • sitecore-dam-content-hub.txt

    • sitecore-dam-external-redirect-key.txt

    • sitecore-dam-search-page.txt

  6. Log in to the Azure CLI and set a subscription.

    az login
    az account set --subscription "Your Subscription"
  7. Get the credentials for the Kubernetes cluster that was created with the AKS cluster.

    zaks get-credentials --resource-group <10.1 resource group>--name <10.1 cluster>
  8. To deploy the Sitecore upgrade job, go to the folder where the updated files are, for example k8s\ltsc2019\upgrade\xp1, and run this command:

    kubectl apply -k .\
  9. To check if the job has completed, run this command:

    kubectl get pod
  10. When the upgrade process is completed, you can delete the Kubernetes upgrade job and upgrade secrets. In the console, go to the upgrade folder from step 2, and run these commands:

    kubectl delete -f .\
    kubectl delete -k .\

Note

Upgrading with a custom mssql-image includes cleaning up SCCH items from the database since SCCH 5.0 has moved to using resources files. This requires rebuilding and upgrading the Sitecore role instances cm, xconnect, and xdbsearchworker.

For detailed instructions on how to build and deploy the Sitecore role instances please refer to the Sitecore Upgrade Container Deployment Guide on the Sitecore download page.