Upgrading the Add-ons Service

Follow this process to upgrade the Add-ons Service to v9.6. If upgrading from Tridion Sites 9.1, you may have secured the Add-ons Service directly with an external identity provider (IdP). As of Tridion Sites 9.5, this direct way is no longer supported for the Add-ons Service, and you need to configure security in Access Management.

Before you begin

Before upgrading the Add-ons Service, you need to have first upgraded the database.

To run Powershell scripts, you require a machine that meets the following requirements (any Tridion Sites 9.6 server machine running Windows meets these requirements):
PrerequisiteDescription
Operating systemYou can run the scripts on any machine running an operating system that supports any version of Powershell of 5.0 and higher.
Powershell softwareRunning the scripts requires a version of Powershell between 5.0 and higher.
Microsoft .NET FrameworkRunning the scripts requires Microsoft .NET Framework 4.8 or higher.
SecurityYou need to be logged in as a user with sufficient security clearance. For example, to run a script that installs software to a target folder, you must be logged in as a user with write access to that folder.

The steps that follows represent a high-level process, which includes several tasks that are individually explained in other topics. For details on the individual tasks, refer to the related topics.

Procedure

  1. Uninstall old Add-ons Service. Rename it, if needed.
  2. From the Tridion Sites 9.6 installation media, copy the entire root-level folder Add-on Service\ to a folder of your choice on the target machine.
  3. If upgrading from Tridion Sites 9.1, configure security settings for the Add-ons Service by editing the authsettings.json file and defining Access Management as the source for OpenID Connect calls. If the Add-ons Service was secured in 9.1, you need to migrate security settings to Access Management.
  4. Install a new Add-ons Service that uses the upgraded database.
  5. Configure the Add-ons application in Access Management.

What to do next

Each server in the Content Delivery environment connects to a secured Add-ons Service using settings are contained in environment variables. After upgrading the Add-ons Service and migrating security to Access Management (as needed), you need to update the client security settings for Content Delivery. For details, refer to the related topic.