- Getting Started
- Network requirements
- Single-node requirements and installation
- Multi-node requirements and installation
- Post-installation
- Accessing AI Center
- Provision an AI Center tenant
- Updating Orchestrator and Identity Server certificates
- Resizing PVC
- Adding a new node to the cluster
- ML packages offline installation
- Configuring the cluster
- Configuring the FQDN post-installation
- Backing up and restoring the cluster
- Using the monitoring stack
- Setting up a Kerberos authentication
- Provisioning a GPU
- Using the configuration file
- Node scheduling
- Migration and upgrade
- Basic Troubleshooting Guide
Offline upgrade
/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.
df -h /opt/UiPathAutomationSuite
.
To prepare for the upgrade, take the following steps:
- Identify the server (not agent) node that has
additional
UiPath bundle
disk attached at/uipath
mount point. This node is referred to as primary server node throughout the document. In the case of a single-node evaluation profile, where you have only one server node, you must log into that node.Note: Perform the following steps on all the nodes in the cluster. Start with the server nodes and continue with the agent nodes. - Connect to a node using SSH.
- Become root
user:
sudo su -
sudo su - - Create an installation folder under the
/opt/UiPathAutomationSuite
directory:<h1>Please replace {version} with installer version mkdir -p /opt/UiPathAutomationSuite/{version}/installer</h1>
<h1>Please replace {version} with installer version mkdir -p /opt/UiPathAutomationSuite/{version}/installer</h1> - Download
sf-installer.zip
and copy it to/opt/UiPathAutomationSuite/{version}/installer
. For download instructions, see sf-installer.zip.cp /path/to/sf-installer.zip /opt/UiPathAutomationSuite/{version}/installer
cp /path/to/sf-installer.zip /opt/UiPathAutomationSuite/{version}/installer - Download
sf-infra.tar.gz
and copy it to/opt/UiPathAutomationSuite/{version}
. For download instructions, see sf-infra.tar.gz:cp /path/to/sf-infra.tar.gz /opt/UiPathAutomationSuite/{version}
cp /path/to/sf-infra.tar.gz /opt/UiPathAutomationSuite/{version} - (Only on the primary server node).
Download
sf.tar.gz
and copy it to/uipath/{version}
. For download instructions, see sf.tar.gz:cp /path/to/sf.tar.gz /uipath/{version}
cp /path/to/sf.tar.gz /uipath/{version} - Unzip
sf-installer.zip
:cd /opt/UiPathAutomationSuite/{version}/installer unzip sf-installer.zip -d .
cd /opt/UiPathAutomationSuite/{version}/installer unzip sf-installer.zip -d . - Provide the necessary permissions to the
installer:
chmod 755 -R /opt/UiPathAutomationSuite/{version}/installer
chmod 755 -R /opt/UiPathAutomationSuite/{version}/installer - Generate the latest
cluster_config.json
on the first server node and copy it to the rest of the nodes. For details on how to configure thecluster_config.json
parameters, see Using the configuration file.
- If you have the old
cluster_config.json
, generate the configuration file from the cluster by running:cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o ./cluster_config.json
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 an override of any default values you may have done at installation time of previous version:cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -o ./cluster_config.json
cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -o ./cluster_config.json
- Open the
cluster_config.json
with your editor (for example, vi).vi /opt/UiPathAutomationSuite/{version}/installer/cluster_config.json
vi /opt/UiPathAutomationSuite/{version}/installer/cluster_config.json - Replace the following block:
"aicenter": { "enabled": "false" },
"aicenter": { "enabled": "false" },Note: Document Understanding is enabled by default if AI Center is enabled. - 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>", },
"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>", },
To configure the backup, take the following steps:
- 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.
- Connect to one of the server nodes via SSH.
- To verify that all desired volumes have backups in the cluster, run:
/path/to/old-installer/configureUiPathAS.sh verify-volumes-backup
/path/to/old-installer/configureUiPathAS.sh verify-volumes-backupNote: 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 will shut down the ingress controller and all the UiPath services, blocking all the incoming traffic to the AI Center cluster.
- To put the cluster in maintenance mode, run:
cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh enable-maintenance-mode
cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh enable-maintenance-mode - To verify that the cluster is in maintenance mode, run:
./configureUiPathAS.sh is-maintenance-enabled
./configureUiPathAS.sh is-maintenance-enabledWarning: Create a backup of your SQL Server after enabling maintenance mode so that no further transactions are recorded in your SQL database.
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.
- Log into each node where you want to perform the infrastructure upgrade.
- Become root by running
sudo su -
. - Make sure
rke service
is enabled on server and agent nodes.If the service is disabled, enable it by running the following command:
- For server nodes:
[[ $(systemctl is-enabled rke2-server.service) != "enabled" ]] && systemctl enable rke2-server.service
[[ $(systemctl is-enabled rke2-server.service) != "enabled" ]] && systemctl enable rke2-server.service - For agent nodes:
[[ $(systemctl is-enabled rke2-agent.service) != "enabled" ]] && systemctl enable rke2-agent.service
[[ $(systemctl is-enabled rke2-agent.service) != "enabled" ]] && systemctl enable rke2-agent.service
- For server nodes:
- 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 --offline-bundle "/path/to/sf-infra.tar.gz" --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement -o /path/to/output.json
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 --offline-bundle "/path/to/sf-infra.tar.gz" --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement -o /path/to/output.jsonImportant: If you get an error, follow the instructions in Downgrading Ceph from 16.2.6 to 15.2.9.
This step upgrades the fabric and service components running with the cluster. You must follow this steps only on the primary server node.
- Connect to any server node.
- Become root by running
sudo su -
. - Run the following command:
replace {version} with the version you are upgrading to in both the commands cd /opt/UiPathAutomationSuite/{version}/installer /path/to/new-installer/install-uipath.sh --upgrade --install-standalone-aicenter -f -i /path/to/cluster_config.json --offline-bundle "/path/to/sf.tar.gz" --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement -o /path/to/output.json
replace {version} with the version you are upgrading to in both the commands cd /opt/UiPathAutomationSuite/{version}/installer /path/to/new-installer/install-uipath.sh --upgrade --install-standalone-aicenter -f -i /path/to/cluster_config.json --offline-bundle "/path/to/sf.tar.gz" --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement -o /path/to/output.json - 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 --offline-bundle "/path/to/sf.tar.gz" --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement -o /path/to/output.json
/path/to/new-installer/install-uipath.sh --upgrade --install-standalone-aicenter -s -i /path/to/cluster_config.json --offline-bundle "/path/to/sf.tar.gz" --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement -o /path/to/output.jsonWarning: Once the upgrade is done, maintenance mode will be disabled automatically.
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.
replace {version} with the version you are upgrading to
cd /opt/UiPathAutomationSuite/{version}/installer
./configureUiPathAS.sh resume-scheduled-backups
replace {version} with the version you are upgrading to
cd /opt/UiPathAutomationSuite/{version}/installer
./configureUiPathAS.sh resume-scheduled-backups