Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Online multi-node HA-ready production installation

This page explains how you can perform an online Automation Suite installation with a multi-node HA-ready production setup.

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

These steps help you install the Automation Suite across multiple machines. Internet access is required for this installation mode.

The installation process has the following general steps:

StepDescription
Step 1: Download the installation packagesYou need to perform this step from a machine with access to the internet where you plan to deploy Automation Suite. While the installation packages finish downloading, you can continue to some of the next steps.
Step 1: Download the installation script and run interactive installer
Step 2: Configure the installation Step 2.1: Run the interactive installer to configure the installation options
The tool gathers inputs for most common options and generates a configuration file.
Step 2.1: Default configuration

Step 2.2: (Optional) Configure advanced installation options
The default installation configuration includes a shared SQL server to be used by all products. To customize the installed products or have separate SQL servers used for specific products, edit the configuration file.
Step 2.2: (Optional) Advanced configuration
Step 3: Complete the installation Step 3: 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 3: Completing the installation

 

Step 1: Downloading the installation script and run the interactive installer


You need to perform this step on the machine with internet access where you plan to install Automation Suite. While the installation packages finish downloading, you can continue with the next steps.

📘

Note:

The Automation Suite installer is a wrapper of multiple packages that also installs some dependencies using Red Hat Package Manager (RPM). It provides an interactive experience that helps you configure external resources such as SQL and other installation options.

To copy the interactive installer to the target machine, take the following steps:

  1. Connect to the first machine using SSH.

If you set a password, 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>
  1. Become root:
sudo su -
  1. Move to home directory:
cd ~
  1. Download the installUiPathAS.sh installer. For instructions, see installUiPathAS.sh. Make sure to download the package suitable for your Automation Suite version.

  2. Install unzip and jq:

yum install unzip jq -y

 

Step 2: Configuring the installation


Run the installer on the first server only:

chmod +x ~/installUiPathAS.sh
./installUiPathAS.sh

Step 2.1: Default configuration

Run the interactive installer to configure the installation options. The tool gathers inputs for the most common installation options and generates a configuration file. High Availability is enabled by default, but you can disable it using the advanced configuration.

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

1530
  1. In Deployment configuration select your environment type. Choose Online.

  2. Choose your product selection. Your options are:

    • Complete (All products)
    • Select products

📘

For details on the product selection options, see Hardware and software requirements.

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

In addition to that, Task Mining and Automation Suite Robots require an additional agent node in a multi-node setup. An additional agent node with GPU support is also recommended for Document Understanding. For details, see:

  1. To install AI Center, you must follow additional steps:
    7.1. Specify whether AI Center requires an external Orchestrator.
       If AI Center does not require an external Orchestrator, continue to Step 8.
       If AI Center requires an external Orchestrator, continue to Step 7.2.
    7.2. Copy the Orchestrator certificate to the virtual machine. For more information on this, check the Copy the Orhcestrator certificate page.
    7.3. Specify the Orchestrator URL for AI Center. Example: https://orchestrator.example.com.
    7.4. Specify the Identity URL for AI Center. Example: https://orchestrator.example.com/identity.
    7.5. Specify the path to the Orchestrator certificate file. Example: /opt/UiPathAutomationSuite/UiPath_Installer/orch.cer.
    7.6. Specify the path to Identity certificate file. Example: /opt/UiPathAutomationSuite/UiPath_Installer/identity.cer.
    7.7. Specify the metering API key.

📘

Note:

  • metering_api_key is the Document Understanding or AI Units API key from the AI Center cloud account.
  • To complete the AI Center installation, follow the step from the Completing AI Center installation section.
  1. Confirm your product selection to determine the minimum hardware and software requirements.

  2. Enter the Automation Suite FQDN.

  3. 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:
      • If Yes, provide the Azure storage account name and endpoint suffix, and your client ID;
      • 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.

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

  2. Enter the SQL Server URL. Follow the prompt to enter the connection port, username, and password.

📘

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.

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

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

📘

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.

  1. After defining the parameters, the installer autogenerates the configuration. You can edit the configuration parameters directly in the terminal.

📘

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.

For details, see Advanced configuration step.

  1. Wait for the process to complete. At this point, you should have the first node set up.

  2. To continue with the multi-node HA-ready production installation, run the command provided by the interactive installer on all the nodes in the terminal in sequence, and specify the agent or server for each node being joined.

📘

You can also add additional nodes post-installation. For details, see Adding a new node to the cluster.

  1. Once all the machines are joined, run the following command on the first server to complete the installation of the services:
1222

📘

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 configuration file in the installation folder.

You can use this file for more advanced settings. You can 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 advanced configuration, refer to Advanced installation experience.

📘

Note:

If you exit the interactive installer and perform advanced configuration, you need to re-run the interactive installer for the installation to be complete.

 

Step 3: 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.

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.

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 9 days ago


Online multi-node HA-ready production installation


This page explains how you can perform an online Automation Suite installation with a multi-node HA-ready production setup.

Suggested Edits are limited on API Reference Pages

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