Use the following workflows to upgrade your current Relativity installation to Relativity Server 2021. To begin your upgrade process, address custom solutions and scripts before downloading the Relativity installer. Once you complete the workflow specific to your upgrade path, we recommend completing the post-installation verification tests post-upgrade to confirm that your environment has been upgraded properly.
As a best practice, we recommend preparing for your upgrade process by using the Pre-Upgrade Checklist. You can use this document to discuss an upgrade strategy for your current installation of Relativity with the Client Services team.
This topic contains the following sections:
- Addressing custom solutions pre-upgrade
- Addressing custom scripts that trigger imaging jobs
- Required pre-upgrade steps for all Relativity versions
- 8.1, 8.2, 9.x, or 10.x to Server 2021 upgrade workflow
- 8.0 to Server 2021 upgrade workflow
- 7.x to Server 2021 upgrade workflow
- 6.x to Server 2021 upgrade workflow
The Solution Snapshot application helps you identify compatibility issues with custom applications in your environment so you can resolve them prior to upgrade. Using the Solution Snapshot application, you can view a list of the applications currently installed in your Application Library and review the application owner's recommendation for upgrade. For more information, see Solution Snapshot.
If you plan on upgrading Relativity and you use custom scripts that programmatically trigger imaging jobs in your current Relativity environment, those scripts will no longer work after you upgrade.
This is because the components that those custom scripts rely upon no longer exist due to the changes made to the imaging framework, which are listed below. The imaging operations performed by these custom scripts aren't accounted for in the KCD Snapshot Solution script.
- The Imaging Set Manager and Worker agents have been deprecated.
- The Imaging Set Queue table has been deprecated.
- The Imaging API now submits an imaging job directly to Invariant (worker manager server).
Before you upgrade to Relativity Server 2021, contact Client Services for instructions on how to adjust your custom scripts.
Before you begin your upgrade, you must complete the following pre-upgrade steps.
Complete the following steps and verify you have the necessary information required for all upgrades of Relativity. Depending on your upgrade path, you may have additional configuration or other tasks to perform specific to the version of Relativity you're installing.
Make sure you have the appropriate system admin permissions in Relativity before beginning the upgrade.
Confirm that jobs aren't running in any of the queues. If the agents are running, they may attempt to run a job against a database that doesn't have an upgraded schema and cause serious errors in your Relativity environment.
Obtain credentials for service and database accounts
To upgrade Relativity, you need credentials for the following accounts:
- Relativity Service account (Windows Workgroup/Domain account) - Run the Relativity upgrade logged in as the Relativity Service account. This account must have local Administrator permissions on the target server, and SQL sysadmin role privileges on the SQL Server.
- EDDSDBO account (SQL account)
Note: Do not begin the upgrade process until you obtain the credentials for these accounts. They are required when you run the installer.
Review system and other requirements
Confirm that your environment is configured with the prerequisites before you begin upgrading Relativity. See the following documents for more information:
- Relativity System Requirements - Includes software and hardware requirements for servers, databases, and other components of a Relativity installation.
- Relativity Workstation Configuration - Includes information about setting up workstations for users and viewer installation instructions.
- Relativity Environment optimization guide - Includes best practices for maintaining and optimizing a Relativity environment.
- Upgrade path instructions - Contain detailed information about requirements for your specific upgrade path.
Apply a trusted certificate for the Analytics server
As of Relativity Server 2021, a trusted certificate is required for all HTTPS traffic, including the internal traffic for the Analytics server. We recommend placing the certificate and testing it prior to the day of the upgrade to Relativity Server 2021 or above.
See Pre-upgrade: Update the default SSL/TLS certificate for CAAT® for more information.
Back up your Relativity environment
Back up your SQL databases and your Relativity IIS websites before you begin the upgrade process. You should also back up both the structured analytics sets and analytics indexes before your upgrade to ensure that there is no data loss. This may take a while so it's recommended to run analytics backups either during the week of or the week prior to your upgrade. Usually this data does not change daily, so this helps to mitigate any data loss.
Reboot machines with Windows updates
After installing Windows updates, reboot your machines before attempting to install Relativity. Complete this step to ensure that all Relativity components are properly installed. Incomplete Windows updates lock system files, which may cause silent failures and prevent the proper installation of Relativity components.
Download the Relativity installer
To receive the correct Relativity installer package for your upgrade workflow contact the Client Services team.
Use the following workflow when upgrading from Relativity 8.1, 8.2, 9.x, or 10.x to Relativity Server 2021.
Note: Never upgrade your Relativity version while there are jobs of any type currently in progress in your environment. Doing this leads to inaccurate results when you attempt to finish those jobs after your upgrade is complete. This is especially important for imaging and processing jobs.
To upgrade your environment from 8.1, 8.2, 9.x, or 10.x to Server 2021, use the following diagram as a guide. Click on a step to navigate to a topic.
- Before you upgrade, verify that you meet all requirements outlined in Pre-installation.
- Once you've completed upgrading core servers (Secret Store, Primary SQL, Worker Manager, Service Bus) all remaining servers can be upgraded in any order or in parallel.
- Install the Relativity Secret Store and configure all machines in your environment to access it. This step should be completed before the Relativity upgrade and can be done online without impacting user review. For more information, see Relativity Secret Store.
- Stop all agent services.
- Stop the IIS.
- Run the Relativity installer on your Primary SQL Server to upgrade the EDDS database and install the required library applications. You can't access your Relativity environment until you complete this step. Depending on what version you're upgrading from, this process may start automatically after the installer is finished running. See Upgrading your SQL Server.
- Run the Relativity installer on all distributed SQL servers if present. See Distributed SQL Server upgrade.
- Install the Relativity service bus server. Ensure that the Relativity service bus server is a node in the Service Bus for Windows Server farm. See Upgrading your Relativity service bus
Note: You can find additional information in Upgrading your Relativity service bus.
For general troubleshooting information, see Troubleshooting the Service Bus for Windows Server and Relativity service bus.
- Run the Relativity installer on the Agent server. See Upgrading your agent server.
- Run the Relativity installer on the Web server. See Upgrading your web server.
- Restart the IIS.
- (Optional) Log in to Relativity and click the Workspace Upgrade queue. Set the priority or order on the workspaces as necessary.
You can monitor your workspaces in the Monitoring upgrades with the Workspace Upgrade queue.
Note: After you run the installer on at least one agent server, the system begins upgrading individual workspaces. You can now log in to Relativity to monitor workspace upgrades via the Workspace Upgrade queue.
- Upgrade your worker manager server. For more information, see the Upgrading a worker manager server installation.
Note: If this is your first upgrade to Relativity Server 2021 and above, you must upgrade any worker servers after upgrading your worker manager server.
- Upgrade Analytics. See Upgrading or installing your Analytics server.