- Overview
- Requirements
- Installation
- Q&A: Deployment templates
- 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
- Connecting Task Mining application
- Adding a dedicated agent Node for Task Mining
- 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
- B) 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 bundle
- 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 address weak ciphers in TLS 1.2
- 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
- Volume unable to mount due to not being ready for workloads
- Unable to launch Automation Hub and Apps with proxy setup
- 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
- Unexpected inconsistency; run fsck manually
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- MongoDB Pod Fails to Upgrade From 4.4.4-ent to 5.0.7-ent
- 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
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
Managing products
You can enable and disable products in Automation Suite at any point post-installation.
cluster_config.json
file stored in the
/opt/UiPathAutomationSuite
folder, and rerun the service
installer step.
cluster_config.json
file:
"actioncenter": {
"enabled": "true" //Set to "false" to disable the Action Center
}
"actioncenter": {
"enabled": "true" //Set to "false" to disable the Action Center
}
cluster_config.json
file:
"apps": {
"enabled": "true" //Set to "false" to disable the Apps
}
"apps": {
"enabled": "true" //Set to "false" to disable the Apps
}
enable
flag and an SQL database.
sql_connection_string_template_jdbc
in
cluster_config.json
, then the default AI Center
database name is AutomationSuite_AICenter
.
sql_connection_str
inside the AI Center field. This overrides the default database and connection string template set in sql_connection_string_template_jdbc
.
-
If AI Center does not require an external Orchestrator, see the following configuration details for enabling or disabling AI Center in
cluster_config.json
:"aicenter": { "enabled": "true", //Set to "false" to disable the AICenter "sql_connection_str": "" //Optional and only required to override the default database name }
"aicenter": { "enabled": "true", //Set to "false" to disable the AICenter "sql_connection_str": "" //Optional and only required to override the default database name } -
If AI Center requires an external Orchestrator, see the following configuration details for enabling or disabling AI Center in
cluster_config.json
:"aicenter": { "enabled": "true", //Set to "false" to disable the AI Center "sql_connection_str": "" //Optional and only required to override the default database name "orchestrator_url": "https://orchestrator.example.com", //Specify the Orchestrator URL for AI Center "identity_server_url": "https://orchestrator.example.com/identity", //Specify the Identiy URL for AI Center "orchestrator_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to the Orchestrator certificate "identity_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to Identity certificate file "metering_api_key": "test" //Specify the metering API key }
"aicenter": { "enabled": "true", //Set to "false" to disable the AI Center "sql_connection_str": "" //Optional and only required to override the default database name "orchestrator_url": "https://orchestrator.example.com", //Specify the Orchestrator URL for AI Center "identity_server_url": "https://orchestrator.example.com/identity", //Specify the Identiy URL for AI Center "orchestrator_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to the Orchestrator certificate "identity_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to Identity certificate file "metering_api_key": "test" //Specify the metering API key }Note:metering_api_key
is the Document Understanding or AI Units API key from the AI Center cloud account.
To complete the installation, run the following post-installation command:
./configureUiPathAS.sh aicenter configure --installation-token <identity token>
./configureUiPathAS.sh aicenter configure --installation-token <identity token>
automation_hub
section of the cluster_config.json
file, set the enabled
flag
to true
:
"automation_hub": {
"enabled": "true" //Set to "false" to disable Automation Hub
"sql_connection_str": "" //Optional and only require to override the default database name
}
"automation_hub": {
"enabled": "true" //Set to "false" to disable Automation Hub
"sql_connection_str": "" //Optional and only require to override the default database name
}
enabled
flag to false
in the
automation_hub
section of the cluster_config.json
file.
enable
flag and an SQL database.
sql_connection_string_template
in cluster_config.json
, then the default database name for
Automation Ops is AutomationSuite_Platform
.
sql_connection_str
inside the Automation Ops field. This overrides the default database and connection string template set in sql_connection_string_template
.
cluster_config.json
:
"automation_ops": {
"enabled": "true", //Set to "false" to disable the Automation Ops
"sql_connection_str": "" //Optional and only require to override the default database name
}
"automation_ops": {
"enabled": "true", //Set to "false" to disable the Automation Ops
"sql_connection_str": "" //Optional and only require to override the default database name
}
To enable Automation Suite Robots, take the following steps:
-
Enable the
asrobots
flag in thecluster_config.json
file. If you want to enable package caching, make sure to properly configure thepackagecaching
andpackagecachefolder
flags as well.{ "asrobots": { "enabled": Boolean, "packagecaching": Boolean, "packagecachefolder": String } }
{ "asrobots": { "enabled": Boolean, "packagecaching": Boolean, "packagecachefolder": String } }Parameter
Default value
Description
packagecaching
true
When set totrue
, robots use a local cache for package resolution.packagecachefolder
/uipath_asrobots_package_cache
The disk location on the serverless agent node where the packages are stored.
Note: Package caching optimizes your process runs and allows them to run faster. NuGet packages are fetched from the filesystem instead of being downloaded from the Internet/network. This requires an additional space of minimum 10GiB and should be allocated to a folder on the host machine filesystem of the dedicated nodes. -
If you use a multi-node HA-ready production setup, you must configure a specialized agent node for Automation Suite Robots. In single-node evaluation mode, an additional node is optional. For instructions, see Adding a dedicated agent node for Automation Suite Robots.
asrobots
flag in the cluster_config.json
file.
enable
flag and an SQL database.
sql_connection_string_template
in cluster_config.json
, then the default database name is
AutomationSuite_DataService
.
sql_connection_str
inside the Data Service field. This overrides the default database and connection string template set in sql_connection_string_template
.
cluster_config.json
:
"dataservice": {
"enabled": "true", //Set to "false" to disable the Data Service,
"sql_connection_str": "" //Optional and only require to override the default database name
}
"dataservice": {
"enabled": "true", //Set to "false" to disable the Data Service,
"sql_connection_str": "" //Optional and only require to override the default database name
}
enable
flag and an SQL database.
sql_connection_string_template_odbc
in
cluster_config.json
, then the default database name
is AutomationSuite_DU_Datamanager
.
sql_connection_str
inside the Document Understanding field. This overrides the default database and connection string template set in sql_connection_string_template_odbc
.
If you perform an offline installation, you need to download the offline bundle for Document Understanding as well. Before enabling Document Understanding, please refer to Install and Use Document Understanding.
cluster_config.json
:
"documentunderstanding": {
"enabled": "true", //Set to "false" to disable the Document Understanding
"sql_connection_str": "" //Optional and only require to override the default database name
}
"documentunderstanding": {
"enabled": "true", //Set to "false" to disable the Document Understanding
"sql_connection_str": "" //Optional and only require to override the default database name
}
enable
flag and an SQL database.
sql_connection_string_template
in cluster_config.json
, then the default database name is AutomationSuite_Insights
.
sql_connection_str
inside the Insights field. This overrides the default database and connection string template set in sql_connection_string_template
.
Insights has an optional SMTP configuration to enable receiving email notifications. Refer to Advanced installation experience for more details.
cluster_config.json
:
"insights": {
"enabled": "true", //Set to "false" to disable the Insights,
"sql_connection_str": "" //Optional and only require to override the default database name
}
"insights": {
"enabled": "true", //Set to "false" to disable the Insights,
"sql_connection_str": "" //Optional and only require to override the default database name
}
orchestrator
flag to true
in
the cluster_config.json
file.
"orchestrator": {
"enabled": "true" //Set to "false" to disable Orchestrator
"sql_connection_str": "" //Optional and only require to override the default database name
}
"orchestrator": {
"enabled": "true" //Set to "false" to disable Orchestrator
"sql_connection_str": "" //Optional and only require to override the default database name
}
orchestrator
flag to false
in
the cluster_config.json
file.
cluster_config.json
file:
- Enable the
processmining
flag. -
Configure the following connection string templates:
sql_connection_string_template
sql_connection_string_template_jdbc
sql_connection_string_template_odbc
sql_connection_string_template_sqlalchemy_pyodbc
-
In multi-node HA-ready production installations, add a separate connection string for the second SQL Server. Note that in single-node evaluation installations, the seconds SQL Server is recommended. For instructions on how to configure the seconds SQL Server, see SQL requirements for Process Mining
"processmining": { "enabled": true, "sql_connection_str": "" // dotnet connection string "sqlalchemy_pyodbc_sql_connection_str": "", "warehouse": { "sql_connection_str": "", "sqlalchemy_pyodbc_sql_connection_str": "" } }
"processmining": { "enabled": true, "sql_connection_str": "" // dotnet connection string "sqlalchemy_pyodbc_sql_connection_str": "", "warehouse": { "sql_connection_str": "", "sqlalchemy_pyodbc_sql_connection_str": "" } }
processmining
flag.
enable
flag and an SQL Database.
sql_connection_string_template
in cluster_config.json
, then the default database name is
AutomationSuite_Task_Mining
.
To change the name to something other than the default, you can update the sql_connection_str inside the Task Mining field to override the default database and connection string template set in sql_connection_string_template
Task Mining requires a few additional steps, including the provisioning of a dedicated agent node for AI-specific workloads.
Before enabling Task Mining, please refer Task Mining installation section Adding a dedicated agent node for Task Mining.
cluster_config.json
:
"task_mining": {
"enabled": "true", //Set to "false" to disable the Task Mining,
"sql_connection_str": "" //Optional and only require to override the default database name
}
"task_mining": {
"enabled": "true", //Set to "false" to disable the Task Mining,
"sql_connection_str": "" //Optional and only require to override the default database name
}
Un-tainting for workloads
If desired, the Task Mining node can be repurposed as an agent node. To accomplish this, run the following commands:
- Check an actual taint using
kubectl describe node task-mining_nodename
command. - Run the command
kubectl taint nodes task-mining_nodename task.mining/cpu=present:NoSchedule-
. - Check taint has disappeared using
kubectl describe node task-mining_nodename
command.
enable
flag and an SQL database.
sql_connection_string_template
in cluster_config.json
, then the default database name is
AutomationSuite_Test_Manager
.
sql_connection_str
inside the Test Manager field. This overrides the default database and connection string template set in sql_connection_string_template
.
cluster_config.json
:
"test_manager": {
"enabled": "true", //Set to "false" to disable the Test Manager,
"sql_connection_str": "" //Optional and only require to override the default database name
}
"test_manager": {
"enabled": "true", //Set to "false" to disable the Test Manager,
"sql_connection_str": "" //Optional and only require to override the default database name
}
cluster_config.json
, run the following command on the installer to update the service configuration.
-
For online installations:
./install-uipath.sh -i cluster_config.json -o output.json -f -s --accept-license-agreement
./install-uipath.sh -i cluster_config.json -o output.json -f -s --accept-license-agreement -
For offline installations:
./install-uipath.sh -i cluster_config.json -o output.json -f -s --install-type offline --accept-license-agreement
./install-uipath.sh -i cluster_config.json -o output.json -f -s --install-type offline --accept-license-agreement
- Step 1: Changing the product selection in the configuration file
- Enabling or disabling Action Center
- Enabling or Disabling Apps
- Enabling or disabling AI Center
- Enabling or disabling Automation Hub
- Enabling or disabling Automation Ops
- Enabling or disabling Automation Suite Robots
- Enabling or disabling Data Service
- Enabling or disabling Document Understanding
- Enabling or Disabling Insights
- Enabling or disabling Orchestrator
- Enabling or disabling Process Mining
- Enabling or disabling Task Mining
- Enabling or disabling Test Manager
- Step 2: Running the installer to update the new product configuration