Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Offline multi-node installation

This page explains how you can perform an offline Automation Suite installation with a multi-node setup.

Overview


🚧

Important!

Hardware and software prerequisites must be completed before proceeding with the installation.
Hardware and software requirements

Use the offline installation steps in this document when deploying UiPath Automation suite in a airgapped environment with no access to the internet.

The installation process has the following general steps:

Step

Description

Step 1: Download the installation packages

This step needs to be performed from a machine with access to internet and to the air-gapped machines where Automation Suite will be deployed. While these are finishing downloading, you can continue to some of the next steps.

This can be done from a Linux or windows machine.

Step 1.1: Downloading the installation package
Step 1.2: Getting all downloaded files on the first machine

Step 2: Configure the installation

Run the interactive install wizard to configure the installation options

The tool will gather inputs for most common install options and generate a configuration file that will be used during the installation.

Configure advanced install options (Optional)

The default install configuration includes the products used in core automation and a shared SQL server to be used by all products. To customize the products installed or have separate SQL servers used for specific products you can do so by editing the configuration file.

Step 2.1: Basic configuration
Step 2.2: (Optional) Advanced configuration

Step 3: Copy the installation files on all the machines

On the first machine, copy the downloaded files in the installation folder created by the installation wizard at step 2.
On the other cluster machines, copy the entire installation folder from the first machine to the same folder path on each machine.

Step 3: Copy the installation files on all the machines

Step 4: Run the installation

Create the cluster and join all machines

From the first machine install the rest of the suite.

Step 4: Running the installation

Step 5: Installation complete

You have completed the installation successfully.
To access the newly created cluster and suite, see Accessing Automation Suite. At this point, you can explore post-installation configuration options.

 

Blue background steps are performed on the machine with internet access.
Green background steps are performed on the machines where the installation suite is being deployed.

 

Step 1: Downloading the installation package and getting all the files on the first machine


Step 1.1: Downloading the installation package

This step needs to be run on a machine with internet access and access to the machines in the air-gapped environment where UiPath Automation suite will be installed.

📘

Note:

This machine can be Linux or Windows. The commands in this guide are for RHEL-based OS. For Windows or other OSes, adjust for equivalent commands specific to those environments.

 

