Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Hardware and software requirements

This page helps you install Automation Suite and its full set of capabilities.

Terminology


  • A node refers to any machine (bare metal, virtual machine, etc.).

  • A Kubernetes cluster is a set of nodes that run containerized applications.

  • A server node is defined as a machine (bare-metal or virtual) running the cluster management server.

  • An agent node is defined as a machine running the worker pods (the functional services). A machine can be designated to be used as both server and agent. Having separate server and agent nodes in a deployment is a topology design decision.

  • Offline (aka Air-gapped) environment refers to a set-up where the machines do not have access to the internet.

 

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.

Product Complete Basic
Orchestrator
Action Center
Test Manager
Insights
Automation Hub
Automation Ops
Data Service
Apps
AI Center
Document Understanding
Task Mining

📘

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 evaluation profile One Linux machine (RHEL 8.2, 8.3, 8.4, 8.5)
  • Additional Linux machine is required when using Task Mining
  • Additional Linux machine with GPU support is recommended when using Document Understanding
  • Microsoft SQL Server (2016, 2017, 2019 – 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+
Trusted TLS, token-signing and SQL connection encryption certificates
Proxy server
(optional)
Kerberos authentication
(optional)
Multi-node HA-ready production profile Minimum 3 Linux machines (RHEL 8.2, 8.3, 8.4, 8.5)
  • Additional Linux machine is required when using Task Mining
  • Additional Linux machine with GPU support is recommended when using Document Understanding
  • Microsoft SQL Server (2016, 2017, 2019 – 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+
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.

 

Evaluation or demo purposes — Single-node evaluation profile hardware 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 2 TiB 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
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
(strongly recommended)
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.

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 16 (v-)CPU/cores 16 (v-)CPU/cores
RAM total 192 GiB 96 GiB
Minimum RAM per node 32 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 2 TiB 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
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
(strongly recommended)
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

📘

Optimal node size

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


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.

 

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:

  • 4 (v-)CPU
  • 16 GiB RAM
  • SSD disk size greater than or equal to the data disk SSD of the server

Updated 2 days ago


Hardware and software requirements


This page helps you install Automation Suite and its full set of capabilities.

Suggested Edits are limited on API Reference Pages

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