- Overview
- Requirements
- Installation
- Q&A: Deployment templates
- Downloading the installation packages
- Install-uipath.sh Parameters
- Enabling Redis High Availability Add-On for the cluster
- Document Understanding configuration file
- Adding a dedicated agent node with GPU support
- Connecting Task Mining application
- Adding a dedicated agent Node for Task Mining
- Adding a Dedicated Agent Node for Automation Suite Robots
- Post-installation
- Cluster administration
- Monitoring and alerting
- Migration and upgrade
- Migration options
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone product database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the migrated product connection strings
- Step 6: Migrating standalone Insights
- Step 7: Deleting the default tenant
- B) Single tenant migration
- Product-specific configuration
- Best practices and maintenance
- Troubleshooting
- How to troubleshoot services during installation
- How to uninstall the cluster
- How to clean up offline artifacts to improve disk space
- How to clear Redis data
- How to enable Istio logging
- How to manually clean up logs
- How to clean up old logs stored in the sf-logs bucket
- How to disable streaming logs for AI Center
- How to debug failed Automation Suite installations
- How to delete images from the old installer after upgrade
- How to automatically clean up Longhorn snapshots
- How to disable TX checksum offloading
- How to address weak ciphers in TLS 1.2
- Unable to run an offline installation on RHEL 8.4 OS
- Error in Downloading the Bundle
- Offline installation fails because of missing binary
- Certificate issue in offline installation
- First installation fails during Longhorn setup
- SQL connection string validation error
- Prerequisite check for selinux iscsid module fails
- Azure disk not marked as SSD
- Failure after certificate update
- Antivirus causes installation issues
- Automation Suite not working after OS upgrade
- Automation Suite requires backlog_wait_time to be set to 0
- Volume unable to mount due to not being ready for workloads
- Unable to launch Automation Hub and Apps with proxy setup
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- Failure to resize PVC
- Failure to resize objectstore PVC
- Rook Ceph or Looker pod stuck in Init state
- StatefulSet volume attachment error
- Failure to create persistent volumes
- Storage reclamation patch
- Backup failed due to TooManySnapshots error
- All Longhorn replicas are faulted
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- Authentication not working after migration
- Kinit: Cannot find KDC for realm <AD Domain> while getting initial credentials
- Kinit: Keytab contains no suitable keys for *** while getting initial credentials
- GSSAPI operation failed due to invalid status code
- Alarm received for failed Kerberos-tgt-update job
- SSPI provider: Server not found in Kerberos database
- Login failed for AD user due to disabled account
- ArgoCD login failed
- Failure to get the sandbox image
- Pods not showing in ArgoCD UI
- Redis probe failure
- RKE2 server fails to start
- Secret not found in UiPath namespace
- ArgoCD goes into progressing state after first installation
- Unexpected inconsistency; run fsck manually
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- MongoDB Pod Fails to Upgrade From 4.4.4-ent to 5.0.7-ent
- Unhealthy services after cluster restore or rollback
- Pods stuck in Init:0/X
- Prometheus in CrashloopBackoff state with out-of-memory (OOM) error
- Missing Ceph-rook metrics from monitoring dashboards
- Pods cannot communicate with FQDN in a proxy environment
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
Automation Suite Installation Guide
Hardware and software requirements
To find out more about the core concepts used in an Automation Suite deployment, see Glossary.
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.
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.
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.
Note:
|
|
| ||
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.
Note:
|
|
| ||
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) |
- 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.
The following sections list out the hardware requirements for both the Complete product selection and individual products.
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 |
---|---|---|
Processor1 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 node2 |
256 GiB SSD Min IOPS: 1100 |
256 GiB SSD Min IOPS: 1100 |
Data disk3 |
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 |
Objectstore4 |
512 GiB SSD Min IOPS: 1100 |
512 GiB SSD Min IOPS: 1100 |
1 If you are using UiPath Apps, your CPU must have AVX support.
2 The cluster disks capacity may need to be increased based on your AI Center ML skills and training storage requirements.
3 The data disk is used as a block store.
4 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.
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
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.
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.
The following table lists the requirements for the shared suite capabilities:
Layer |
Single-node evaluation profile |
Multi-node HA-ready production mode | ||
---|---|---|---|---|
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 | ||
---|---|---|---|---|
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 |
Orchestrator1 |
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 |
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 |
---|---|
|
Required on nodes for installation. |
|
Required on nodes for the execution of the readiness check. |
|
Required on the orchestration node for the execution of the
uipathctl.sh functionality requiring Ansible.
|
|
Required for offline installations only. |
RHEL 8.4 and later have the required RPM packages in the BaseOS and AppStream repositories by default.
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:
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.
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.
To enable a backup, an external NFS server is required. Automation Suite supports NFSv4 on Linux.
The general minimum hardware requirements for NFS Server are as follows:
CPU |
RAM |
Disk |
---|---|---|
4 (v-)CPU |
8 GiB |
2 TiB SSD (1100 IOPS) |
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 |
- 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