Terminology

---

To find out more about the core concepts used in an Automation Suite deployment, see Glossary.

 

Product selection

---

The default installation experience includes a choice of two product selections:

• Complete (All products) – Install the complete list of products available in Automation Suite. For details, see Automation Suite products.
• Select products – Allows you to select and install only the products you are interested in. Note, however, that the installer takes the cross-product dependencies into consideration. That means that if a product requires the installation of another product, you must install both of them. For details, see Cross-product dependencies.

📘

Note:

You can enable additional products later in the same deployment at any point in time, after the initial installation, without having to reinstall. For details, see Managing products.

We recommend validating the hardware requirements based on expected usage and ensuring the deployment has enough capacity before adding additional products. For details, see Capacity planning.

 

Choose your deployment profile

---

You can deploy Automation Suite in either single-node evaluation or multi-node HA-ready production mode. While most of the prerequisites for the two profiles are identical, multi-node HA-ready production mode requires additional resources.

Once the deployment starts, you cannot switch or upgrade from one deployment profile to another. Before choosing your deployment profile, see Supported use cases for single-node and multi-node installations.

🚧

Important!

Linux and Kubernetes knowledge is required regardless of the deployment profile you choose. If you encounter issues installing and configuring Automation Suite, contact UiPath Professional Services.

 

Deployment profiles at a glance

---

The following table describes the prerequisites both single-node evaluation profile and multi-node HA-ready production profile must meet. Profile-specific prerequisites are marked accordingly.

🚧

Important!

You need root permission to install and deploy Automation Suite.
For more on the specific components that require root access, see Root privileges requirement.

---

Having scan agents running on your system may cause installation or runtime failures, due to the changes they make to the IPTables. To avoid this behavior, configure your scan agent so that it does not interfere with the Automation Suite installation.

 

Hardware requirements

---

The following sections list out the hardware requirements for both the Complete product selection and individual products.

Complete product selection: hardware requirements

---

🚧

Important!

Federal Information Processing Standard (FIPS) is not compatible with Automation Suite. If FIPs is enabled at any point on the servers running Automation Suite, the cluster will fail. If FIPs is enabled on any cluster server, the installer will encounter issues blocking the installation.

---

The minimum hardware requirements do not protect the deployment from node failures.

---

The multi-node HA-ready production profile is resilient to only one node failure. This means that you can lose only one server node. This restriction does not apply to agent nodes. You can lose as many agent nodes and still continue to use the cluster without downtime as long as enough overall cluster capacity is available.
You can increase the server node tolerance to failure by following the instructions in Advanced installation experience.

The following sections describe the hard requirements for the Complete product selection.

General requirements

¹ If you are using UiPath Apps, your CPU must have AVX support.
² The data disk is used as a block store.
³ This refers to the in-cluster objectstore and is not applicable if you use external objectstore.

📘

If you install Automation Suite in single-node evaluation mode, and you do not have a machine with 32 (v-)CPU/cores and 64 GiB of RAM, you can bring machines with a minimum of 8 (v-)CPU/cores and 16 GiB of RAM. For more details, see Capacity calculator.
If you choose this option, follow the multi-node installation and configuration instructions.

add saying example for installing a complete suite you can bring 1 server node and 4 agent nodes of 8vCPU and 16GB each.

---

To install the Complete product selection in single-node evaluation mode, you can bring 1 server node and 4 agent nodes of 8(v-)CPU and 16GiB each.

---

It is recommended to bring external objectstore whenever possible. This helps in scaling the objectstore independently of the cluster, and brings additional stability. We support the following objectstore options:

• Azure storage account
• AWS S3 storage bucket
• S3 compatible storage bucket

Additional Task Mining requirements

Task Mining requires an additional agent node that must meet the following requirements:

Additional Automation Suite Robots requirements

In multi-node HA-ready production environments, Automation Suite Robots require an additional agent node. In single-node evaluation environments, an additional Automation Suite Robots node is optional.

The hardware requirements for the Automation Suite Robots node depend on the way you plan to use your resources. In addition to the additional agent node requirements, you also need a minimum of 10 GB to enable package caching.

The following sections describe the factors that impact the amount of hardware the Automation Suite Robots node requires.

Robot size

The following table describes the required CPU, memory, and storage for all robot sizes.

Agent node size

The resources of the Automation Suite Robots agent node have an impact on the number of jobs that can be run concurrently. The reason is that the number of CPU cores and the amount of RAM capacity are divided by the CPU/memory requirements of the job.

For example, a node with 16 CPUs and 32 GB of RAM would be able to run any of the following:

• 32 Small jobs
• 16 Standard jobs
• 8 Medium jobs
• 2 Large jobs

