- Overview
- Requirements
- Deployment templates
- Manual: Preparing the installation
- Manual: Preparing the installation
- Step 2: Configuring the OCI-compliant registry for offline installations
- Step 3: Configuring the external objectstore
- Step 4: Configuring High Availability Add-on
- Step 5: Configuring SQL databases
- Step 6: Configuring the load balancer
- Step 7: Configuring the DNS
- Step 8: Configuring the disks
- Step 9: Configuring kernel and OS level settings
- Step 10: Configuring the node ports
- Step 11: Applying miscellaneous settings
- Step 12: Validating and installing the required RPM packages
- Cluster_config.json Sample
- General configuration
- Profile configuration
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- ArgoCD configuration
- Kerberos authentication 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
- AI Center-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
- 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 Redis 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
- Scaling a single-node (evaluation) deployment to a multi-node (HA) deployment
- Monitoring and alerting
- Migration and upgrade
- Migrating standalone products to Automation Suite
- Step 1: Restoring the standalone product database
- Step 2: Updating the schema of the restored product database
- Step 3: Moving the Identity organization data from standalone to Automation Suite
- Step 4: Backing up the platform database in Automation Suite
- Step 5: Merging organizations in Automation Suite
- Step 6: Updating the migrated product connection strings
- Step 7: Migrating standalone Orchestrator
- Step 8: Migrating standalone Insights
- Step 9: Deleting the default tenant
- Performing a single tenant migration
- Migrating between Automation Suite clusters
- 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
- 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 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
- How to check the TLS version
- How to work with certificates
- How to schedule Ceph backup and restore data
- How to clean up unused Docker images from registry pods
- How to collect DU usage data with in-cluster objectstore (Ceph)
- How to install RKE2 SELinux on air-gapped environments
- 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
- 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
- Temporary registry installation fails on RHEL 8.9
- Frequent restart issue in uipath namespace deployments during offline installations
- DNS settings not honored by CoreDNS
- Unable to install temporary registry
- Data loss when reinstalling or upgrading Insights following Automation Suite upgrade
- Unable to access Automation Hub following upgrade to Automation Suite 2024.10.0
- Single-node upgrade fails at the fabric stage
- 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
- Upgrade fails due to overridden Insights PVC sizes
- Failure to upgrade to Automation Suite 2024.10.1
- Upgrade fails due to Velero migration issue
- Upgrade stuck on rook-ceph application deletion
- 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
- Robot cannot connect to an Automation Suite Orchestrator instance
- Partial failure to restore backup in Automation Suite 2024.10.0
- 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
- Pods stuck in Init:0/X
- Missing Ceph-rook metrics from monitoring dashboards
- Mismatch in reported errors during diagnostic health checks
- No healthy upstream issue
- Log streaming does not work in proxy setups
- Failure to add agent nodes in offline environments
- Node becomes unresponsive (OOM) during large Document Understanding bundle upload
- 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
- 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
- Automation Suite certificate is not trusted from the server where CData Sync is running
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
- Exploring summarized telemetry

Automation Suite on Linux installation guide
Before starting the Automation Suite Robot installation, make sure you meet the hardware requirements.
-
In a single-node evaluation installation, Automation Suite Robots run on the main server node. Cached packages are stored on the main node’s filesystem, in a folder that the interactive installer automatically provisions. Adding a dedicated agent node for Automation Suite Robots is optional in single-node evaluation installations.
Note: In a single-node evaluation installation, the number of concurrent serverless jobs is limited to 5. -
In a multi-node HA-ready production environment, adding a dedicated node for Automation Suite Robots is mandatory. For details on the requirements the dedicated node must meet, see Hardware and software requirements.
Note: In a multi-node HA-ready production installation, the maximum number of concurrent serverless jobs is determined by the node’s resources (CPU/memory). - A minimum of 10GB are required for package caching.
The following sections provide instructions on how to add a dedicated agent node for Automation Suite Robots.
Step 1: Configuring the Machine
Step 1.1: Partitioning the disk
To ensure the disk is partitioned correctly, see the instructions in Configuring the disks. Make sure to follow the steps for agent nodes.
Step 1.2: Configuring the disk for package caching
Option A
/uipath_asrobots_package_cache location or at the custom path configured via cluster_config.json/packagecachefolder. The folder must have at least 10GB of free space available, otherwise the installation will fail.
Option B
configureUiPathDisks script, which can configure the disk and the path:
./bin/uipathctl rke2 disk --robot-package-disk-name [DISKNAME] --robot-package-path /uipath_asrobots_package_cache./bin/uipathctl rke2 disk --robot-package-disk-name [DISKNAME] --robot-package-path /uipath_asrobots_package_cache--robot-package-path parameter is optional. If not set, the parameter defaults to /uipath_asrobots_package_cache.
cluster_config.json/packagecachefolder, make sure the value passed to the --robot-package-path parameter matches the configured value.
Step 1.3: Configuring the node for serverless robots
When configuring a node for serverless robots, the setup depends on how the node is added to the cluster:
Option A: Add a dedicated ASR node
If you add a new node to the cluster as a dedicated ASR node, the required labels and taints are automatically applied. Run the following command:
./bin/uipathctl rke2 install -i ./cluster_config.json -o ./output.json -k -j asrobots --accept-license-agreement./bin/uipathctl rke2 install -i ./cluster_config.json -o ./output.json -k -j asrobots --accept-license-agreement- taint:
serverless.robot=present:NoSchedule - labels:
serverless.robot=trueandserverless.daemon=true
Option B: Use an existing agent node
If you want to repurpose an already configured agent node (not configured by default as ASR), you must manually add the labels, taints, and configure the package cache disk. Run the following commands to configure the node manually:
-
Add a taint for serverless robots:
kubectl taint nodes [NODE_NAME] serverless.robot=present:NoSchedulekubectl taint nodes [NODE_NAME] serverless.robot=present:NoSchedule - Add the labels for serverless robots:
kubectl label nodes [NODE_NAME] serverless.robot=true serverless.daemon=truekubectl label nodes [NODE_NAME] serverless.robot=true serverless.daemon=true
Step 2: Copying the Interactive Installer to the Target Machine
To copy the interactive installer to the target machine, take the following steps:
- SSH to the right machine:
- If you added Automation Suite Robots to a single-node evaluation installation, go to the main machine.
- If you added Automation Suite Robots to a multi-node HA-ready production installation, go to any of the server nodes.
- Copy the contents of the
UiPathAutomationSuitefolder to the Automation Suite Robots node. Make sure to use the username and DNS specific to the Automation Suite Robots node.sudo su - scp -r /opt/UiPathAutomationSuite <username>@<node dns>:/opt/ scp -r ~/* <username>@<node dns>:/opt/UiPathAutomationSuite/sudo su - scp -r /opt/UiPathAutomationSuite <username>@<node dns>:/opt/ scp -r ~/* <username>@<node dns>:/opt/UiPathAutomationSuite/
Step 3: Running the Interactive Installer to Configure the Dedicated Node
To configure the dedicated node, take the following steps:
- SSH to the Automation Suite Robots node.
- Run the Automation Suite interactive installer.
sudo su - cd /opt/UiPathAutomationSuite yum install unzip jq -y CONFIG_PATH=/opt/UiPathAutomationSuite/cluster_config.json ./bin/uipathctl rke2 install -i ./cluster_config.json -o ./output.json -k -j asrobots --accept-license-agreementsudo su - cd /opt/UiPathAutomationSuite yum install unzip jq -y CONFIG_PATH=/opt/UiPathAutomationSuite/cluster_config.json ./bin/uipathctl rke2 install -i ./cluster_config.json -o ./output.json -k -j asrobots --accept-license-agreement
Step 4: Enabling Kubectl
To set the kubectl context on the Automation Suite Robots machine, run the following command:
sudo su -
export KUBECONFIG=/var/lib/rancher/rke2/agent/kubelet.kubeconfig
export PATH=$PATH:/var/lib/rancher/rke2/bin
kubectl get nodessudo su -
export KUBECONFIG=/var/lib/rancher/rke2/agent/kubelet.kubeconfig
export PATH=$PATH:/var/lib/rancher/rke2/bin
kubectl get nodesYou should see the nodes and their corresponding names. You need the name of the Automation Suite Robots node for the next step.
Step 5: Verifying the Automation Suite Robots Configuration
<node name> with the Automation Suite Robots node name.
kubectl describe node <node name> | grep -i "taints"kubectl describe node <node name> | grep -i "taints"The command should return the following output:
$ kubectl describe node asrobots0 | grep -i "taints"
Taints: serverless.robot=present:NoSchedule$ kubectl describe node asrobots0 | grep -i "taints"
Taints: serverless.robot=present:NoScheduleAt this point, you have successfully completed the installation for Automation Suite Robots.
- Requirements
- Adding an Automation Suite Agent Node to the Cluster
- Step 1: Configuring the Machine
- Step 2: Copying the Interactive Installer to the Target Machine
- Step 3: Running the Interactive Installer to Configure the Dedicated Node
- Step 4: Enabling Kubectl
- Step 5: Verifying the Automation Suite Robots Configuration