Installation of the High Availability Add-on (HAA) for your Orchestrator instance is performed by downloading and executing a provided script.

Before proceeding with your HAA installation be sure that you meet the Hardware and Software Requirements.

📘

Note:

HAA requires a separate license from Orchestrator. Contact UiPath for details.

📘

Note:

We support backwards compatibility with Orchestrator but recommend updating to the latest HAA version.

Installation

Prerequisites

Prior to beginning the HAA installation, ensure that you:

• are the root user or have access to sudo to the root user.
• have user creation rights.
• ensure that you have a valid SSL/TLS certificate. Refer to Redis documentation for instructions on how to update your certificates.
• enabled firewall service.

📘

Note:

Root permissions are required only for installation and upgrade, the HAA admin user does not need escalated permissions to administer the cluster services.
On the following daemons run by the HAA admin user, capability bits have been set to allow the executable the minimal privileges required to operate:

/opt/redislabs/bin/dmcproxy = cap_sys_resource+ep
/opt/redislabs/bin/redis-server-4.0 = cap_sys_resource+ep
/opt/redislabs/bin/redis-server-4.0-big = cap_sys_resource+ep
/opt/redislabs/bin/redis-server-5.0 = cap_sys_resource+ep
/opt/redislabs/bin/redis-server-5.0-big = cap_sys_resource+ep
/opt/redislabs/bin/sentinel_service = cap_sys_resource+ep
/opt/redislabs/sbin/pdns_server = cap_net_bind_service+ep
/opt/redislabs/sbin/smaps = cap_sys_ptrace+ep

These allow the HAA admin user to run these services with privilege without requiring the user to have the privileges assigned."

• disable Swap:

1. Disable swap with the command: sudo swapoff -a.
2. To persist this change through reboots, comment the swap entry in the etc/fstab file by running: sudo sed -i.bak '/ swap / s/^(.*)$/#1/g' /etc/fstab.
3. Repeat this process on all nodes where you are installing HAA.

Also, depending on your language and character set (encoding), you may experience issues while running the installation script. It is recommended checking first if English is added to the list of languages:

1. View information about the current installed locale used: run locale -a or localectl.
2. Set English as the language and encoding for the current session, by running:$ export LANG="en_US.utf8".

Master Node

1. Download the installation script by running wget https://raw.githubusercontent.com/UiPath/Infrastructure/main/Setup/get-haa.sh.
2. Make the script executable by running chmod a+x get-haa.sh.
3. Install the master node with the following command: sudo ./get-haa.sh -u <email> -p <password>.
   Provide the email and desired password for the account administrator, and the installation directories.

🚧

Important!

To install HAA in a custom location run the install.sh script for advanced configuration (this does not create any cluster), keeping in mind that all locations must be different. For example:
sudo ./install.sh --install-dir /opt/haa-uipath --config-dir /etc/opt/haa-uipath --var-dir /var/opt/haa-uipath.

Secondary Nodes

After you have installed the primary (master) node, from each additional node:

1. Create the directory where HAA is to be downloaded and extracted, for example: mkdir haa.
2. Change to the newly created directory using the command: cd /<path-to>/haa/.
3. Download the installation script by running wget https://raw.githubusercontent.com/UiPath/Infrastructure/main/Setup/get-haa.sh.
4. Make the script executable by running chmod a+x get-haa.sh.
5. Install the node with the following command: sudo ./get-haa.sh -u <email> -p <password> -j <IP_address_of_the_master_node>.
   Provide the email and password set when creating the master node, and the IP address of the primary node.

Script Parameters

The following parameters are available when running the HAA installation script:

UiPath.Orchestrator.dll.config Configuration

You must configure Orchestrator to use HAA and add all HAA nodes to the Orchestrator UiPath.Orchestrator.dll.config file using the LoadBalancer.UseRedis and LoadBalancer.Redis.ConnectionString parameters. For example:

<add key="LoadBalancer.UseRedis" value="true" />
<add key="LoadBalancer.Redis.ConnectionString" value="10.10.20.184:10000,10.10.24.148:10000,10.10.22.114:10000,password=SuperSecret_Password" />

Verifying the Cluster Installation

After you have installed all nodes of your HAA cluster, confirm the successful configuration as follows:

1. Navigate your browser to the IP address of any HAA node on port 8443. For example: https://10.10.20.196:8443/. The HAA login page is displayed.

2. Enter the username and password provided during the installation to login.
3. Select the nodes tab and verify that all installed nodes appear here with a status of OK.

4. Select the databases tab and confirm that the uipath-orchestrator database appears here with a status of OK.
5. If deployed on more than one node, ensure that Replication is enabled in the database settings and that two nodes are showing a shard count of 1. This ensures that the database is replicated on two nodes.

📘

Note:

By default this database is created on port 10000 with the password provided at installation.

HAA Licensing

To add or update your High Availability Add-on license, follow these steps:

1. Navigate your browser to the IP address of any HAA node on port 8443. For example: https://10.10.20.196:8443/. The HAA login page is displayed.
2. Enter the username and password provided during the installation to login.
3. Select the settings > general tab.
4. In the Cluster key field enter your license key.
5. Click Save.

Your HAA cluster is now ready, and you can proceed with the Orchestrator installation, as described here.