Job sizes can be mixed, so at any given moment, the same node could run a combination of jobs, such as the following:

• 10 Small jobs (consuming 5 CPUs and 10 GB of memory)
• 4 Standard jobs (consuming 4 CPUs and 8 GB of memory)
• 3 Medium jobs (consuming 6 CPUs and 12 GB of memory)

Kubernetes resource consumption

Given that the node is part of a Kubernetes cluster, the Kubernetes agent present on the server (kubelet) consumes a small amount of resources. Based on our measurements, the kubelet consumes the following resources:

• 0.6 CPU
• 0.4 GB RAM

A node similar to the one previously described would actually have approximately 15.4 CPUs and 31.6 GB of RAM.

Additional Document Understanding recommendations

For increased performance, you can install Document Understanding on an additional agent node with GPU support. Note, however, that Document Understanding is fully functional without the GPU node. Actually, Document Understanding uses CPU VMs for all its extraction and classification tasks, while for OCR we strongly recommend the usage of a GPU VM. Here you can find more information about the CPU/GPU usage within the Document Understand framework.

If you want to use an additional node with GPU support, you must meet the following requirements:

For more details, see AI Center considerations.

Additional UiPath Apps recommendations

If you are using UiPath Apps, your CPU must have AVX support. For more information, check the official MongoDB documentation.

 

Individual products: hardware requirements

This section lists the minimum hardware requirements for a successful Automation Suite deployment. The minimum hardware requirements for your deployment are the sum of the requirements for the shared suite capabilities and the individual products you install.

🚧

Aside from meeting the minimum hardware requirements listed in this section, it is highly recommended to have a 20% buffer.

The following table lists the requirements for the shared suite capabilities:

The following table lists the requirements for individual products:

¹ For large robot deployments, you need to increase your Orchestrator HPA capacity. For an over 100.000-robot deployment, we recommend at least 20 pods.

 

RPM package requirements

---

Before starting the Automation Suite installation, you must ensure you meet the following requirements:

• you have a RHEL subscription;
• you enabled the BaseOS and AppStream repositories;
• you installed the required RPM packages.

The following table lists the required RPM packages:

📘

RHEL 8.3 includes Podman 1.6 by default, which may cause installation issues. To prevent this, update Podman to version 3.2.3.
RHEL 8.4 and later have the required RPM packages in the BaseOS and AppStream repositories by default.

Manual installations

If you perform a manual clean installation of Automation Suite, you must ensure you meet the RPM package requirements. In this case, you are responsible for installing the required RPM packages.

If you upgrade from a previous Automation Suite version, you have already installed the RPM packages.

For details on the tools you can use to install and validate RPM packages, see the following:

• Configuring the machines in single-node evaluation mode
• Configuring the machines in multi-node HA-ready production mode

Cloud templates

If you install Automation Suite using our Azure, AWS, or GCP templates, no action is needed from your side. The templates provision the full infrastructure, including the RPM packages.

 

Microsoft SQL Server general requirements

---

The installation requires an external SQL server as a prerequisite. Microsoft SQL Server 2016, 2017, and 2019 Standard and Enterprise editions are supported.

Additional Microsoft SQL platforms, such as Azure SQL Database or Azure SQL Managed Instance, as well as Amazon Relational Database Service are also supported as long as the Microsoft SQL Server database engine meets the requirements.

📘

Note:

Make sure that the SQL server can be accessed from each cluster VM.

🚧

SQL Server version compatibility and prerequisites:

Individual product support varies.

For each product you plan to deploy, you must:

• check the supported version of SQL Server as required by the product;
• apply the SQL Server configuration prerequisites, including SQL Server User permission, as required by the product.

For more information on product-specific SQL Server requirements, see SQL Server configuration for single-node evaluation profile and SQL Server configuration for multi-node HA-ready production profile.

The general minimum hardware requirements for Microsoft SQL Server are as follows:

• 8 (v-)CPU
• 32 GiB RAM
• 256 GiB SSD

These minimum requirements are general guidance and do not guarantee reliable operation in a production deployment. Capacity planning is required to determine the hardware requirements that are needed for reliable operation.

🚧

SQL Server capacity planning:

For each product you plan to deploy, you must evaluate projected usage and apply the capacity planning guidance as specified by the product. This information is available in the help section of each individual product.

📘

Note:

See Configuring Microsoft SQL Server for additional hardware requirements and recommendations for setting up a Microsoft SQL Server database machine for Process Mining.

 

NFS Server general requirements

---

To enable a backup, an external NFS server is required.

📘

Note:

Make sure that the NFS server can be accessed from each cluster VM.

The general minimum hardware requirements for NFS Server are as follows: