Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Offline multi-node HA-ready production installation

This page provides instructions on how to install Automation Suite on multiple machines, in an offline environment with no access to the Internet.

Overview


🚧

Important!

You must meet the hardware and software prerequisites before proceeding with the installation.
Hardware and software requirements

You can use a dedicated script to validate the installation prerequisites and infrastructure readiness.
Validating the prerequisites

For a smooth installation experience, make sure to follow our best practices.
Installation best practices

The installation process has the following general steps:

StepDescription
Step 1: Download the installation packages You must perform this step from a Linux or Windows machine with access to the internet and to the offline machines where you plan to deploy Automation Suite. While the installation packages finish downloading, you can continue to some of the next steps.

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 installer to configure the installation options.
The tool gathers inputs for most common installation options and generates a configuration file that you can use during installation.

(Optional) Configure advanced installation options.
The interactive installer offers a default experience with a limited number of configuration options. To customize the installed products, set up separate SQL servers for specific products, and more, edit the configuration file.

Step 2.1: Default 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 interactive installer 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

Install the rest of the suite from the first machine.

Step 4: Running the installation
Step 5: Complete the installation Step 5: You have completed the installation successfully and can move to post-installation steps.
You can now access the newly created cluster and suite, update certificates, resize the PVC, and more.

Step 5: Completing the installation

 

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

You must perform this step on a machine with access to the internet and to the machines in the offline environment where you plan to install Automation Suite.

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

🚧

Important!

You must install the required RPM packages before launching the Automation Suite installer.
For details, see RPM package requirements.

 

ON THE SEPARATE MACHINE WITH INTERNET ACCESS

To get the installation packages required to start the installation process, take the following steps:

  1. Connect to a machine with internet access:
    ssh <user>@<dns_of_vm>

  2. If you used an SSH key, run the following command:
    ssh -i <path/to/Key.pem> <user>@<dns_of_vm>

  3. Download the following packages:
    • installUiPathAS.shMandatory. See installUiPathAS.sh for download instructions.
    • sf-installer.zipMandatory. See sf-installer.zip for download instructions.
    • sf.tar.gzMandatory. See sf.tar.gz for download instructions.
    • sf-infra.tar.gz - Mandatory. See sf-infra.tar.gz for download instructions.
    • du-ondemand.tar.gzOptional. Needed only for Document Understanding. See du-ondemand.tar.gz for download instructions.
      Note: Not following this optional step limits the functionality of the Document Understanding services.
    • cv-ondemand.tar.gzOptional. Needed only for Computer Vision. See cv-ondemand.tar.gz for download instructions.
      Note: Not following this optional step prevents access to the Computer Vision services.

    Make sure to download the packages suitable for your Automation Suite version and your operating system.

 

Step 1.2: Getting all downloaded files on the first machine

  • Check that all files 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 by running the following command:

sudo su -
mkdir -p /opt/UiPathAutomationSuite/
chmod -R 777 /opt/UiPathAutomationSuite
mkdir -p /uipath/tmp
chmod -R 777 /uipath/tmp
Note: Running mkdir -p /opt/UiPathAutomationSuite/ is not required if you use the configureUiPathDisks.sh script.
ON THE SEPARATE MACHINE WITH INTERNET ACCESS
 

Copy the files to the first node by taking the following steps:

  1. 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:
  2. scp ~/installUiPathAS.sh ~/sf-installer.zip ~/sf-infra.tar.gz <username>@<node dns>:/uipath/tmp
    scp ~/sf.tar.gz <username>@<node dns>:/uipath/tmp/
  3. (Optional) To use Document Understanding, copy the following bundle to the /uipath/tmp folder:
  4. scp ~/du-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    Note: Not following this optional step prevents access to the Document Understanding services.
     
  5. (Optional) To use Computer Vision, copy the following bundle to the /uipath/tmp folder:
  6. 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: Default configuration

ON THE MAIN MACHINE OF THE CLUSTER
 
  1. Add the prerequisites folder to the current PATH.
    The interactive installer requires jq, which the Automation Suite offline bundles already includes. To add jq to PATH, make sure you are still root and run the following command:
  2. 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

  3. Provide permissions to the interactive installer folder.
    It is required to give adequate permissions to the /opt/UiPathAutomationSuite folder where the installation scripts are placed and executed.
    The interactive installer also creates some files (output.json) after the execution of each stage.
    To provide the necessary permissions, run the following command:
  4. chmod -R 755 /opt/UiPathAutomationSuite

  5. Run the interactive installer to configure the installation options.
    The interactive installer guides you through the configuration steps and generates the configuation file that you can then customize and use through the remaining installation steps.

  6. To start the interactive installer, run the following script:
    chmod +x ./installUiPathAS.sh
    export BUNDLE_FILE="/opt/UiPathAutomationSuite/sf-installer.zip"
    ./installUiPathAS.sh


