Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Validating the prerequisites

Verify if your multi-node HA-ready production environment meets the requirements before installing Automation Suite using the dedicated scripts.

Before installing Automation Suite, it is good practice to validate the installation prerequisites and infrastructure readiness. You can use the dedicated script to evaluate your environment and generate a summary before performing the installation.

Using the script to validate installation prerequisites


Downloading the script

📘

Offline installations

For offline installations, you must perform this step on a machine with access to internet and to the air-gapped machines where Automation Suite is deployed. Copy the file from the online machine to the first target machine.

The prerequisite script is packaged along with the installer in an archive called sf-installer.zip, and supporting tools are bundled as sf-infra.tar.gz for offline only. You need these files to generate a report on all the machines on which you plan to install Automation Suite.

Install Type

Files to Download

Online

sf-installer.zip - Mandatory. For download instructions, see sf-installer.zip.

Offline

sf-installer.zip - Mandatory. For download instructions, see sf-installer.zip.
sf-infra.tar.gz - Mandatory. For download instructions, see sf-infra.tar.gz.

Preparing to use the script

  1. Become root by running the following command:
sudo su -
  1. Copy the files to the /opt/UiPathAutomationSuite/{version} folder by running the following command:
VERSION="" #add the version number you are trying to install. Ex: for 2022.4.0 Set VERSION="2022.4.0"

mkdir -p /opt/UiPathAutomationSuite/${VERSION}

# For below command replace the /path/to where actually the files are present.

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

# Additionally for offline, copy sf-infra.tar.gz as well to /opt/UiPathAutomationSuite/{VERSION} folder

cp /path/to/sf-infra.tar.gz /opt/UiPathAutomationSuite/${VERSION}

cd /opt/UiPathAutomationSuite/${VERSION}
  1. Unzip the package by running the following command:
unzip sf-installer.zip -d installer
  1. Assign the necessary permissions and navigate to the script folder by running the following command:
chmod -R 755 installer
cd installer

Script parameters

To view the help section and supported flags, run the following command:

./validateUiPathASReadiness.sh --help
Click here to see the output.
***************************************************************************************

validateUiPathASReadiness.sh Runs pre-install validation checks

Arguments:
 -i|--input                                             Specify cluster config json file
 -m|--machines                                          Comma separated IP address / hostnames of all the machines
 -n|--node-type                                         Possible values [server|agent|task-mining|gpu]. Defaults to server
 --install-type                                         Possible values [online|offline]. Defaults to online
 --install-standalone-aicenter                          Run checks for standalone aicenter service only
 --prereq-bundle </uipath/sf-infra.tar.gz>   Specify the path to the prereq bundle, only for offline installation
 --prereq-tmp-folder </uipath>                          Specify parent directory for the temporary install folder, only for offline installation
 -h|--help                                              Display help

***************************************************************************************

The following table describes the parameters you can use when running the script:

Parameter

Description

-i|--input

Accepts the cluster_config.json file as input. This file defines the parameters, settings, and preferences applied to the UiPath services deployed via Automation Suite. For details, see Advanced Installation Experience.

If you do not provide this file, the script will trigger the interactive experience to collect these inputs. The file will then be generated on your behalf.

-m|--machines

Accepts comma-separated IP address / hostnames of all the machines. This is required to check the connectivity between all the nodes on the required port.

The parameter is mandatory for multi-node HA-ready production installations. In addition to that, the parameter is also required if you plan to add a Task Mining or GPU node in a single-node evaluation cluster.

-n|--node-type

Accepts the type of the current node. Possible values are: server, agent, task-mining, and gpu.
The default value is server.

--install-type

Accepts the installation method: online or offline.
The default value is online.

--install-standalone-aicenter

This is a Boolean flag. Pass it if you plan to install standalone AI Center.

--prereq-bundle

Accepts the absolute path where the sf-infra.tar.gz is located.

--prereq-tmp-folder

Accepts the absolute path where sf-infra.tar.gz bundle will be temporarily extracted. If this path is not provided, the installer will select the /tmp folder.

 

Validating a multi-node HA-ready production setup

On the first server machine

  1. To validate the first server machine, run the following command:

Online

./validateUiPathASReadiness.sh \
  --node-type server \ 
  --install-type online \ 
  --machines "10.0.1.8, 10.0.1.9" #replace with actual machine IPs of all the nodes in cluster

Offline

./validateUiPathASReadiness.sh \
  --node-type server \ 
  --install-type offline \ 
  --prereq-bundle ../sf-infra.tar.gz \ 
  --prereq-tmp-folder /opt/UiPathAutomationSuite/tmp \
  --machines "10.0.1.8, 10.0.1.9" #replace with actual machine IPs of all the nodes in cluster

Once this script is executed, it generate sa cluster_config.json file under the /opt/UiPathAutomationSuite folder. This file is required on all the other machines.

  1. To copy the cluster_config.json file on the other machines, run the following command:
scp /opt/UiPathAutomationSuite/cluster_config.json <username>@<node dns>:/opt/UiPathAutomationSuite

📘

Tip

If you cannot copy the file to the /opt/UiPathAutomationSuite folder due to permission errors, you can temporarily copy it to /var/tmp on the new machines, and then move it to /opt/UiPathAutomationSuite.

Alternatively, you can also provide full access permissions (777) to the /opt/UiPathAutomationSuite folder on the new machines, by running the following command: chmod -R 777 /opt/UiPathAutomationSuite.

On the other server machines

To validate the other server machines, run the following command:

Online

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type server \ 
  --install-type online \ 
  --machines "10.0.1.8, 10.0.1.9" #replace with actual machine IP of all the nodes in cluster

Offline

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type server \ 
  --install-type offline \
  --prereq-bundle ../sf-infra.tar.gz \ 
  --prereq-tmp-folder /opt/UiPathAutomationSuite/tmp \
  --machines "10.0.1.8, 10.0.1.9" #replace with actual machine IP of all the nodes in cluster

On agent machines

To validate the agent machines, run the following command:

Online

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type agent \
  --install-type online \
  --machines "10.0.1.8, 10.0.1.9" # replace with actual machine IP of all the nodes in cluster

Offline

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type agent \
  --install-type offline \ #replace with offline for airgap
  --prereq-bundle ../sf-infra.tar.gz \ 
  --prereq-tmp-folder /opt/UiPathAutomationSuite/tmp \
  --machines "10.0.1.8, 10.0.1.9" # replace with actual machine IP of all the nodes in cluster

On Task Mining machines & GPU machines

To validate the Task Mining & GPU machines, run the following command:

📘

Note:

For Task Mining and GPU nodes, use --node-type task-mining and --node-type gpu, respectively, in the following commands.

Online

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type task-mining \ #replace with GPU for GPU node
  --install-type online \
  --machines "10.0.1.8, 10.0.1.9" # replace with actual machine IP of all the nodes in cluster

Offline

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type task-mining \ #replace with GPU for GPU node
  --install-type offline \ 
  --prereq-bundle ../sf-infra.tar.gz \ 
  --prereq-tmp-folder /opt/UiPathAutomationSuite/tmp \
  --machines "10.0.1.8, 10.0.1.9" # replace with actual machine IP of all the nodes in cluster

Updated 2 months ago


Validating the prerequisites


Verify if your multi-node HA-ready production environment meets the requirements before installing Automation Suite using the dedicated scripts.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.