Upgrading the Content Deployer microservice or microservices

Depending on how you have set up the Content Deployer feature (as one combined microservice or as two separate microservices), you need to upgrade the resources of one or two microservices.

About this task

The Content Deployer can be set up in two ways:
  • As a single combined Content Deployer microservice
  • As two separate Content Deployer microservices, the Content Deployer worker and the Content Deployer endpoint.

In the first case, perform the steps below once; in the second case, perform the steps below twice, once for each microservice.

Procedure

  1. On the server on which this microservice is installed, navigate to the configuration location of the microservice.
  2. Back up the contents of this folder to a safe location.
  3. Back up any custom microservice extensions you have created to a safe location.
  4. On your SDL Tridion Docs 14 installation media, navigate to the folder Content Delivery\roles\.
  5. Navigate to one of the following subfolders, depending on the microservice you are upgrading:
    • If you are upgrading a combined Content Deployer microservice, navigate to deployer\deployer-combined\standalone\
    • If you are upgrading a Content Deployer worker microservice, navigate to deployer\deployer-worker\standalone\
    • If you are upgrading a Content Deployer endpoint microservice, navigate to deployer\deployer-endpoint\standalone\
  6. Back up any custom files in the microservice location to a safe location.
  7. Delete all files and subfolders from the microservice location.
  8. Copy the contents of the installation media folder, including subfolders, to your installed microservice location.
  9. With the exception of deployer-conf.xml, restore your backed-up configuration files to the configuration location of the microservice.
  10. Only if you have changed your copy of deployer-conf.xml, merge its contents with the new deployer-conf.xml.
  11. Restore your backed-up configuration files (but not the schemas\ subfolder) to the configuration location of the microservice.
  12. If you are upgrading the combined Content Deployer microservice or the Content Deployer worker microservice, in the configuration location of the microservice, rename the file udp-search-conf.xml to cd_client_conf.xml.
  13. If you are upgrading the Content Deployer endpoint microservice or the Content Deployer worker microservice, note that the default ports for these microservices have changed:
    • The default port for the Content Deployer endpoint was previously 8095, and is now 8084.
    • The default port for the Content Deployer worker was previously 8096, and is now 8085.

    You can update your environment to listen on the new default ports, or you can continue using the ports you have been using. In the latter case, ensure that both the Storage Layer configuration file, cd_storage_conf.xml, and your installation script, installService.ps1 or start.sh, are configured to use the existing ports. In your installation script, use the -service.port switch to override the default port number.

  14. Restore any backed-up custom microservice extensions to your microservice.
  15. If the server on which this microservice is installed is a Windows machine, install the Windows service by doing the following:
    1. On the server, open a Powershell command prompt.
    2. Access the bin\ subfolder of the microservice root folder.
    3. Run the script called installService.ps1.
    On a non-Windows machine, simply run the start script in the bin/ subdirectory.