- 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 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
- Step 13: Generating cluster_config.json
- 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 Automation Suite Robots
- Step 15: Configuring the temporary Docker registry for offline installations
- Step 16: Validating the prerequisites for the installation
- Running uipathctl
- Manual: Performing the installation
- Post-installation
- Cluster administration
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating Redis from in-cluster to external High Availability Add-on
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Migrating from in-cluster registry 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 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 reduce permissions for an NFS backup directory
- 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 collect DU usage data with in-cluster objectstore (Ceph)
- How to install RKE2 SELinux on air-gapped environments
- How to clean up old differential backups on an NFS server
- Error in downloading the bundle
- Offline installation fails because of missing binary
- Certificate issue in offline installation
- SQL connection string validation error
- 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
- Temporary registry installation fails on RHEL 8.9
- Frequent restart issue in uipath namespace deployments during offline installations
- DNS settings not honored by CoreDNS
- Upgrade fails due to unhealthy Ceph
- RKE2 not getting started due to space issue
- Upgrade fails due to classic objects in the Orchestrator database
- Ceph cluster found in a degraded state after side-by-side upgrade
- Service upgrade fails for Apps
- In-place upgrade timeouts
- Upgrade fails in offline environments
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- Upgrade fails due to overridden Insights PVC sizes
- Upgrade failure due to uppercase hostname
- 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
- Missing Ceph-rook metrics from monitoring dashboards
- Mismatch in reported errors during diagnostic health checks
- No healthy upstream issue
- Redis startup blocked by antivirus
- 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
- 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
Preparing the new cluster
Preparing the cluster_config.json file
You must not modify the source cluster after starting the export-import process.
To prepare the cluster_config.json file, take the following steps:
-
Generate the
cluster_config.jsonfile on the source cluster by running one of the following commands:-
If you upgrade from versions prior to 2023.10.0, use the following options:
-
Option A: If you already have a
cluster_config.jsonfile available, get it by navigating to the latest installer folder and running the following command:cd /opt/UiPathAutomationSuite/latest/installer ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o /opt/UiPathAutomationSuite/cluster_config.jsoncd /opt/UiPathAutomationSuite/latest/installer ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o /opt/UiPathAutomationSuite/cluster_config.json -
Option B: If you do not have a
cluster_config.jsonfile available, generate it by navigating to the latest installer folder and running the following command:cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -o /opt/UiPathAutomationSuite/cluster_config.jsoncd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -o /opt/UiPathAutomationSuite/cluster_config.json
-
-
If you upgrade from 2023.10.0 or later versions, generate the config file by navigating to the latest installer folder and running the following command:
./bin/uipathctl manifest get-revision >> ./cluster_config.json./bin/uipathctl manifest get-revision >> ./cluster_config.json -
If you opted for Side-by-side upgrade (single node start) model, set or edit the following fields in the
cluster_config.jsonfile.{ .... "profile": "default", "fault_tolerance": 0, ... }{ .... "profile": "default", "fault_tolerance": 0, ... }
-
-
Copy the
cluster_config.jsonfile from the source cluster and place it in the target cluster:scp cluster_config.json user@target_cluster_IP /foo/barscp cluster_config.json user@target_cluster_IP /foo/barMake sure to replace
/foo/barwith the directory path on the target cluster. -
Perform the following actions:
- Generate a new GUID for
rke_tokento ensure the new cluster does not join the source cluster. Run the following command:LC_CTYPE=C tr </dev/urandom -dc '!@#$%q_A-Z-a-z-0-9' | head -c 16LC_CTYPE=C tr </dev/urandom -dc '!@#$%q_A-Z-a-z-0-9' | head -c 16 - Update the temporary FQDN, SQL Server, or other configurations as required for the target cluster.
- Update the
cluster_config.jsonfile accordingly with the new values.- You can use any text editor to modify the
cluster_config.jsonfile. - Optional external objectstore: Provide the external objectstore if you want to change any of its settings.
- You need to provide a PostgreSQL database for
AutomationSuite_Airflowand configure its connection string incluster_config.json.
- You can use any text editor to modify the
- Generate a new GUID for
To ensure instant rollback in case of failures, you must bring different resources than the ones used for the source cluster, as follows:
- You must bring different SQL databases for the new target cluster.
- You must bring different external objectstore buckets for the new target cluster.
We currently do not support migrating from an in-cluster objectstore to an external objectstore as part of the side-by-side upgrade process. To use an external objectstore in the new environment, you must migrate to an external objectstore either before starting or after completing the side-by-side upgrade.
Installing the new cluster
To install the new cluster, take the following steps:
-
Install the infrastructure on the new target cluster, by following the preparation and installation instructions, with the mention that, in this case, you need to skip the Completing the installation step.
-
If you use an in-cluster objectstore, you must install the required in-cluster objectstore for import, by running the following command:
./bin/uipathctl manifest apply /opt/UiPathAutomationSuite/cluster_config.json --override argocd --versions versions/helm-charts.json./bin/uipathctl manifest apply /opt/UiPathAutomationSuite/cluster_config.json --override argocd --versions versions/helm-charts.json
You must complete the installation of the services only after migrating the data.