Validating the Prerequisites in a Single-node Evaluation Setup

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

Note: 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.

Installation 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 -

2. 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}

3. Unzip the package by running the following command:

   unzip sf-installer.zip -d installer

4. 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

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 Single-node Evaluation Setup

Online

To validate a single-node evaluation machine, run the following command:

./validateUiPathASReadiness.sh \
  --node-type server \ # replace server with task-mining, gpu if you wish to install.
  --install-type online

Offline

To validate a single-node machine, run the following command:

./validateUiPathASReadiness.sh \
  --node-type server \
  --install-type offline \
  --prereq-bundle ../sf-infra.tar.gz \ 
  --prereq-tmp-folder /opt/UiPathAutomationSuite/tmp

To validate a Task Mining or a GPU node, take the following steps:

1. Copy the cluster_config.json file generated on the server machine to all the agent machines:

   scp /opt/UiPathAutomationSuite/cluster_config.json <username>@<node dns>:/opt/UiPathAutomationSuite

   Note:

   If you are unable to copy the file to the /opt/UiPathAutomationSuite folder due to permission error, 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.

2. To validate the environment, run the following command on agent machines:

   Note: If you run the command on a Task Mining or GPU node, replace --node-type agent with --node-type task-mining or --node-type gpu, respectively.

Online

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type agent \ # replace agent with task-mining, gpu if you wish to install.
  --install-type online \ #replace with offline for airgap
  --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 \ # replace agent with task-mining, gpu if you wish to install.
  --install-type online \ #replace with offline for airgap
  --machines "10.0.1.8, 10.0.1.9" #replace with actual machine IP of all the nodes in cluster