For Linux machines
 
  • The first step is to get the required files to start the install process and trigger the download of the installation bundles.
  • Connect to a machine with internet access and run command to get the interactive wizard file:
  • ssh <user>@<dns_of_vm>
  • If you used an ssh key:
  • ssh -i <path/to/Key.pem> <user>@<dns_of_vm>
  • Download the required packages (please keep the ' (single quotes) around the link):
  • sudo yum install wget -y
    wget -O ~/installUiPathAS.sh 'https://download.uipath.com/automation-suite/installUiPathAS.sh'
    wget -O ~/sf-installer.zip 'https://download.uipath.com/automation-suite/installer.zip'
    wget -O ~/sf.tar.gz 'https://download.uipath.com/automation-suite/sf.tar.gz'
    wget -O ~/sf-infra.tar.gz 'https://download.uipath.com/automation-suite/sf-infra-only.tar.gz'
    The sf.tar.gz and sf-infra.tar.gz files may take some time to download as they are large in size.
     
  • (Optional) To use Document Understanding, download the following bundles:
  • wget -O ~/du-ondemand.tar.gz 'https://download.uipath.com/automation-suite/du.tar.gz'
    wget -O ~/du2110-ondemand.tar.gz 'https://download.uipath.com/automation-suite/du2110.tar.gz'
    Note: Not following this optional step prevents access to the Document Understanding services.
  • (Optional) To use Computer Vision, download the following bundle:
  • wget -O ~/cv-ondemand.tar.gz 'https://download.uipath.com/automation-suite/cv.tar.gz'
    Note: Not following this optional step prevents access to the Computer Vision services.
 
For Windows machines
 

Download the packages from the links below:


 
Go to the first target machine for installation
 
  • Run the following command:
  • ssh <user>@<dns_of_vm>
  • If you used an ssh key, run the following command:
  • ssh -i <path/to/Key.pem> <user>@<dns_of_vm>

 

Step 1.2: Getting all downloaded files on the first machine

  • Check that all files finished downloaded on the machine with internet access
  • Create the target folder on the first machine
  • Copy the files from the online machine to the first target machine
ON ALL THE MACHINES IN THE CLUSTER
 
Create the installation folders
 
  • Run the following commands:
  • sudo su -
    mkdir -p /opt/UiPathAutomationSuite/
    chmod -R 777 /opt/UiPathAutomationSuite
    mkdir -p /uipath/tmp
    chmod -R 777 /uipath/tmp
ON THE SEPARATE MACHINE WITH INTERNET ACCESS
 
Copy the files to the first node
 
  • From the machine with internet access, copy the files to the installation folder on the target machine, and the offline bundle(s) to the /uipath/tmp folder.
  • scp ~/installUiPathAS.sh ~/sf-installer.zip ~/sf-infra.tar.gz <username>@<node dns>:/uipath/tmp
    scp ~/sf.tar.gz <username>@<node dns>:/uipath/tmp/
  • (Optional) To use Document Understanding, copy the following bundles to the /uipath/tmp folder.
  • scp ~/du-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    scp ~/du2110-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    Note: Not following this optional step prevents access to the Document Understanding services.
  • (Optional) To use Computer Vision, copy the following bundle to the /uipath/tmp folder.
  • scp ~/cv-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    Note: Not following this optional step prevents access to the Computer Vision services.

 

Step 2: Configuring the installation


Step 2.1: Basic configuration

ON THE MAIN MACHINE OF THE CLUSTER
 
Add prerequisites folder to the current PATH
 
  • The interactive installer requires jq and our offline bundles already includes it. Run the following commands to add it to PATH: (make sure you are still root)
  • mv /uipath/tmp/installUiPathAS.sh /uipath/tmp/sf-installer.zip /uipath/tmp/sf-infra.tar.gz  /opt/UiPathAutomationSuite
    cd /opt/UiPathAutomationSuite
    unzip ./sf-installer.zip -d .
    chmod +x ./bin/jq
    export PATH=${PATH}:/opt/UiPathAutomationSuite/bin
Provide permissions to Installer Folder
 
  • It is required to give adequate permissions to the /opt/UiPathAutomationSuite folder where the install scripts are placed and going to be executed.
    Installer will also create some files (output.json) after execution of each stage.
    Run the following command to provide the permissions:
  • chmod -R 755 /opt/UiPathAutomationSuite
Run the interactive install wizard to configure the install options
 
  • Interactive wizard will guide through the configuration steps and generate the config which can be then customized and used through the remaining install steps.
Run the script to begin interactive wizard
  • Run the following command
  • chmod +x ./installUiPathAS.sh
    ./installUiPathAS.sh
Follow the steps in the wizard
Screen-by-screen sequence
  • Enter the option for multi-node.

  •  
  • Enter option for air-gapped:

  •  
  • Specify the URL for the cluster (DNS hostname/load balancer URL in multi-node) and the SQL Server information as shown below:

  •  
  • Config will be generated with a folder as shown in the following image.

  •  
As soon as you generate the configuration file and the folder, you can exit the wizard and proceed with the remaining steps below to complete installation.

 

Step 2.2: (Optional) Advanced configuration

By running the installation using the default configuration, you are opting to run our default experience. You will install our core platform, Orchestrator, Insights, Action Center, Test Manager, Automation Ops, Apps, and Automation Hub.

You can configure the file for more advanced configurations. You can enable additional products, disable any of the default products, configure your SQL DBs and their respective connection strings, and certificates. For multi-node, we enable High Availability by default - you can disable.

For advanced configuration, you can follow the following instructions: Advanced installation experience.

 

Step 3: Copying the installation files on all the other cluster machines


From the first machine in the cluster, where the configuration was performed, copy the entire install folder to all other machines.

ON THE FIRST MACHINE IN THE CLUSTER
 
  1. Copy the /opt/UiPathAutomationSuite folder to all other nodes by running:
  2. scp -r /opt/UiPathAutomationSuite <username>@<node dns>:/opt
    🛈 Since we are in an air-gapped environment, you might need to use the private IP of the target node.

  3. Add -i <cert.pem> if you are using a certificate to login. If you copy the .pem contents to a local file, the new file will need to have correct permissions. You can do chmod 400 <cert.pem> for granting them.

📘

Note:

The step above ensures the same configuration is replicated on all machines along with all the downloaded packages for the install bundle.

 

Step 4: Running the installation


There are two types of machines: server and agent.

  • Server - Machines on which kubernetes infrastructure (i.e apiserver, etcd) runs on. These components manage the entire cluster.
  • Agent - vanilla version of machine that is used to run workloads

Multi-node requires a minimum of 3 server machines. Installing Task Mining requires adding an additional machine that is used as an agent.

📘

Note:

For multi-node installation you need a load balancer. Please make sure one was created and traffic is distributed between nodes. The domain name of the load balancer needs to be used in the cluster-config.json file.

You need to have at least a server node and for HA you need at least 3 server nodes. An odd number of server nodes is required.

Step 4.1: Accepting the license agreement

Before running the installation, please read the License Agreement.
In order to accept the license agreement, choose one of the following methods:

  • Option 1 (Environment Variable)
  • Set the LICENSE_AGREEMENT environment variable to accept by executing the following command:
    export LICENSE_AGREEMENT=accept
  • Option 2 (Inline parameter)
  • Alternatively, append --accept-license-agreement to every execution of install-uipath.sh.

 

Step 4.2: Creating and joining all machines to the cluster

Set up the primary machine
 
  • Execute the following commands on the primary server:
  • cd /opt/UiPathAutomationSuite
    ./install-uipath.sh -i ./cluster_config.json -o ./output.json -k --offline-bundle ./sf-infra.tar.gz --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement

 
Join the rest of the servers to the cluster:
 
  • Execute the following commands on the rest of the server nodes:
  • cd /opt/UiPathAutomationSuite
    sudo chmod -R 755 /opt/UiPathAutomationSuite
    sudo ./install-uipath.sh -i ./cluster_config.json -o ./output.json -k -j server --offline-bundle ./sf-infra.tar.gz --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement

 
Join the rest of the agents to the cluster:
 
  • Execute the following commands on the rest of the agent nodes:
  • cd /opt/UiPathAutomationSuite
    sudo chmod -R 755 /opt/UiPathAutomationSuite
    sudo ./install-uipath.sh -i ./cluster_config.json -o ./output.json -k -j agent --offline-bundle ./sf-infra.tar.gz --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement

 

Step 4.3: Finishing installing the suite

Once all nodes are joined, switch to the primary server to finish the Automation Suite install:
 
  • Check if the nodes were properly added

  • sudo su
    export KUBECONFIG=/etc/rancher/rke2/rke2.yaml PATH=$PATH:/var/lib/rancher/rke2/bin
    kubectl get nodes
  • You should see more than one node in the list if all was well.

  •  
  • Execute the following command to finish the installation:
  • cd /opt/UiPathAutomationSuite
    ./install-uipath.sh -i ./cluster_config.json -o ./output.json -f -s --offline-bundle /uipath/tmp/sf.tar.gz --offline-tmp-folder /uipath/tmp --accept-license-agreement
  • This is the most time consuming operation. Expect it to take ~2h.
 
Loading the optional bundles commands
 
  • To load the optional Document Understanding bundles, execute the following commands:
  • ./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/du-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
    ./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/du2110-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
    
  • To load the optional Computer Vision bundle, execute the following command:
  • ./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement

 

Installing AI center
 
Please note, if you only installed AI Center, we recommend resizing the PVC to 200 immediately after the installation to avoid downtimes. For more information on this, check Resizing PVC for AI Center.

 

Step 5: Installation complete


📘

Note:

You have completed the installation successfully.

To access the newly created cluster and suite, see Accessing Automation Suite.

Updated 29 days ago


Offline multi-node installation


This page explains how you can perform an offline Automation Suite installation with a multi-node setup.

Suggested Edits are limited on API Reference Pages

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