- Overview
- Requirements
- Installation
- Q&A: Deployment templates
- Configuring the machines
- Configuring the external objectstore
- Configuring an external Docker registry
- Configuring the load balancer
- Configuring the DNS
- Configuring Microsoft SQL Server
- Configuring the certificates
- Online multi-node HA-ready production installation
- Offline multi-node HA-ready production installation
- Disaster recovery - Installing the secondary cluster
- 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
- Adding a dedicated agent Node for Task Mining
- Connecting Task Mining application
- 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 manually set the ArgoCD log level to Info
- How to generate the encoded pull_secret_value for external registries
- 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
- GPU node affected by resource unavailability
- Volume unable to mount due to not being ready for workloads
- Support bundle log collection failure
- 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
- Issues accessing the ArgoCD read-only account
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- 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
- Running High Availability with Process Mining
- Process Mining ingestion failed when logged in using Kerberos
- Unable to connect to AutomationSuite_ProcessMining_Warehouse database using a pyodbc format connection string
- Airflow installation fails with sqlalchemy.exc.ArgumentError: Could not parse rfc1738 URL from string ''
- How to add an IP table rule to use SQL Server port 1433
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
Manual: Multi-node HA-ready production profile requirements and installation
This page walks you through the requirements and installation instructions for the multi-node HA-ready production profile.
Before you begin, consider the following:
- 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.
- Before choosing your deployment profile, see Supported use cases for single-node and multi-node installations.
- The installation process generates self-signed FIPS 140-2-compatible certificates on your behalf. These certificates will expire in 90 days, and you must replace them with certificates signed by a trusted Certificate Authority (CA) as soon as installation completes. If you do not update the certificates, the installation will stop working after 90 days. For instructions, see Managing certificates.
- 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.
- Automation Suite supports Federal Information Processing Standard 140-2 (FIPS 140-2). You can perform a clean installation
of Automation Suite on a FIPS 140-2-enabled host. You can also enable FIPS 140-2 on a machine where you previously performed
an Automation Suite installation. For details, see Security and compliance.
Note:
Insights is currently not supported on FIPS-enabled hosts. Make sure to disable Insights when installing Automation Suite on a FIPS-enabled host.
- 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.
|
Deployment profile |
Prerequisites |
Requirements |
Configuration |
Installation |
|---|---|---|---|---|
|
Multi-node HA-ready production profile |
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 | N/A | |||
|
TLS 1.2+ |
N/A | |||
|
IPv4 Important:
IPv6 is not supported. | N/A | N/A | ||
|
Trusted TLS, token-signing and SQL connection encryption certificates | N/A | |||
|
Load balancer | N/A | |||
|
Proxy server (optional) | N/A | |||
|
Kerberos authentication (optional) |
N/A | |||
|
External objecstore (optiona) |
N/A | |||
|
External Docker registry (optional) |
N/A |
RHEL kernel version kernel-4.18.0-477.10.1.el8_8 is affected by an issue that interrupts the installation or management of the Automation Suite cluster. Make sure that none of the Automation Suite nodes uses this kernel version either pre- or post-installation. You can update the kernel version by running the following command:
dnf install -y kernel kernel-tools kernel-tools-libsdnf install -y kernel kernel-tools kernel-tools-libs- 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 multi-node HA-ready production profile, you must meet the following hard requirements for the Complete product selection. If you want to check the hardware requirements for individual products, see Capacity planning.
General requirements
|
Hardware |
Minimum requirement |
|---|---|
|
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 |
|
Minimum processor per node |
8 (v-)CPU/cores |
|
RAM total |
192 GiB |
|
Minimum RAM per node |
16 GiB |
|
Cluster binaries and state disk for each node |
256 GiB SSD Min IOPS: 1100 |
|
Block storage |
512 GiB SSD Min IOPS: 1100 |
|
etcd disk for each server node |
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 |
|
Objectstore* |
512 GiB SSD Min IOPS: 1100 |
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.
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 classification and extraction 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 Understanding 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.
For details on the hardware requirements your must meet to install individual products or various product combinations in Automation Suite, use the Automation Suite Install Sizing Calculator.
Before starting the Automation Suite manual 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 (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.
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.3 includes Podman 1.6 by default, which may cause installation issues. To prevent this, update Podman to version 3.2.3.
RHEL 8.4 and later have the required RPM packages in the BaseOS and AppStream repositories by default.
For details on how to install the required RPM packages, see Configuring the machines.
The installation requires an external SQL server as a prerequisite.
Microsoft SQL Server 2016, 2017, 2019, and 2022 Standard and Enterprise editions are supported.
The minimum hardware requirements for Microsoft SQL Server are:
- 8 (v-)CPU
- 32 GiB RAM
- 256 GiB SSD
To configure an Active/Passive deployment, make sure you meet the following requirements:
- Hardware
- Load balancers
- DNS
- Certificates
- Objectstore
- Traffic Manager
Both Automation Suite clusters must meet a set of software and hardware requirements. For details, see Multi-node HA-ready production requirements.
Both Automation Suite clusters must have a load balancer. For details, see Configuring the Load balancer.
For details of the DNS requirements, see Configuring the DNS.
For details of the certificate requirements, see Certificate requirements.
You must also add the SANs to the certificate if you opened the DNS.
