Online upgrade

Preparation

Warning: Perform the following steps on the first server node and then on all the other nodes (both server and agent) in the cluster.

Make sure you have 10GiB of free space in the /opt/UiPathAutomationSuite folder on all the nodes. If you do not have enough space, you can either increase the capacity of this folder or remove all the previous installer files except for cluster_config.json. You can alway download the previous installer again.

To verify available space, run the following command: df -h /opt/UiPathAutomationSuite.

To prepare for the upgrade, take the following steps:

1. Log into any server machine using SSH. In the case of single-node evaluation profile, where you have only one server node, log into that node.
2. Become root user:

   sudo su -

3. Create an installation folder under the /opt/UiPathAutomationSuite directory:

   <h1>Please replace {version} with installer version
   mkdir -p /opt/UiPathAutomationSuite/{version}/installer</h1>

4. Download sf-installer.zip and copy it to /opt/UiPathAutomationSuite/{version}/installer.

   cp /path/to/sf-installer.zip /opt/UiPathAutomationSuite/{version}/installer

5. Unzip sf-installer.zip:

   cd /opt/UiPathAutomationSuite/{version}/installer
   unzip sf-installer.zip -d .

6. Provide permission to the installer:

   chmod 755 -R /opt/UiPathAutomationSuite/{version}/installer

7. Generate the latest cluster_config.json file on the first server node and copy it to the rest of the nodes.

• If you have the old cluster_config.json, generate the configuration file from the cluster:

  cd /opt/UiPathAutomationSuite/{version}/installer
  ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o ./cluster_config.json

• If you do not have the old cluster_config.json file, generate any override of any default values, which you may have done at the time of previous version installation:

  cd /opt/UiPathAutomationSuite/{version}/installer
  ./configureUiPathAS.sh config get -o ./cluster_config.json

Adding AI Center specific configuration

1. Open the cluster_config.json with your editor (for example, vi).

   vi /opt/UiPathAutomationSuite/{version}/installer/cluster_config.json

2. Replace the following block:

   "aicenter": {
     "enabled": "false"
   },

   Note: Document Understanding is enabled by default if AI Center is enabled.
3. With the following information (replacing the information between <> with your values):

   "aicenter": {
     "orchestrator_url":"<a href="https://orchestrator-url.com">https://orchestrator-url.com</a>",
     "identity_server_url": "<a href="https://orchestrator-url.com/identity">https://orchestrator-url.com/identity</a>",
     "orchestrator_cert_file_path": "</opt/UiPathAutomationSuite/orch.cer or custom path>",
     "identity_cert_file_path":  "</opt/UiPathAutomationSuite/orch.cer or custom path>",
     "identity_access_token": "<placeholder will be replaced later>",
     "metering_api_key": "<placeholder will be replaced later>"
   },

   Note: metering_api_key is the Document Understanding API Key from the AI Center cloud account as in the screenshot below.
   
   

   

   
   

Execution

Warning: If any errors or issues occur during or following the upgrade, you can rollback to the previous version, provided that you previously configured a backup. For instructions, see Rollback on error.

Configuring the backup

To configure the backup, take the following steps:

1. Make sure you have enabled the backup on the cluster. You must create the backup using the same version of the installer as the one you used for the current deployment. For instructions, see the backup and restore documentation corresponding to the UiPath AI Center version from which you plan to upgrade.
2. Connect to one of the server nodes via SSH.
3. To verify that all desired volumes have backups in the cluster, run:

   /path/to/old-installer/configureUiPathAS.sh verify-volumes-backup

   Note: The backup might take some time, so wait for approximately 15-20 minutes, and then verify the volumes backup again.

Once the backup is created, continue with the following steps.

Putting the cluster in maintenance mode

Putting the cluster in maintenance mode will shut down the ingress controller and all the UiPath services, blocking all the incoming traffic to the AI Center cluster.

Warning: This operation will cause downtime, and your business automation will be suspended during the entire upgrade process.

1. To put the cluster in maintenance mode, run:

   cd /opt/UiPathAutomationSuite/{version}/installer
   ./configureUiPathAS.sh enable-maintenance-mode

2. To verify that the cluster is in maintenance mode, run:

   ./configureUiPathAS.sh is-maintenance-enabled

   Warning: Create a backup of your SQL Server after enabling maintenance mode so that no further transactions are recorded in your SQL database.

Updating Kubernetes and other infrastructure components

Warning: You must perform the infrastructure upgrade on all the nodes in the cluster.

You cannot perform this step on multiple nodes at the same time; you must wait for the upgrade to finish on each node before moving to another.

1. Log into each node where you want to perform the infrastructure upgrade.
2. Become root by running sudo su -.
3. Make sure rke service is enabled on server and agent nodes.

   If the service is disabled, enable it by running the following command:

   • For a server node:

     [[ $(systemctl is-enabled rke2-server.service) != "enabled" ]] && systemctl enable rke2-server.service

   • For an agent node:

     [[ $(systemctl is-enabled rke2-agent.service) != "enabled" ]] && systemctl enable rke2-agent.service

4. To start the upgrade, run the following command:
   Warning: Make sure you have updated cluster_config.json generated as described in the Preparation steps.

   replace {version} with the version you are upgrading to
   cd /opt/UiPathAutomationSuite/{version}/installer
   /path/to/new-installer/install-uipath.sh --upgrade --install-standalone-aicenter -k -i /path/to/cluster_config.json --accept-license-agreement -o /path/to/output.json

   Important: If you get an error, follow the instructions in Downgrading Ceph from 16.2.6 to 15.2.9.

Updating shared components and UiPath product services

This step upgrades the fabric and service components running with the cluster. You must follow this steps only once from any of the server nodes.

1. Connect to any server node.
2. Become root by running sudo su -.
3. Run the following command:

   replace {version} with the version you are upgrading to
   cd /opt/UiPathAutomationSuite/{version}/installer
   /path/to/new-installer/install-uipath.sh --upgrade --install-standalone-aicenter -f -i /path/to/cluster_config.json --accept-license-agreement -o /path/to/output.json

4. Run the software installer by using the command below.
   First you need to connect to identity server and retrieve an installation token. Then copy this token and paste it in placeholder from the cluster_config.json file.

   Once the token is there, you can run the AI Center install.

   /path/to/new-installer/install-uipath.sh --upgrade --install-standalone-aicenter -s -i /path/to/cluster_config.json --accept-license-agreement -o /path/to/output.json

   Warning: Once the upgrade is done, maintenance mode will be disabled automatically.

Enabling the backup post-upgrade

Warning: Make sure AI Center is up and running and your automation continues as expected before proceeding with the next steps.

Before starting to upgrade the cluster, the upgrade script automatically creates a backup of the cluster and then temporarily disables it. You may want to enable the backup manually once the upgrade is done.

To enable the backup, run the following command from any server node:

replace {version} with the version you are upgrading to
cd /opt/UiPathAutomationSuite/{version}/installer
./configureUiPathAS.sh resume-scheduled-backups