Documentation Center

Upgrading a Content Delivery microservice

This section explains the steps involved in upgrading a Content Delivery microservice on a target machine. These steps apply to all microservices; the Content Service and Content Deployer require additional steps.

Before you begin

If the microservice you intend to upgrade needs one or more relational databases or OpenSearch indexes, ensure that you have upgraded those databases and indexes.

If you are upgrading from a release before Tridion Sites 10, and if you have caching implemented on the server, refer to the implementation section about caching to learn how to configure the new embedded caching feature. The configuration of caching was previously located in the Storage Layer file cd_storage_conf.xml of a microservice. While caching still needs to be enabled in that file, the configuration itself is now located in the application.properties file of the microservice.

If you are using Digital Experience Accelerator (DXA) to build your website, your Content Service needs to continue to be extended with the DXA Model Extension in order to support the DXA data model. So when you upgrade the Content Service, you must also upgrade the DXA Model Extension to the same version. As from Tridion Sites 10, the DXA Model Extension ships with the Tridion Docs product. Refer to the specific upgrade documentation for the Content Service for upgrade instructions.

Procedure

  1. If the microservice you are upgrading runs on a Windows machine, from the bin\ folder, run the Powershell script uninstallService.ps1.
  2. Back up the configuration files of your existing microservice to a safe location.
  3. Back up any microservice extensions you have created, along with their configurations, if any, to a safe location.
  4. Back up any other custom files located in the microservice folder to a safe location.
  5. Delete the contents of the folder containing your existing microservice.
  6. Copy the new microservice resources from your Tridion Docs installation media to the folder whose contents you just deleted.
  7. Merge all custom settings in your backed-up configuration files into the new configuration files you copied.
  8. Restore all customizations that you backed up, along with any configurations they may have.
  9. Run the installation script to install the new version of the microservice, passing configuration parameters as needed. Refer to the installation section to learn how to configure and run the installation script.