automation-suite

2022.10

false

Automation Suite Installation Guide

Last updated Nov 21, 2024

Hardware and software requirements

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

Deployment profile	Prerequisites	Installation
Single-node profile: supported only for evaluation and demo scenarios, not for production deployments	One Linux machine with supported RHEL version and ipcalc tool installed. For details about RHEL compatibility with Automation Suite versions, see RHEL compatibily matrix. Additional Linux machine is required when using Task Mining Additional Linux machine is optional when using Automation Suite Robots Additional Linux machine with GPU support is recommended when using Document Understanding Note: We support new minor versions of RHEL within 90 days of their release. We support SELinux with default policies.	AWS deployment template GCP deployment template Azure deployment template
	Microsoft SQL Server (2016, 2017, 2019, 2022 - Standard and Enterprise editions) 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. An additional Microsoft SQL Server is recommended for Process Mining.
	DNS
	TLS 1.2+
	IPv4 Important: IPv6 is not supported.
	Trusted TLS, token-signing and SQL connection encryption certificates
	Proxy server (optional)
	Kerberos authentication (optional)
Multi-node HA-ready profile: the only configuration supported for production deployments	Minimum 3 Linux machines with supported RHEL version and ipcalc tool installed. For details about RHEL compatibility with Automation Suite versions, see RHEL compatibily matrix. Additional Linux machine is required when using Task Mining Additional Linux machine is optional when using Automation Suite Robots Additional Linux machine with GPU support is recommended when using Document Understanding Note: We support new minor versions of RHEL within 90 days of their release. We support SELinux with default policies.	AWS deployment template GCP deployment template Azure deployment template
	Microsoft SQL Server (2016, 2017, 2019, 2022 - Standard and Enterprise editions) 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. An additional Microsoft SQL Server is recommended for Process Mining.
	DNS
	TLS 1.2+
	IPv4 Important: IPv6 is not supported.
	Trusted TLS, token-signing and SQL connection encryption certificates
	Load balancer
	Proxy server (optional)
	Kerberos authentication (optional)

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.
Cilium requires CAP_SYS_ADMIN permissions to function correctly. Make sure these permissions are granted.
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.
UiPath does not prescribe specific firewall or developer tool configurations as long as the Automation Suite requirements are met. Based on our observations, a limited number of external tools can interfere with the smooth operation of Automation Suite. If such issues arise, contact the relevant vendor for help. For additional guidance, see the Automation Suite responsibility matrix.

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

Hardware for all products	Single-node minimum requirement	Multi-node minimum requirements
Processor¹ per cluster	32 (v-)CPU/cores	96 (v-)CPU/cores
Minimum processor per node	N/A	8 (v-)CPU/cores
RAM	64 GiB	192 GiB
Minimum RAM per node	N/A	16 GiB
Cluster binaries and state disk for each node²	256 GiB SSD Min IOPS: 1100	256 GiB SSD Min IOPS: 1100
Data disk³	512 GiB SSD Min IOPS: 1100	512 GiB SSD Min IOPS: 1100
etcd disk for server node	16 GiB SSD Min IOPS: 240	16 GiB SSD Min IOPS: 240
UiPath bundle disk (For offline installation only, on one of the server nodes)	512 GiB SSD Min IOPS: 1100	512 GiB SSD Min IOPS: 1100
Objectstore⁴	512 GiB SSD Min IOPS: 1100	512 GiB SSD Min IOPS: 1100

¹ If you are using UiPath Apps, your CPU must have AVX support.

² The cluster disks capacity may need to be increased based on your AI Center ML skills and training storage requirements.

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

Note:

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.

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:

Hardware	Minimum requirement
Processor	20 (v-)CPU/cores
RAM	60 GiB
Cluster binaries and state disk	256 GiB SSD Min IOPS: 1100
Data disk	N/A

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

