- 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 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 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
- 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 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: Migrating standalone Test Manager
- Step 10: 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
- How to clean up old differential backups on an NFS server
- 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
- 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
- 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
- Backup operations fail with PartiallyFailed status
- 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 migration, make sure you meet the following prerequisites:
.NET Runtime 6.0 or later is required to run the UiPath.OrganizationMigrationApp tool. You must download and install it before running UiPath.OrganizationMigrationApp.
Linux
If .NET Runtime 6.0 or later is not present, download and install .NET Runtime for Linux before using UiPath.OrganizationMigrationApp.
To install .NET Runtime 6.0 on RHEL, run the following command:
sudo yum install dotnet-sdk-6.0 -ysudo yum install dotnet-sdk-6.0 -yWindows
The UiPath.OrganizationMigrationApp tool requires .NET Runtime 6.0 at a minimum. If .NET Runtime 6.0 and beyond is not present, download and install .NET Runtime 6.0 for Windows before using UiPath.OrganizationMigrationApp.
To complete the migration process, you must use a Docker or Podman client that has been authenticated with the private registry. This allows the migrators to run on the MSI databases, making them compatible with the Automation Suite databases.
Docker
- To download the Docker binaries, refer to the Install Docker Engine official documentation.
- To authenticate the Docker registry, refer to the docker login official documentation. Alternatively,
you can use the following command by replacing the sample credentials with your
actual registry credentials:
docker login my.registry.io:443 --username "admin" --password "secret"docker login my.registry.io:443 --username "admin" --password "secret"
Podman
- To download the Podman binaries, refer to the official Podman Installation Instructions.
- To authenticate to the Podman registry, refer to the Podman login official documentation.
Alternatively, you can use the following command by replacing the sample
credentials with your actual registry credentials:
podman login my.registry.io:443 --username "admin" --password "secret"podman login my.registry.io:443 --username "admin" --password "secret"
jq
utility to be installed on your machine.
cd <AS install directory>
rm -f values.json && rm -f appsettings.json
kubectl -n uipath get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jq '.' > values.json
jq '.AppSettings' values.json > appsettings.json
jq '.["Storage.CreateBucket.OnTenantCreation.Enabled"] = "true"' appsettings.json > temp.json && mv -f temp.json appsettings.json
./bin/uipathctl config orchestrator update-config --app-settings appsettings.jsoncd <AS install directory>
rm -f values.json && rm -f appsettings.json
kubectl -n uipath get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jq '.' > values.json
jq '.AppSettings' values.json > appsettings.json
jq '.["Storage.CreateBucket.OnTenantCreation.Enabled"] = "true"' appsettings.json > temp.json && mv -f temp.json appsettings.json
./bin/uipathctl config orchestrator update-config --app-settings appsettings.jsonjq, use one of the following options:
-
Option 1: Run the following command:
yum install -y epel-release yum install -y jqyum install -y epel-release yum install -y jq -
Option 2: Run the following commands:
shell curl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpmshell curl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpm
kubectl -n uipath get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jqkubectl -n uipath get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jqIf the setting has been enabled, the command should return the following response:
{
"AppSettings": {
"Storage.CreateBucket.OnTenantCreation.Enabled": "true"
}
}{
"AppSettings": {
"Storage.CreateBucket.OnTenantCreation.Enabled": "true"
}
}The UiPath.OrganizationMigrationApp tool helps you perform operations such as move the Identity data of all tenants from standalone to Automation Suite and merge organizations.
To download UiPath.OrganizationMigrationApp, see Downloading the installation packages.
To see which UiPath.OrganizationMigrationApp version is compatible with your environment, see Compatibility matrix.
You must download and install SQL Server Management Studio (SSMS) or a similar tool for managing Microsoft SQL Server. This tool helps you restore the Orchestrator database to the Automation Suite SQL Server instance or a different SQL Server instance.
-
Download and install SQL Server Management Studio.
-
Log into the standalone SQL Server using the standalone SQL connection string.
-
Open port
1433for the source and target database.
'). However, when the password includes special characters such as ` or $, a different approach is required.
\`"<password>\`", replacing <password> with the actual password. Moreover, you must also adhere to the escape rules as detailed in the following table:
|
Original format in ADUC |
Escaped format in PowerShell string |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
Assume that the original password is7'8:<=XMe$y[@vC?_4ZeY8c-~y'W!1dU4gnczuf'/p>j<I. Adhering to the special character escape rules, it becomes: Password=\`"7'8:<=XMe`$y[@vC?_4ZeY8c-~y'W!1dU4```gnczuf'/p>```j<I\`".
The full command, with the password configured in destination connection string, looks as follows:
./UiPath.OrganizationMigrationApp.exe migrate -a -m -s "Server=tcp:abc.com,1433;Initial Catalog=UiPath_20230531;Persist Security Info=False;User ID=username;Password=asiodhyf;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;" -d "Server=tcp:cde.net,1433;Initial Catalog=AutomationSuite_Platform;Persist Security Info=False;User [email protected];Password=\`"7'8:<=XMe`$y[@vC?_4ZeY8c-~y'W!1dU4```gnczuf'/p>```j<I\`""./UiPath.OrganizationMigrationApp.exe migrate -a -m -s "Server=tcp:abc.com,1433;Initial Catalog=UiPath_20230531;Persist Security Info=False;User ID=username;Password=asiodhyf;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;" -d "Server=tcp:cde.net,1433;Initial Catalog=AutomationSuite_Platform;Persist Security Info=False;User [email protected];Password=\`"7'8:<=XMe`$y[@vC?_4ZeY8c-~y'W!1dU4```gnczuf'/p>```j<I\`""Before starting the migration, you must add the Administrator group in every tenant.
If you are performing an organization merge and the Administrator group is not added in all tenants, you can lock yourself out of the Orchestrator instance after the merge completes.
Adding the Administrator group in each tenant ensures that administrative access is preserved throughout the migration and merge process.
testmanager_migrator.sh) helps you to
perform multiple automatic operations for migrating various configurations and files,
such as:
- Execute
kubectloperations, such as updating secrets and configurations maps. - Perform ArgoCD synchronizations via the CLI.
- Override configuration settings and restart deployments.
- Add storage files to the Ceph object store.
- Restore and update the
DataEncryptionKeyin the Kubernetes secrets from the MSI instance. - Synchronize Test Manager in ArgoCD.
- Migrate folders or files from a Windows file store to the destination object store, creating the required directory hierarchy in the bucket defined by Kubernetes secrets.
Environment requirements to run the Test Manager migration script
To successfully run the Test Manager migration script you need to ensure you meet the following environment requirements:
- Configure
kubectlwith a connection to the Automation Suite cluster.Important: Ensure thatkubeconfigis set as an environment variable. - Install the
jqutility using the following commandyum install jq. - Install the
argocdCLI.Visit Installing Argo CD for more information.
- Install Rclone.
Visit the RClone documentation for more information.
Note: Minimum required version for Rclone is 1.56.0.
Common Test Manager migration script commands
Check the following commands that you can perform using the Test Manager migration script:
./testmanager_migrator.sh -d -y \
-k \"enc key value\" \
-s blobstoragefolder
-k|--encryption-key
The value of the encryption key that will override the key generated during installation.
-s|--storage-folder
The location of the storage folder on the local disk.
-is-|--use-incluster-storage
Use in cluster Ceph object store.
-d|--dry-run
Do not update Test Manager with the new values
-y|--accept-all
Do not prompt for confirmation of actions ./testmanager_migrator.sh -d -y \
-k \"enc key value\" \
-s blobstoragefolder
-k|--encryption-key
The value of the encryption key that will override the key generated during installation.
-s|--storage-folder
The location of the storage folder on the local disk.
-is-|--use-incluster-storage
Use in cluster Ceph object store.
-d|--dry-run
Do not update Test Manager with the new values
-y|--accept-all
Do not prompt for confirmation of actions- .NET Runtime 6.0
- Linux
- Windows
- Docker/Podman
- Docker
- Podman
- Orchestrator bucket creation setting
- UiPath.OrganizationMigrationApp
- Tool for managing Microsoft SQL Server
- Special character escape rules for connection string passwords
- Example
- Administrator group configuration requirement
- Test Manager migration script
- Environment requirements to run the Test Manager migration script
- Common Test Manager migration script commands