- Overview
- Requirements
- Kubernetes cluster and nodes
- Proxy
- SQL database
- Caching
- Storage
- Certificate requirements
- Installation
- Prerequisite checks
- Downloading the installation packages
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster migration
- uipathctl cluster migration export
- uipathctl cluster migration import
- uipathctl cluster migration run
- uipathctl cluster upgrade
- uipathctl config
- uipathctl config add-host-admin
- uipathctl config additional-ca-certificates
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config argocd
- uipathctl config argocd ca-certificates
- uipathctl config argocd ca-certificates get
- uipathctl config argocd ca-certificates update
- uipathctl config argocd generate-dex-config
- uipathctl config argocd generate-rbac
- uipathctl config argocd registry
- uipathctl config argocd registry get
- uipathctl config argocd registry update
- uipathctl config enable-basic-auth
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config saml-certificates get
- uipathctl config saml-certificates rotate
- uipathctl config saml-certificates update
- uipathctl config tls-certificates
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl config token-signing-certificates
- uipathctl config token-signing-certificates get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- uipathctl health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test
- uipathctl manifest
- uipathctl manifest apply
- uipathctl manifest diff
- uipathctl manifest get
- uipathctl manifest get-revision
- uipathctl manifest list-applications
- uipathctl manifest list-revisions
- uipathctl manifest render
- uipathctl prereq
- uipathctl prereq create
- uipathctl prereq run
- uipathctl resource
- uipathctl resource report
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- uipathctl version
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite on EKS/AKS
- 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
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
Kubernetes cluster and nodes
You can bring your own Kubernetes cluster from Azure or AWS and follow your standard practices to provision and manage it. Automation Suite requires a dedicated cluster with cluster admin privileges because it deploys the entire UiPath® business platform, and it comprises many UiPath® products that include many micro-services.
Each Automation Suite Long-Term Support release comes with a compatibility matrix. For compatible EKS or AKS versions, see Compatibility matrix.
Automation Suite supports the following Linux OSes:
Cloud provider |
OS |
---|---|
AKS |
|
EKS |
|
To estimate node capacity based on your product and scale requirements, use the UiPath Automation Suite Install Sizing Calculator.
The root volume requirement for both EKS and AKS agent (worker) nodes is 256 GB.
At a minimum, to start with the mandatory platform services (Identity, licensing, and routing) and Orchestrator, you must provision 8 vCPU and 16 GB RAM per node.
We recommend enabling autoscaling on your cluster to ensure high reliability and to avoid business interruptions.
If you install Task Mining, you must provision additional worker node(s) with 20 vCPU and 60 GB RAM. This node must be tainted to ensure only Task Mining workloads run on it. For details, see the Node scheduling section.
Automation Suite Robots require additional worker node(s).
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.
For details, see Storage documenation.
The following sections describe the factors that impact the amount of hardware the Automation Suite Robots node requires.
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 |
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)
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.
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 |
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 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 |
--node-taints nvidia.com/gpu=present:NoSchedule
instead of --node-taints sku=gpu:NoSchedule
.
We recommend enabling node taints on dedicated worker nodes for Task Mining, Automation Suite Robots, and Document Understanding.
AI Center and DU example:
-
For CPU:
kubectl taint node <node_name> aic.ml/cpu=present:NoSchedule
kubectl taint node <node_name> aic.ml/cpu=present:NoSchedule
For GPU:
kubectl taint node <node_name> nvidia.com/gpu=present:NoSchedule
kubectl taint node <node_name> nvidia.com/gpu=present:NoSchedule
Task Mining example:
kubectl taint node <node_name> task.mining/cpu=present:NoSchedule
kubectl taint node <node_name> task.mining/cpu=present:NoSchedule
Automation Suite Robots example:
kubectl taint node <node_name> serverless.robot=present:NoSchedule
kubectl taint node <node_name> serverless.robot=present:NoSchedule
If you have custom node taints that are enforced by Gatekeeper Policy, such as specific roles for worker nodes or labels, they will not be passed to Automation Suite and may interrupt the installation process.
To learn about taints and tolerations, see Kubernetes documentation.
- Dedicated cluster
- Supported EKS/AKS versions
- Node capacity
- Autoscaling
- Additional Task Mining requirements
- Additional Automation Suite Robots requirements
- Robot size
- Agent node size
- Kubernetes resource consumption
- Automatic machine size selection
- Additional Document Understanding recommendations
- Node scheduling