- Overview
- Requirements
- Installation
- Installing High Availability Add-on
- Alerts and monitoring
- Active/Active Disaster Recovery installation
- Upgrade
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Installing High Availability Add-on
There are two ways to install the High Availability Add-on (HAA) for your Orchestrator instance:
-
quick – by downloading and executing a provided script; used when you want to set up HAA inside a single datacenter.
For details, see Quick installation.
-
advanced – by performing some complex operations, including cluster DNS configuration, and cluster creation and setup; used when you want to set up HAA inside multiple datacenters.
For details, see Active/Active Disaster Recovery Installation.
Before proceeding with your HAA installation, make sure that you meet the .
- 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
:sudo swapoff -a
sudo swapoff -a - To persist this change through reboots, delete the
swap
partition in theetc/fstab
file. - Install the
wget
package. Make sure to use a download command supported by your Linux distribution. For example, if you use CentOS, run:yum install wget
yum install wget - Repeat this process on all nodes where you plan to install HAA.
Check if English is added to the list of languages.
Depending on your language and character set (encoding), you may experience issues while running the installation script. It is recommended that you first check if English is added to the list of languages, as follows:- View information about the currently installed
locale
by running either or the following commands:locale -alocalectl
locale -alocalectllocalectl
localectl - Set English as the language and encoding for the current session, by running:
$ export LANG="en_US.utf8"
$ export LANG="en_US.utf8"
- View information about the currently installed
- Disable
To install HAA on the primary node, take the following steps:
install-haa.sh
script for advanced configuration (this does not create any cluster), keeping in mind that all locations must be different.
For example:
sudo ./install-haa.sh --install-dir /opt/haa-uipath --config-dir /etc/opt/haa-uipath --var-dir /var/opt/haa-uipath
.
Double-check the selected installation path. Moving an installation from one location to another post-installation is not supported.
After installing the primary node, take the following steps on each secondary node:
The following parameters are available when running the HAA installation script:
Parameter |
Decription |
---|---|
|
The username of the HAA cluster administrator. For example
-u documentation@uipath.com .
|
|
The password for the administration user, set when installing the primary node. For example
-p SuperSecret_Password .
|
|
The IP address of the primary node. When provided, a secondary (slave) node is installed. For example
-j 10.10.22.10 .
|
|
Indicate the path to the HAA installation directory (only when running the
install-haa.sh script for advanced installation).
Note: Double-check the selected installation path. Moving an installation from one location to another post-install is not supported.
|
|
Indicate the path to the HAA configuration directory (only when running the
install-haa.sh script for advanced installation).
|
|
Indicate the path to the HAA variables directory (only when running the
install-haa.sh script for advanced installation).
|
|
Used to display the installation help guide. |
|
The license code for your HAA cluster. Please enter the license without the starting and trailing
--- LICENSE START --- or --- LICENSE END --- and without any new line characters.
|
|
Accept the UiPath license agreement |
|
For offline installation. It assumes the package is in the current folder, same as the installation script. The link for the
package can be found in the
get-haa.sh script.
|
This step is required only if you use HAA for standalone Orchestrator.
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" />
<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" />
This step is required only if you use HAA for Automation Suite.
fabric.redis
section in the cluster_config.json
file. For more details, see High Availability Add-on configuration.
After you have installed all nodes of your HAA cluster, confirm the successful configuration as follows:
To add or update your High Availability Add-on license, take the following steps:
-
Using your browser, navigate 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. - Enter the username and password provided during installation to log in.
- Select the settings > general tab.
- In the Cluster key field, enter your license key.
- Click Save.