- Overview
- Requirements
- Installation
- Q&A: Deployment templates
- Configuring the machines
- Configuring the external objectstore
- Configuring an external Docker registry
- Configuring the load balancer
- Configuring the DNS
- Configuring Microsoft SQL Server
- Configuring the certificates
- Online multi-node HA-ready production installation
- Offline multi-node HA-ready production installation
- Disaster recovery - Installing the secondary cluster
- Downloading the installation packages
- install-uipath.sh parameters
- Enabling Redis High Availability Add-On for the cluster
- Document Understanding configuration file
- 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
- Post-installation
- Cluster administration
- Monitoring and alerting
- Migration and upgrade
- Migration options
- 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 Insights
- Step 7: Deleting the default tenant
- Performing a single tenant migration
- 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 automatically clean up Longhorn snapshots
- How to disable TX checksum offloading
- How to manually set the ArgoCD log level to Info
- How to generate the encoded pull_secret_value for external registries
- How to address weak ciphers in TLS 1.2
- How to work with certificates
- 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
- First installation fails during Longhorn setup
- 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
- GPU node affected by resource unavailability
- Volume unable to mount due to not being ready for workloads
- Support bundle log collection failure
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- Failure to resize PVC
- Failure to resize objectstore PVC
- Rook Ceph or Looker pod stuck in Init state
- StatefulSet volume attachment error
- Failure to create persistent volumes
- Storage reclamation patch
- Backup failed due to TooManySnapshots error
- All Longhorn replicas are faulted
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- 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
- 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
- Issues accessing the ArgoCD read-only account
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unhealthy services after cluster restore or rollback
- Pods stuck in Init:0/X
- Prometheus in CrashloopBackoff state with out-of-memory (OOM) error
- Missing Ceph-rook metrics from monitoring dashboards
- Pods cannot communicate with FQDN in a proxy environment
- Failure to configure email alerts post upgrade
- No healthy upstream issue
- Document Understanding not on the left rail of Automation Suite
- Failed status when creating a data labeling session
- Failed status when trying to deploy an ML skill
- Migration job fails in ArgoCD
- Handwriting recognition with intelligent form extractor not working
- Failed ML skill deployment due to token expiry
- 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
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
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 --decode ; echokubectl get secrets/platform-service-secrets -n uipath \ -o "jsonpath={.data['identity\.hostAdminPassword']}" | base64 --decode ; 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 --decode ; echokubectl get secrets/platform-service-secrets -n uipath \ -o "jsonpath={.data['identity\.hostAdminPassword']}" | base64 --decode ; 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
The monitoring stack for Automation Suite clusters includes Prometheus, Grafana, Alert Manager, and Longhorn Dashboard.
This page describes a series of monitoring scenarios.
For more details, see the official Rancher documentation on using Rancher Monitoring.
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/dashboard | https://monitoring.automationsuite.mycompany.com/dashboard |
| Alert Management | Alert Manager | https://monitoring.fqdn/alertmanager | https://monitoring.automationsuite.mycompany.com/alertmanager |
| Persistent Block Storage | Longhorn dashboard | https://monitoring.fqdn | https://monitoring.automationsutie.mycompany.com |
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-auth -o "jsonpath={.data['password']}" | base64 -dkubectl get secrets/dex-static-credential -n uipath-auth -o "jsonpath={.data['password']}" | base64 -d
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 that is 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-auth --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-auth --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]" -
Run the following command by replacing
<cluster_config.json>with the path to your configuration file:/opt/UiPathAutomationSuite/UiPath_Installer/install-uipath.sh -i <cluster_config.json> -f -o output.json --accept-license-agreement/opt/UiPathAutomationSuite/UiPath_Installer/install-uipath.sh -i <cluster_config.json> -f -o output.json --accept-license-agreement
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 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
- 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