Running the interactive installer


Run the interactive installer to configure the installation options. The tool gathers inputs for most common installation options and generates a configuration file. Note that HAA is not supported in single-node evaluation mode.

To install Automation Suite, take the following steps:

  1. Start the interactive installer.

  2. Accept the license agreement to continue the installation.

  3. In Main Menu select your deployment mode. Choose Multi-node deployment (recommended for production use) and confirm your selection.

  4.  
  5. In Deployment configuration select your environment type. Choose Air-gapped.

  6. Choose your product selection. Your options are:
    • Complete (All products)
    • Select products

  7. If you chose Select products in the previous step, indicate the products you want to install. Your options are:
    • Action Center
    • AI Center
    • Apps
    • Automation Hub
    • Automation Ops
    • Automation Suite Robots
    • Data Service
    • Document Understanding
    • Insights
    • Orchestrator
    • Process Mining
    • Task Mining
    • Test Manager

    Some Automation Suite products have additional dependencies on each other. When selecting the products you want to install, make sure you consider Cross-products dependencies. Trying to install a product without its dependencies would result in an error.

    Some Automation Suite products require a dedicated agent node. Before continuing, make sure you meet the hardware requirements.


  8. To install AI Center, you must follow additional steps:
    1. Specify whether AI Center requires an external Orchestrator.
      1. If AI Center does not require an external Orchestrator, continue to Step 8.
      2. If AI Center requires an external Orchestrator, continue to Step ii.
    2. Copy the Orchestrator certificate to the virtual machine. For more information on this, check the Copy the Orchestrator certificate page.
    3. Specify the Orchestrator URL for AI Center. Example: https://orchestrator.example.com.
    4. Specify the Identity URL for AI Center. Example: https://orchestrator.example.com/identity.
    5. Specify the path to the Orchestrator certificate file. Example: /opt/UiPathAutomationSuite/UiPath_Installer/orch.cer.
    6. Specify the path to Identity certificate file. Example: /opt/UiPathAutomationSuite/UiPath_Installer/identity.cer.
    7. In offline installations, you do not need to specify the metering API key. To complete the AI Center installation, follow the step from the Completing AI Center installation section.


  9. Confirm your product selection to determine the minimum hardware and software requirements.

  10. Enter the Automation Suite FQDN.

  11. Specify whether you would like to bring your own object store for the selected products. If you select No, you opt for the default object store. If you select Yes, choose one of the following options:
    • Azure Storage Account – Indicate if you want to use managed identity-based with your Azure storage account, provide the following details corresponding to your choice, then specify if you want the containers to be automatically provisioned for all the selected products:
      1. If Yes, provide the Azure storage account name and endpoint suffix, and your client ID;
      2. If No, provide the Azure storage account name and endpoint suffix, and your Azure account key;
    • AWS S3 – Provide the prefix and suffix for the bucket names, the AWS region where buckets are hosted, the access key and the secret key for the S3 account, and specify if you want the buckets to be automatically provisioned for all the selected products.
    • Other S3 Compatible storage – Specify the prefix and suffix for the bucket names, the S3 server FQDN, the S3 port, the access key and the secret key for the S3 account, and specify if you want the buckets to be automatically provisioned for all the selected products.
    • Many S3 objectstores require the CORS set to all the traffic from the Automation Suite cluster. You must configure the CORS policy at the objectstore level to allow the FQDN of the cluster.


  12. Specify whether you want to use Kerberos Authentication for SQL connections.

  13. Enter the SQL Server URL. Follow the prompt to enter the connection port, username, and password.
  14. Process Mining requires a second SQL Server. If you install Process Mining, make sure to provide the warehouse SQL Server URL, connection prompt, username, and password.
    For details on the hardware requirements the second SQL Server must meet, see SQL requirements for Process Mining.


  15. Specify whether you want the interactive installer to automatically create the necessary databases.

  16. Provide CA certificates for any external software that requires a secure TLS communication, otherwise the installation will fail. If you did not enable the TLS communication, you can configure the certificates post-installation.
  17. The installer accepts only Base64-encoded DER certificates in `PEM` format. If the external servers have different CAs, you can concatenate all the public certificates in a single file.


  18. After defining the configuration parameters, the interactive installer autogenerates the configuration file. You can edit the configuration parameters directly in the terminal.
  19. At this step, you can directly edit the cluster_config.json for advanced configuration settings in the UiPathAutomationSuite folder. After you edit the configuration file, you need to re-run the interactive installer to complete the installation or complete it manually.

