automation-suite
2022.4
false
UiPath logo, featuring letters U and I in white

Automation Suite Installation Guide

Last updated Dec 16, 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. If you want to install a different combination of products, make sure to review the Cross-product dependencies page.

Note:

Product

Complete

Basic

Orchestrator

available

available

Action Center

available

available

Test Manager

available

available

Insights

available

available

Automation Hub

available

available

Automation Ops

available

available

Data Service

available

available

Apps

available

not available

AI Center

available

not available

Document Understanding

available

not available

Task Mining

available

not available

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

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.

Once the deployment starts, you cannot switch/upgrade from one deployment profile to another.

Before choosing your deployment profile, see Supported use cases for single-node and multi-node installations.

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

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

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

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

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.

Evaluation or Demo Purposes — Single-node Evaluation Profile 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.

If you opt for the single-node evaluation profile, you must meet the following hard requirements:

Single-node evaluation profile

(supported only for evaluation and demo purposes)

Selection

Complete

Basic

Processor

32 (v-)CPU/cores

16 (v-)CPU/cores

RAM

64 GiB

32 GiB

Cluster binaries and state disk for each node

256 GiB SSD

Min IOPS: 1100

256 GiB SSD

Min IOPS: 1100

Data disk for server node

512 GiB SSD

Min IOPS: 1100

512 GiB SSD

IOPS: 1100

etcd disk for server node

16 GiB SSD

Min IOPS: 240

16 GiB SSD

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

Additional agent node for Task Mining (required)

Processor

20 (v-)CPU/cores

N/A

(Task Mining is not present in this selection)

RAM

60 GiB

Cluster binaries and state disk

256 GiB SSD

Min IOPS: 1100

Data disk

N/A

Additional agent node with GPU support for Document Understanding

Processor

8 (v-)CPU/cores

N/A

(AI Center is not present in this selection)

RAM

52 GiB

Cluster binaries and state disk

256 GiB SSD

Min IOPS: 1100

Data disk

N/A

GPU RAM

11 GiB

Production Deployment — Multi-node HA-ready Production Profile Hardware Requirements

Important:

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

To understand your storage needs and plan for them accordingly, see Evaluating your storage needs.

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.

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.

If you opt for the multi-node HA-ready production profile, you must meet the following hard requirements:

Multi-node HA-ready production profile

(the only configuration supported for production deployments)

Selection

Complete

Basic

Node count

At least 3 server nodes.

There must be an odd number of server nodes in a cluster to have increased fault tolerance.

There is no limit on the number of agent nodes

Processor

96 (v-)CPU/cores

48 (v-)CPU/cores

Minimum processor per node

32 (v-)CPU/cores

16 (v-)CPU/cores

RAM total

192 GiB

96 GiB

Minimum RAM per node

64 GiB

32 GiB

Cluster binaries and state disk for each node

256 GiB SSD

Min IOPS: 1100

256 GiB SSD

Min IOPS: 1100

Data disk for each server node

512 GiB SSD

Min IOPS: 1100

512 GiB SSD

Min IOPS: 1100

etcd disk for each 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

Additional agent node for Task Mining (required)

Processor

20 (v-)CPU/cores

N/A

(Task Mining is not present in this selection)

RAM

60 GiB

Cluster binaries and state disk

256 GiB SSD

Min IOPS: 1100

Data disk

N/A

Additional agent node with GPU support for Document Understanding

Processor

8 (v-)CPU/cores

N/A (AI Center is not present in this selection)

RAM

52 GiB

Cluster binaries and state disk

256 GiB SSD

Min IOPS: 1100

Data disk

N/A

GPU RAM

11 GiB

Note: Larger node sizes are more efficient than smaller node sizes because of the fixed baseline resource overhead per node. For example, 3 x 32 cores nodes is more efficient than 6 x 16 cores nodes.

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.

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.

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

16 GiB

10 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.4.14

8.6, 8.8, 8.9

2022.4.13

8.6, 8.8, 8.9

2022.4.12

8.6, 8.8, 8.9

2022.4.11

8.6, 8.8, 8.9

2022.4.10

8.6, 8.8

2022.4.9

8.6, 8.8

2022.4.8

8.6, 8.8

2022.4.7

8.6

2022.4.68.6
2022.4.58.6
2022.4.48.6
2022.4.38.6
2022.4.28.6
2022.4.18.6
2022.4.08.6

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.