- Overview
- Requirements
- Installation
- Post-installation
- Cluster administration
- Managing products
- Backing up and Restoring the Cluster
- Monitoring and alerting
- Migration and upgrade
- 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 disable TLS 1.0 and 1.1
- 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 debug failed Automation Suite installations
- How to disable TX checksum offloading
- 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
- Failure After Certificate Update
- Automation Suite Requires Backlog_wait_time to Be Set 1
- Cannot Log in After Migration
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- 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 With Error: An Invalid Status Code Was Supplied (Client's Credentials Have Been Revoked).
- Login Failed for User <ADDOMAIN><aduser>. Reason: The Account Is Disabled.
- Alarm Received for Failed Kerberos-tgt-update Job
- SSPI Provider: Server Not Found in Kerberos Database
- 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
- Missing Self-heal-operator and Sf-k8-utils Repo
- Degraded MongoDB or Business Applications After Cluster Restore
- Unhealthy Services After Cluster Restore or Rollback
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
You can enable and disable products in Automation Suite at any point post-installation.
To do that, you must access and update the cluster_config.json file stored in the /opt/UiPathAutomationSuite folder, and rerun the service installer step.
You need to perform these steps only from Server Nodes.
Step 1: Changing the product selection in the configuration file
-
Change the product selection in the configuration file.
To do that, navigate to the
UiPathAutomationSuitefolder and editcluster_config.json.cd /opt/UiPathAutomationSuite nano cluster_config.json #optionally use any favourite editor of your choice.cd /opt/UiPathAutomationSuite nano cluster_config.json #optionally use any favourite editor of your choice. -
In the services list, set the
enableflags totrueorfalsefor the specific services you want to enable or disable. See the following examples for individual products.Note:You can manage Action Center and Apps simply by updating the
enableflag. Other products might require an additional step to configure the installation. See the following instructions for details.
Enabling or disabling Action Center
See the following configuration details for enabling or disabling Action Center in the 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
}
Enabling or Disabling Apps
See the following configuration details for enabling or disabling Apps in the cluster_config.json file:
"apps": {
"enabled": "true" //Set to "false" to disable the Apps
}
"apps": {
"enabled": "true" //Set to "false" to disable the Apps
}
Enabling or Disabling AI Center
AI Center requires updating the enable flag and an SQL database.
If you previously set a value for sql_connection_string_template_jdbc in cluster_config.json, then the default AI Center database name is AutomationSuite_AICenter.
To change the default database name, you need to update the sql_connection_str inside the AI Center field. This overrides the default database and connection string template set in sql_connection_string_template_jdbc.
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 require to override the default database name
}
"aicenter": {
"enabled": "true", //Set to "false" to disable the AICenter
"sql_connection_str": "" //Optional and only require to override the default database name
}
Enabling or disabling Automation Hub
To enable Automation Hub, in the 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
}
To disable Automation Hub, set the enabled flag to false in the automation_hub section of the cluster_config.json file.
Enabling or disabling Automation Ops
Automation Ops requires updating the enable flag and an SQL database.
If you previously set a value for sql_connection_string_template in cluster_config.json, then the default database name for Automation Ops is AutomationSuite_Platform.
To change the default database name, you need to update the sql_connection_str inside the Automation Ops field. This overrides the default database and connection string template set in sql_connection_string_template.
Automation Ops shares a database with the core platform, including Orchestrator. If you change the database here, you update the database for the core platform as well.
See the following configuration details for enabling or disabling Automation Ops in 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
}
Enabling or Disabling Document Understanding
Document Understanding requires updating the enable flag and an SQL database.
If you previously set a value for sql_connection_string_template_odbc in cluster_config.json, then the default database name is AutomationSuite_DU_Datamanager.
To change the default database name, you need to update the 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.
See the following configuration details for enabling or disabling Document Understanding in 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
}
Enabling or Disabling Insights
Insights requires updating the enable flag and an SQL database.
If you previously set a value for sql_connection_string_template in cluster_config.json, then the default database name is AutomationSuite_Insights.
To change the default database name, you need to update the 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.
See the following configuration details for enabling or disabling Insights in 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
}
Enabling or Disabling Task Mining
Task Mining requires update the enable flag and an SQL Database.
If you previously set a value for 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
See the following configuration details for enabling or disabling Task Mining in 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
}
Enabling or Disabling Test Manager
Test Manager requires updating the enable flag and an SQL database.
If you previously set a value for sql_connection_string_template in cluster_config.json, then the default database name is AutomationSuite_Test_Manager.
To change the default database name, you need to update the sql_connection_str inside the Test Manager field. This overrides the default database and connection string template set in sql_connection_string_template.
See the following configuration details for enabling or disabling Test Manager in 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
}
Once you update the configuration file, then proceed to Step 2.
Step 2: Running the installer script to update the new product configuration
Once you update the 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 -s --accept-license-agreement./install-uipath.sh -i cluster_config.json -o output.json -s --accept-license-agreement -
For offline installations:
./install-uipath.sh -i cluster_config.json -o output.json -s --install-type offline --accept-license-agreement./install-uipath.sh -i cluster_config.json -o output.json -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 Document Understanding
- Enabling or Disabling Insights
- Enabling or Disabling Task Mining
- Enabling or Disabling Test Manager
- Step 2: Running the installer script to update the new product configuration