Overview

Before installing Automation Suite, it is good practice to validate the installation prerequisites and infrastructure readiness. You can use the validateUiPathASReadiness.sh 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.

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

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

validateUiPathASReadiness.sh Runs pre-install validation checks

Usage:
  validateUiPathASReadiness.sh [command]
  validateUiPathASReadiness.sh [flags]

Available Commands:
  validate-packages                                     Validate that required packages are installed
  install-packages                                      Install required packages. If --install-type offline, this will also install offline required packages

Arguments:
 -i|--input                                             Specify cluster config json file. Defaults to /opt/UiPathAutomationSuite/cluster_config.json
 -d|--debug                                             Debug mode to get additional details helpful for debugging
 -m|--machines                                          Comma separated IP address / hostnames of all the machines
 -n|--node-type                                         Possible values [server|agent|taskmining|asrobots|gpu]. Defaults to server
 --install-type                                         Possible values [online|offline]. Defaults to online
 --prereq-bundle </uipath/offline_bundle.tar.gz>        Specify the path to the prereq bundle
 --prereq-tmp-folder </uipath>                          Specify parent directory for the temporary install folder
 --kubeconfig                                           Specify path to the kubeconfig file
 -h|--help                                              Display help

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

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

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 specialized agent node used for Task Mining, GPU, or Automation Suite Robots, 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:

Make sure to use the suitable parameter to identify your specialized agent node:

• for Task Mining machines, use --node-type task-mining
• for GPU machines, use --node-type gpu
• For Automation Suite Robots machines, use --node-type asrobots

Online

./validateUiPathASReadiness.sh \
  --input /opt/UiPathAutomationSuite/cluster_config.json \
  --node-type task-mining \ #replace with gpu for GPU node or asrobots for Automation Suite Robots node
  --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 task-mining \ #replace with gpu for GPU node or asrobots for Automation Suite Robots 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