Size	CPU	Memory	Storage
Small	0.5	1 GiB	1 GiB
Standard	1	2 GiB	2 GiB
Medium	2	4 GiB	4 GiB
Large	6	10 GiB	10 GiB

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 GiB 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 GiB of memory)
4 Standard jobs (consuming 4 CPUs and 8 GiB of memory)
3 Medium jobs (consuming 6 CPUs and 12 GiB 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 GiB RAM

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

Automatic machine size selection

All your cross-platform processes have the Automation Suite Robots option set to Automatic by default. This setting selects the appropriate machine size for running the process using serverless robots.

When automatically choosing the size, the criteria listed in the below table are evaluated in order. As soon as one criterion is satisfied, the corresponding machine size is chosen and the remaining criteria are not evaluated.

Order	Criterion	Machine size
1	Remote debugging job	Medium
2	Process depends on UI Automation OR Process depends on the UiPath Document Understanding activities	Standard
3	Other unattended process	Small

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:

Hardware	Minimum requirement
Processor	8 (v-)CPU/cores
RAM	52 GiB
Cluster binaries and state disk	256 GiB SSD Min IOPS: 1100
Data disk	N/A
GPU RAM	11 GiB

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.

Important: 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:

Layer	Single-node evaluation profile		Multi-node HA-ready production mode
Layer	CPU	RAM	CPU	RAM
Shared suite capabilities	9.5 (v-)CPU	16.4 GiB	40 (v-)CPU	47.6 GiB

The following table lists the requirements for individual products:

Product	Single node-evaluation mode		Multi-node HA-ready production mode
Product	CPU	RAM	CPU	RAM
Action Center	0.7 (v-)CPU	2.1 GiB	2 (v-)CPU	4.7 GiB
AI Center	2 (v-)CPU	6.5 GiB	5.5 (v-)CPU	14 GiB
Apps	2.8 (v-)CPU	7.2 GiB	7.25 (v-)CPU	18.5 GiB
Automation Hub	0.5 (v-)CPU	1.4 GiB	2 (v-)CPU	3.5 GiB
Automation Ops	0.2 (v-)CPU	0.7 GiB	1 (v-)CPU	1.7 GiB
Automation Suite Robots	0.5 (v-)CPU	0.7 GiB	1 (v-)CPU	1.5 GiB
Data Service	0.2 (v-)CPU	0.5 GiB	0.5 (v-)CPU	1 GiB
Document Understanding	3.2 (v-)CPU	4 GiB	6.7 (v-)CPU	8.6 GiB
Insights	0.3 (v-)CPU	1.7 GiB	1.5 (v-)CPU	5 GiB
Orchestrator¹	1 (v-)CPU	2.6 GiB	3.5 (v-)CPU	7.2 GiB
Process Mining	2.2 (v-)CPU	12 GiB	5.1 (v-)CPU	24 GiB
Task Mining	4 (v-)CPU	5 GiB	8.4 (v-)CPU	10 GiB
Test Manager	0.5 (v-)CPU	1 GiB	1 (v-)CPU	2 GiB

¹ 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:

RPM package	Description
`iscsi-initiator-utils nfs-utils rpcbind util-linux nmap-ncat openssl httpd-tools gettext zstd`	Required on nodes for installation.
`podman>=4.0.2 nmap-ncat bind-utils openssl wget unzip conmon=>2.0.24`	Required on nodes for the execution of the readiness check.
`ansible zip unzip`	Required on the orchestration node for the execution of the `uipathctl.sh` functionality requiring Ansible.
`iscsi-initiator-utils gettext nfs-utils rpcbind util-linux nmap-ncat openssl httpd-tools podman=>4.0.2 zstd`	Required for offline installations only.

Note:

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:

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

Note: Unless otherwise specified in the dedicated requirements sections, these requirements are applicable to all Automation Suite products.

The installation requires an external SQL server as a prerequisite. Microsoft SQL Server 2016, 2017, 2019, and 2022 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.

Important:

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.

Important: 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. Automation Suite supports NFSv4 on Linux.

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:

CPU	RAM	Disk
4 (v-)CPU	8 GiB	2 TiB SSD (1100 IOPS)

RHEL compatibily matrix

The following table lists the RHEL versions supported by each version of Automation Suite:

Automation Suite version	Supported RHEL versions
2022.10.14	8.6, 8.8, 8.9, 8.10, 9.2, 9.4
2022.10.13	8.6, 8.8, 8.9, 8.10, 9.2
2022.10.12	8.6, 8.8, 8.9
2022.10.11	8.6, 8.8, 8.9
2022.10.10	8.6, 8.8, 8.9
2022.10.9	8.6, 8.8
2022.10.8	8.6, 8.8
2022.10.7	8.6, 8.8
2022.10.6	8.6
2022.10.5	8.6
2022.10.4	8.6
2022.10.3	8.6
2022.10.2	8.6
2022.10.1	8.6
2022.10.0	8.6

On this page

Terminology
Product selection
Choose your deployment profile
Deployment Profiles at a Glance
Hardware Requirements
Complete Product Selection: Hardware Requirements
Individual Products: Hardware Requirements
RPM package requirements
Manual installations
Cloud templates
Microsoft SQL Server general requirements
NFS Server general requirements
RHEL compatibily matrix

Was this page helpful?

PREVIOUSCertificates overview

NEXTEvaluating your storage needs

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy