UiPath Orchestrator Standalone (On-Prem) Upgrade Guide / Checklist


UiPath Orchestrator Standalone(On-Prem) Upgrade Guide/Checklist :rocket:


I hope it will be useful for those who will upgrade Orchestrator, please do not forget to vote and like the topic. :pray:

If there is something you see that is missing or incorrect, you can send me a message on LinkedIn or reply to the topic.

https://www.linkedin.com/in/seymenbahtiyar/


To enlarge the table, you can hover over the table and click this button.

image image


Task Title Task Details Documents/Notes Status Owner
Version Determination and Document Review The relevant documents are reviewed to determine the Orchestrator version to be upgraded. It is ensured that there are no constraints in the upgrade process for the selected version. If there are any integrations (such as Elasticsearch, Authentication, CyberArk, Proxy…) used besides the default Orchestrator structure, the documents related to these integrations are reviewed. If there are any, the upgrade process for the Test environment is planned first, and if no problem is encountered after the upgrade process of the Test environment, it is recommended to plan for the Live environment. It is recommended to perform the Robot and Studio Upgrade processes after the Orchestrator Upgrade process if necessary. Overview - Product Lifecycle
Overview - Orchestrator Upgrade Paths
Overview - Deprecation timeline
Overview - Classic folders removal
Orchestrator - 2022.10
Orchestrator - Installation Considerations
Overview - Compatibility Matrix
Orchestrator - About Updating and Migrating
Notify/Announcement/Downtime Plan Users/Customers/IT/Security/Departments are informed about the upgrade process. They are notified about the expected downtime. As a result of the communication, the triggers of the relevant processes are disabled before the upgrade according to the determined plan.
Rollback Plan The actions that need to be taken in the rollback scenario due to a problem encountered during or after the upgrade are determined and planned. If a rollback test can be done with the outputs of the backup processes, it is performed. Orchestrator - Backup and Restore
Hardware Requirements Hardware Requirements document is reviewed, and the requirements are met before the upgrade according to the need. If necessary, Orchestrator should be switched to Maintenance mode and stopped from IIS before meeting the requirements. If needed, the Orchestrator server is restarted after the requirements are met. Orchestrator - Hardware Requirements
Software Requirements Software Requirements document is reviewed, and the requirements are met before the upgrade according to the need. If necessary, Orchestrator should be switched to Maintenance mode and stopped from IIS before meeting the requirements. If needed, the Orchestrator server is restarted after the requirements are met. Orchestrator - Software Requirements
Prerequisites Prerequisites document is reviewed, and the requirements are met before the upgrade. If necessary, Orchestrator should be switched to Maintenance mode and stopped from IIS before meeting the requirements. If needed, the Orchestrator server is restarted after the requirements are met. Orchestrator - Prerequisites for Installation
Windows Updates Windows updates for the Orchestrator server are checked and if there are any updates available, it is ensured that they are done before the upgrade process. If necessary, Orchestrator should be switched to Maintenance mode and stopped from IIS before meeting the requirements. If needed, the Orchestrator server is restarted after the requirements are met.
Platform Configration Tool (Optional) Platform Configuration Tool is used to check whether all the requirements are met before the upgrade. If an unexpected error/output occurs as a result of the check, contact UiPath Support/UiPath Partner. Orchestrator - Platform Configuration Tool
SSL Certificate The validity, requirements and information of the Orchestrator SSL Certificate are checked and noted before the upgrade. This information will be requested from us during the upgrade. Orchestrator - About Updating and Migrating
Orchestrator - Prerequisites for Installation
Orchestrator - Using a Certificate for the HTTPS Protocol
Database & SQL Server & SQL User/Permissions The requirements and information of the Orchestrator Database are checked and noted before the upgrade. This information will be requested from us during the upgrade. Orchestrator - Prerequisites for Installation
IIS Application Identity Orchestrator Application Identity information is checked and noted before the upgrade. This information will be requested from us during the upgrade. Orchestrator - About Updating and Migrating
Application Pool Identities | Microsoft Learn
Backup VM / Snapshot The backup process of the Orchestrator server should be done just before the upgrade. (It is recommended to set up a regular vm backup structure if it does not exist.)
Backup Database The backup process of the Orchestrator Database should be done just before the upgrade. (It is recommended to set up a regular database backup structure if it does not exist.) Orchestrator - Backup and Restore
Orchestrator - Orchestrator Backup and Restore
Backup Configs & NuGet Orchestrator config files and NuGet packages should be backed up just before the upgrade. Orchestrator - Backup and Restore
Orchestrator - Backup Configuration Files and NuGet Packages
Antivirus (Optional) Some antivirus software may block the scripts used during the upgrade process. Therefore, if possible, the services of the antivirus software can be paused temporarily. If pausing is not an option and you are experiencing a problem related to this issue, it is recommended that you contact UiPath Support.
Start Maintenance Mode & Stop IIS Before starting the upgrade process, Orchestrator should be switched to Maintenance mode and then stopped from IIS. Maintenance mode is an optional step, but stopping is not optional and UiPath will not provide support for the upgrade process if it is not done. It is recommended to restart the server after stopping and start the upgrade process after the server becomes stable. If a restart is done, make sure that Orchestrator is still stopped on IIS after the restart. Orchestrator - Maintenance Mode
Orchestrator - About Updating and Migrating
Upgrading Using the Windows Installer The upgrade process starts by running the .msi file with admin rights. The installation is completed with the steps in the documentation. (It is recommended to run the command “UiPathOrchestrator.msi TELEMETRY_ENABLED=0 OUTPUT_PARAMETERS_FILE=InstallParameters.json /l*vx InstallerLogs.txt” with admin rights on powershell or cmd.) Orchestrator - Updating Using the Windows Installer
Orchestrator - The Windows Installer
https://download.uipath.com/versions/22.10.7/UiPathOrchestrator.msi
After Upgrading It is recommended to restart the Orchestrator server after the upgrade. After the server becomes stable, Orchestrator is started from IIS. If Maintenance mode was started, it is stopped after Orchestrator is started. All robot and studio servers are restarted. It is checked whether there is any problem in robot and studio connections, Orchestrator resources (Assets, Users, Folders, Roles, Packages, Triggers, Queues… etc.). If no problem is seen, the triggers of the processes are started to be enabled according to the determined plan. Users/Customers are informed that the upgrade process is completed. Lastly, you should monitor the live/test environments. Orchestrator - Maintenance Mode