- Overview
- Requirements
- Recommended: Deployment templates
- Manual: Preparing the installation
- Manual: Preparing the installation
- Step 1: Configuring the OCI-compliant registry for offline installations
- Step 2: Configuring the external objectstore
- Step 3: Configuring High Availability Add-on
- Step 4: Configuring Microsoft SQL Server
- Step 5: Configuring the load balancer
- Step 6: Configuring the DNS
- Step 7: Configuring the disks
- Step 8: Configuring kernel and OS level settings
- Step 9: Configuring the node ports
- Step 10: Applying miscellaneous settings
- Step 12: Validating and installing the required RPM packages
- Step 13: Generating cluster_config.json
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- External OCI-compliant registry configuration
- Disaster recovery: Active/Passive and Active/Active configurations
- High Availability Add-on configuration
- Orchestrator-specific configuration
- Insights-specific configuration
- Process Mining-specific configuration
- Document Understanding-specific configuration
- Automation Suite Robots-specific configuration
- Monitoring configuration
- Optional: Configuring the proxy server
- Optional: Enabling resilience to zonal failures in a multi-node HA-ready production cluster
- Optional: Passing custom resolv.conf
- Optional: Increasing fault tolerance
- install-uipath.sh parameters
- 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
- Step 15: Configuring the temporary Docker registry for offline installations
- Step 16: Validating the prerequisites for the installation
- Manual: Performing the installation
- Post-installation
- Cluster administration
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating objectstore from persistent volume to raw disks
- Migrating from in-cluster to external High Availability Add-on
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Migrating to an external OCI-compliant registry
- Switching to the secondary cluster manually in an Active/Passive setup
- Disaster Recovery: Performing post-installation operations
- Converting an existing installation to multi-site setup
- Guidelines on upgrading an Active/Passive or Active/Active deployment
- Guidelines on backing up and restoring an Active/Passive or Active/Active deployment
- Redirecting traffic for the unsupported services to the primary cluster
- Monitoring and alerting
- Migration and upgrade
- 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 Orchestrator
- Step 7: Migrating standalone Insights
- Step 8: Deleting the default tenant
- B) Single tenant migration
- Migrating from Automation Suite on Linux to Automation Suite on EKS/AKS
- Upgrading Automation Suite
- Downloading the installation packages and getting all the files on the first server node
- Retrieving the latest applied configuration from the cluster
- Updating the cluster configuration
- Configuring the OCI-compliant registry for offline installations
- Executing the upgrade
- Performing post-upgrade operations
- Product-specific configuration
- Using the Orchestrator Configurator Tool
- Configuring Orchestrator parameters
- Orchestrator appSettings
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- 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 disable TX checksum offloading
- How to upgrade from Automation Suite 2022.10.10 and 2022.4.11 to 2023.10.2
- How to manually set the ArgoCD log level to Info
- How to expand AI Center storage
- 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
- Volume unable to mount due to not being ready for workloads
- Support bundle log collection failure
- Test Automation SQL connection string is ignored
- Single-node upgrade fails at the fabric stage
- Cluster unhealthy after automated upgrade from 2021.10
- Upgrade fails due to unhealthy Ceph
- RKE2 not getting started due to space issue
- Volume unable to mount and remains in attach/detach loop state
- Upgrade fails due to classic objects in the Orchestrator database
- Ceph cluster found in a degraded state after side-by-side upgrade
- Unhealthy Insights component causes the migration to fail
- Service upgrade fails for Apps
- In-place upgrade timeouts
- Docker registry migration stuck in PVC deletion stage
- AI Center provisioning failure after upgrading to 2023.10 or later
- Upgrade fails in offline environments
- SQL validation fails during upgrade
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- Longhorn REST API endpoint upgrade/reinstall error
- Setting a timeout interval for the management portals
- 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
- Update the underlying directory connections
- 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
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unhealthy services after cluster restore or rollback
- Pods stuck in Init:0/X
- 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
- After Disaster Recovery Dapr is not working properly for Process Mining and Task Mining
- 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
- Running the 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:
- 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.
Prerequisite type |
Prerequisite |
---|---|
Hardware |
|
General machine requirements | |
Requirements specific to the following products:
| |
Supported RHEL version and ipcalc tool installed on all the Linux machines. For details about RHEL compatibility with Automation Suite versions, see RHEL compatibility matrix. Note:
We support new minor versions of RHEL within 90 days of their release. We support SELinux with default policies. | |
FIPS 140-2 | |
Load balancer L4 / Network Load Balancer | |
NFS server requirement (on-premises or cloud-managed NFS server with NFSv3/NFSv4 version on Linux based)
| |
Node ports | |
Software |
RPM packages on each machine |
SQL Server | |
Objectstore (Azure Blob storage, AWS S3, S3 compatible objectstore) | |
OCI-compliant registry | |
DNS | |
TLS 1.2+ | |
IPv4
(IPv6 is not supported) | |
Swap memory must be disabled. | |
|
- 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.
Before you begin, consider the following:
- 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.
- 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 list out the hardware requirements for both the Complete product selection and individual products.
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 |
---|---|---|
Processor 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 disks* |
256 GiB SSD Min IOPS: 1100 |
256 GiB SSD Min IOPS: 1100 |
Data disk
|
512 GiB SSD Min IOPS: 1100 |
512 GiB SSD Min IOPS: 1100 |
etcd disk
|
16 GiB SSD Min IOPS: 240 |
16 GiB SSD Min IOPS: 240 |
UiPath® bundle disk
|
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 |
*The cluster disks capacity may need to be increased based on your AI Center ML skills and training storage requirements.
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
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.
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
The following table describes the required CPU, memory, and storage for all robot sizes.
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 AI Center and Document Understanding requirements
On top of the core service requirements that are part of full platform requirements, AI Center requires additional resources, depending on the models that you want to run or train. For more details about the required GPU hardware generations and compatible NVIDIA drivers, refer to Compatibility Matrix.
AI Center requires disk storage at runtime for the ML Skills and for the training pipeline, as follows:
-
The ML Skills require disk space on the
/var/lib/rancher
partition for storing the trained model for predictions. In the worst case scenario, the model size can be as big as 20 GiB. -
The training pipeline consumes the storage from the
/var/lib/rancher
partition for hosting the model. In the worst case scenario, the model size can be as big as 20 GiB, and additionaly, it can require storage for the dataset. The minimum size of the dataset storage can be 51 GiB; its recommended size is 105 GiB. This must be on the dedicated disk for AI Center. The training pipeline only schedules on the node on which the dedicated AI Center disk is attached.
The following table describes the additional resources AI Center needs. In the following table, Data Disk is needed on all server nodes. Data Disk is not needed on agent nodes.
Use |
CPU |
RAM (GiB) |
GPU |
Disk (GiB) |
---|---|---|---|---|
Minimum for serving (ML Skill, one replica) |
0.6 |
2 |
0 |
|
Minimum for Training (Pipeline) |
1 |
4 |
0 |
|
DU model Serving (ML Skill, one replica) |
1 |
4 |
0 |
|
DU model Training |
2 |
24 |
Strongly recommended |
|
In the following table, Data Disk is needed on all server nodes. Data Disk is not needed on agent nodes.
Use |
CPU |
RAM (GiB) |
GPU |
Disk (GiB) |
---|---|---|---|---|
Small implementation:
|
4 |
32 |
0 |
|
Average implementation:
|
8 |
52 |
Strongly recommended |
|
rancher
partition = 80 GiB on the rancher
partition
2 1 pipeline * 105GiB = 105 Data disk
rancher
partition = 160 GiB on the rancher
partition
4 (2 pipeline + 1 DU pipeline) * 105GiB = 315 Data disk
Additional AI Computer Vision requirements
This setup works on on-premises Nvidia GPUs, but also works with cloud providers such as AWS, Azure and GCP. Suggested GPU types include those from the RTX, Tesla, and Ampere family of products which have enough GPU memory and processing capability.
The main difference between these two types of GPUs is that the ones with virtualization usually have more GPU RAM and are offered by most cloud providers. Having more GPU RAM increases the maximum size of the image you can input to the model. In conclusion, virtualization GPUs are not significantly faster that the consumer GPUs.
You need a machine with the following hardware specifications:
Hardware specification | Requirements |
---|---|
Memory |
|
CPU |
|
GPU |
|
Storage |
|
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.
For more details about the CPU/GPU usage within the Document Understanding framework, refer to CPU and GPU Usage.
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.
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 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 Validating and installing the required RPM packages.
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 Configuring Microsoft SQL Server.
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.
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.
To enable a backup, you need an external NFS server. Automation Suite supports Linux-based on-premises or cloud-managed NFS servers, version NFSv3/NFSv4.
The general minimum hardware requirements for NFS Server are as follows:
-
CPU - 4 vCPU
-
RAM - 8 GiB
-
Storage - 1 TiB
Note: If you use an external objectstore, the storage requirement is a few GiBs. If you use an in-cluster objectstore, the minimum storage size is the same as the size of the objectstore.
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 the hardware requirements for the multi-node mode.
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.
The following table lists the RHEL versions supported by each version of Automation Suite:
Automation Suite version |
Supported RHEL versions |
---|---|
2023.10.6 | 8.6, 8.8, 8.9, 8.10, 9.2, 9.4 |
2023.10.5 |
8.6, 8.8, 8.9, 8.10, 9.2 |
2023.10.4 |
8.6, 8.8, 8.9 |
2023.10.3 |
8.6, 8.8, 8.9 |
2023.10.2 |
8.6, 8.8, 8.9 |
2023.10.1 |
8.6, 8.8 |
2023.10.0 |
8.6, 8.8 |
- Terminology
- Product selection
- Choose your deployment profile
- Prerequisites 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
- Disaster recovery - Active/Passive requirements
- Hardware
- Load balancer
- DNS
- Certificates
- Objectstore
- RHEL compatibility matrix