- Overview
- Requirements
- Installation
- Post-installation
- Cluster administration
- Managing products
- Managing the cluster in ArgoCD
- Setting up the external NFS server
- Automated: Enabling the Backup on the Cluster
- Automated: Disabling the Backup on the Cluster
- Automated, Online: Restoring the Cluster
- Automated, Offline: Restoring the Cluster
- Manual: Enabling the Backup on the Cluster
- Manual: Disabling the Backup on the Cluster
- Manual, Online: Restoring the Cluster
- Manual, Offline: Restoring the Cluster
- Additional configuration
- Migrating objectstore from persistent volume to raw disks
- 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
- Automation Suite not working after OS upgrade
- Automation Suite Requires Backlog_wait_time to Be Set 1
- Volume unable to mount due to not being ready for workloads
- RKE2 fails during installation and upgrade
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- 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
- Cannot Log in 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 With Error: An Invalid Status Code Was Supplied (Client's Credentials Have Been Revoked).
- Alarm Received for Failed Kerberos-tgt-update Job
- SSPI Provider: Server Not Found in Kerberos Database
- Login Failed for User <ADDOMAIN><aduser>. Reason: The Account Is Disabled.
- 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
- After the Initial Install, ArgoCD App Went Into Progressing State
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unexpected Inconsistency; Run Fsck Manually
- Degraded MongoDB or Business Applications After Cluster Restore
- Missing Self-heal-operator and Sf-k8-utils Repo
- Unhealthy Services After Cluster Restore or Rollback
- RabbitMQ pod stuck in CrashLoopBackOff
- 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
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. 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 |
|
|
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.
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 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.
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 | |
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 | |
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 |
16 GiB |
10 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.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.6 | 8.6 |
| 2022.4.5 | 8.6 |
| 2022.4.4 | 8.6 |
| 2022.4.3 | 8.6 |
| 2022.4.2 | 8.6 |
| 2022.4.1 | 8.6 |
| 2022.4.0 | 8.6 |
- Terminology
- Product Selection
- Choose Your Deployment Profile
- Deployment Profiles at a Glance
- Evaluation or Demo Purposes — Single-node Evaluation Profile Hardware Requirements
- Production Deployment — Multi-node HA-ready Production Profile Hardware Requirements
- Microsoft SQL Server General Requirements
- NFS Server General Requirements
- RHEL compatibily matrix
