- 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
Accessing Automation Suite
Enabling kubectl
Before running any kubectl commands, make sure to enable kubectl. This allows you to run commands for retrieving passwords and configuration details for the cluster.
To enable kubectl, run the following command:
sudo su -
export KUBECONFIG="/etc/rancher/rke2/rke2.yaml" \
&& export PATH="$PATH:/usr/local/bin:/var/lib/rancher/rke2/bin"
sudo su -
export KUBECONFIG="/etc/rancher/rke2/rke2.yaml" \
&& export PATH="$PATH:/usr/local/bin:/var/lib/rancher/rke2/bin"
Managing certificates
The installation process generates self-signed certificates on your behalf. These certificates will expire in 90 days, and you must replace them with certificates signed by a trusted Certificate Authority (CA) as soon as installation completes. If you do not update the certificates, the installation will stop working after 90 days.
For instructions, see Managing certificates.
If you try to access the cluster with a web browser, and the certificates are not from a trusted CA, then you will see a warning in the browser. You can rectify this by importing and trusting the cluster SSL certificate on the client computer running the browser.
To manage certificates, take the following steps:
- To retrieve the current certificate, run the following command:
-
On Linux:
kubectl get secrets/istio-ingressgateway-certs -n istio-system \ -o "jsonpath={.data['ca\.crt']}" | base64 --decodekubectl get secrets/istio-ingressgateway-certs -n istio-system \ -o "jsonpath={.data['ca\.crt']}" | base64 --decode -
On Windows (PowerShell):
(kubectl get secret -n istio-system istio-ingressgateway-certs -o jsonpath='{.data.ca\.crt}') | ForEach-Object { [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($_)) }(kubectl get secret -n istio-system istio-ingressgateway-certs -o jsonpath='{.data.ca\.crt}') | ForEach-Object { [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($_)) }
-
- To update the certificates, see Managing certificates.
Accessing the Cluster Administration portal
The Cluster Administration portal is a centralized location where you can find all the resources required to complete an Automation Suite installation and perform common post-installation operations. For details, see Getting started with the Cluster Administration portal.
To access the Cluster Administration portal, take the following step:
Go to the following URL: https://${CONFIG_CLUSTER_FQDN}/uipath-management.
You do not need any credentials to access the Cluster Administration portal.
Accessing Automation Suite general interface
You need to accept the self-signed certificate in the web browser to be able to access a cluster that is still configured with self-signed certificates.
The general-use Automation Suite user interface serves as a portal for both organization administrators and organization users. It is a common organization-level resource from where everyone can access all of your Automation Suite areas: administration pages, platform-level pages, product-specific pages, and user-specific pages.
To access Automation Suite, take the following steps:
-
Go to the following URL:
https://${CONFIG_CLUSTER_FQDN} -
Switch to the Default organization.
-
The username is orgadmin.
-
Retrieve the password using the following command:
kubectl get secrets/platform-service-secrets -n uipath \ -o "jsonpath={.data['identity\.hostAdminPassword']}" | base64 -d ; echokubectl get secrets/platform-service-secrets -n uipath \ -o "jsonpath={.data['identity\.hostAdminPassword']}" | base64 -d ; echoNote:Using the same command to retrieve the organization admin and the host admin passwords is by design. This is because the two passwords are initially the same. If Change password on the first login is set to Required at the host level, the organization administrator must set a new password when they log in for the first time.
Accessing host administration
The host portal is for system administrators to configure the Automation Suite instance. The settings that you configure from this portal are inherited by all your organizations, and some can be overwritten at the organization level.
To access host administration, take the following steps:
-
Go to the following URL:
https://${CONFIG_CLUSTER_FQDN} -
Switch to the Host organization.
-
The username is admin.
-
Retrieve the password using the following command:
kubectl get secrets/platform-service-secrets -n uipath \ -o "jsonpath={.data['identity\.hostAdminPassword']}" | base64 -d ; echokubectl get secrets/platform-service-secrets -n uipath \ -o "jsonpath={.data['identity\.hostAdminPassword']}" | base64 -d ; echoNote:Using the same command to retrieve the organization admin and the host admin passwords is by design. This is because the two passwords are initially the same. If Change password on the first login is set to Required at the host level, the organization administrator must set a new password when they log in for the first time.
Accessing ArgoCD
You can use the ArgoCD console to manage installed products.
Depending on the operations you want to carry out in ArgoCD, you can use two types of accounts to access the console:
- the read-only account in basic scenarios
- admin account in advanced scenarios
For more details on ArgoCD and how you can access it, see Managing the cluster in ArgoCD.
Accessing the monitoring tools
Overview
You can access the Automation Suite monitoring tools individually using the following URLs:
| Application | Tool | URL | Example |
|---|---|---|---|
| Metrics | Prometheus | https://monitoring.fqdn/metrics | https://monitoring.automationsuite.mycompany.com/metrics |
| Dashboard | Grafana | https://monitoring.fqdn/grafana | https://monitoring.automationsuite.mycompany.com/grafana |
| Alert Management | Alert Manager | https://monitoring.fqdn/alertmanager | https://monitoring.automationsuite.mycompany.com/alertmanager |
For details on how to fetch Grafana credentials, refer to the Accessing Grafana dashboard section.
If you have excluded the built-in monitoring components, the related tools and URLs will not be available. For details, refer to Optional: Configuring the monitoring solution.
Monitoring tool authentication
To access the monitoring tools for the first time, log in as an admin with the following default credentials:
-
Username: admin
-
Password: to retrieve the password , run the following command:
kubectl get secrets/dex-static-credential -n uipath -o "jsonpath={.data['password']}" | base64 --decodekubectl get secrets/dex-static-credential -n uipath -o "jsonpath={.data['password']}" | base64 --decode
Dex authentication
To update the default password used for Dex authentication while accessing the monitoring tools, take the following steps.
Dex is a basic authentication method layered over the monitoring tools. Therefore, updating the Dex password does not impact the passwords for the monitoring tools. In this scenario, the passwords for the monitoring tools remain the same as before.
-
Run the following command by replacing
newpasswordwith your new password:password="newpassword" password=$(echo -n $password | base64) kubectl patch secret dex-static-credential -n uipath --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]"password="newpassword" password=$(echo -n $password | base64) kubectl patch secret dex-static-credential -n uipath --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]" -
Run the following command to update the password:
./bin/uipathctl manifest apply /opt/UiPathAutomationSuite/cluster_config.json --versions versions/helm-charts.json./bin/uipathctl manifest apply /opt/UiPathAutomationSuite/cluster_config.json --versions versions/helm-charts.json
Accessing service database connection strings
You can access the database connection strings for each service as follows:
kubectl -n uipath get secret aicenter-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret orchestrator-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-hub-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-ops-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret insights-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret platform-service-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret test-manager-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automationsolutions-sql-connectionstring-secret -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret integration-services-secrets -o jsonpath='{.data.odbcSQLConnectionString}' | base64 --decode
kubectl -n uipath get secret integration-services-secrets -o jsonpath='{.data.jdbcSQLConnectionString}' | base64 --decode
kubectl -n uipath get secret integration-services-secrets -o jsonpath='{.data.dotNetSQLConnectionString}' | base64 --decode
kubectl -n uipath get secret aicenter-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret orchestrator-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-hub-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-ops-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret insights-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret platform-service-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret test-manager-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automationsolutions-sql-connectionstring-secret -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret integration-services-secrets -o jsonpath='{.data.odbcSQLConnectionString}' | base64 --decode
kubectl -n uipath get secret integration-services-secrets -o jsonpath='{.data.jdbcSQLConnectionString}' | base64 --decode
kubectl -n uipath get secret integration-services-secrets -o jsonpath='{.data.dotNetSQLConnectionString}' | base64 --decode
- Enabling kubectl
- Managing certificates
- Accessing the Cluster Administration portal
- Accessing Automation Suite general interface
- Accessing host administration
- Accessing ArgoCD
- Accessing the monitoring tools
- Overview
- Monitoring tool authentication
- Dex authentication
- Accessing service database connection strings