1. Introduction

Sitecore Container Deployment Package

Version: 10.5

The Sitecore Container Deployment Package is a set of tools that you use to upgrade the SQL Server databases of your existing Sitecore XP 9.3.0 or later to Sitecore XP 10.5.X.

These tools use containers to upgrade the SQL databases and can be used in both Docker Compose and Kubernetes environments. You can use these tools to upgrade both on-prem Sitecore installations and containerized installations to either an on-prem Sitecore installation or a containerized installation. However, these tools are primarily designed to upgrade containerized installations.

You can use this package to update both XP and XM topologies.

You must edit the tools in the package to provide the relevant information about your Sitecore solution.

When you run the tools, they download the Sitecore upgrade container image from the Sitecore Container Registry and deploy this container to upgrade the SQL databases of your existing Sitecore XP installation.

Since Sitecore XP 10.0.1, the Sitecore upgrade container contains all the required information about the changes that have been implemented in Sitecore.

The Sitecore container upgrade assets are:

  • Sitecore SQL upgrade Docker image

    A Docker image with all the tools required to upgrade Sitecore SQL databases.

  • Docker Compose configuration files

  • Kubernetes specification files

Topologies

You can use the Sitecore container upgrade assets to upgrade Sitecore SQL databases in the following topologies:

  • XP Scaled (XP 1)

    To upgrade the Sitecore Experience Platform databases, use the sitecore-xp1 upgrade container assets either for Docker Compose or Kubernetes.

  • XM Scaled (XM 1)

    To upgrade the Sitecore Experience Manager databases, use the sitecore-xm1 upgrade container assets either for Docker Compose or Kubernetes.

Upgrade for containerized XP Single topologies (XP 0) are not supported.

Sitecore upgrade Docker Compose configuration files

The Sitecore upgrade Docker Compose files for the Sitecore XP and Sitecore XM topologies are:

  • docker-compose.upgrade.yml

    The Docker Compose configuration file that contains information about the upgrade containers and its configuration.

  • upgrade.env

    The Docker environment file that declares the default environment variables used in the compose file and by the upgrade container.

For more information about which environment variables are used in the Docker Compose environments for the supported topologies, see Appendix C – The environment variables list.

Sitecore upgrade Kubernetes specification files

The Sitecore Kubernetes specification files for the Sitecore XP and Sitecore XM topologies are:

  • mssql-upgrade.yaml

    The Kubernetes specification file that you use to deploy, configure, and run the upgrade container in a Kubernetes cluster.

  • kustomization.yaml

    The file that deploys all the secret names and values required by the upgrade container.

  • Secrets and ConfigMap values

    The text files used to store values for Kubernetes secrets and the ConfigMap values used by the upgrade container. The files are stored in Kubernetes specification files for each topology in the /configuration/ folder.

For a complete list of the secrets and ConfigMap values as well as more information about them, see Appendix B – The Kubernetes secrets list.

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