At the end of the installation process, you are prompted with a deployment summary that gives you access to the Cluster Administration portal, host portal, organization administration interface, Rancher, ArgoCD, and more.

 

Step 2.2: (Optional) Advanced configuration

You can find the cluster_config.json file in the UiPathAutomationSuite folder. You can use this file to disable products, configure your SQL databases and their respective connection strings, and update certificates. You can also enable proxy settings if you use a proxy for the internet connection.
For multi-node HA-ready production mode, we enable High Availability by default, but you can disable it if needed.

For advanced configuration, see 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 installation folder to all the other machines. This step ensures the same configuration and all the downloaded installation packaged are replicated on all machines.

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

  3. Add -i <cert.pem> if you use a certificate to login. If you copy the .pem contents to a local file, the new file requires the correct permissions. To grant the necessary permissions, run chmod 400 <cert.pem>.

 

Step 4: Running the installation


The multi-node HA-ready production mode requires a minimum of 3 server machines. Installing Task Mining or Automation Suite Robots requires adding an additional machine used as an agent. An additional agent node with GPU support is recommended for Document Understanding.

For details on adding a specialized agent node, see the following:

📘

Note:

For a multi-node HA-ready production installation, you need a load balancer. Make sure one was created, and traffic is distributed between nodes. The domain name of the load balancer must be used in the cluster_config.json file.

You need at least one server node; for HA, you need at least three server nodes. An odd number of server nodes is required.

Step 4.1: Accepting the license agreement

Before running the installation, make sure to read the License Agreement.
To accept the license agreement, choose one of the following methods:

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

 

Step 4.2: Creating and joining all machines to the cluster

  1. Set up the first machine.
    Execute the following commands on the first 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

  2. Join the rest of the servers to the cluster.
    Execute the following commands on the rest of the server nodes in sequence:
    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 /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement

  3. Join the rest of the agents to the cluster.
    Execute the following commands on the rest of the agent nodes in sequence:
    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 /opt/UiPathAutomationSuite/tmp --install-offline-prereqs --accept-license-agreement

 

Step 4.3: Finishing installing the suite

Once all nodes are joined, switch to the first server to finish the Automation Suite installation:
 
  1. Check if the nodes were properly added by running the following command:
    sudo su
    export KUBECONFIG=/etc/rancher/rke2/rke2.yaml PATH=$PATH:/var/lib/rancher/rke2/bin
    kubectl get nodes

  2. You should see more than one node in the list if all was well.

  3. Finish the installation by executing the following command:
    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
    Note: This is the most time-consuming operation. Expect it to take approximately two hours.
 

Loading the optional bundles
 
  • To load the optional Document Understanding bundle, run the following command:
  • ./configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/du-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp"

  • To load the optional Computer Vision bundle, run the following command:
  • ./configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp"

Completing AI Center installation
 

If AI Center requires an external Orchestrator, run the following command to complete the installation:

./configureUiPathAS.sh aicenter configure --installation-token <identity token>

For more information on how to configure Orchestrator for AI Center, check the Configuring Orchestrator page from the AI Center guide.

 

Step 5: Completing the installation


📘

Note:

You have completed the installation successfully, and you can now move to post-installation steps.

Updating certificates

🚧

Important!

The installation process generates self-signed certificates on your behalf. However, the Azure deployment template also gives you the option to provide a CA-issued server certificate at installation time instead of using an auto-generated self-signed certificate.

Self-signed certificates will expire in 90 days, and you must replace them with certificates signed by a trusted CA as soon as installation completes. If you do not update the certificates, the installation will stop working after 90 days.

For instructions, see Managing certificates.

Accessing Automation Suite

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

Resizing PVC

To resize the PVC, see Resizing PVC.

If you installed AI Center, we recommend resizing the PVC to 200 immediately after the installation to avoid downtime.

Updated about 15 hours ago


Offline multi-node HA-ready production installation


This page provides instructions on how to install Automation Suite on multiple machines, in an offline environment with no access to the Internet.

Suggested Edits are limited on API Reference Pages

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