- Overview
- Requirements
- Pre-installation
- Installation
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite
- 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: Deleting the default tenant
- Performing a single tenant migration
- Migrating between Automation Suite clusters
- Migrating from Automation Suite on EKS/AKS to Automation Suite on OpenShift
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
- The backup setup does not work due to a failure to connect to Azure Government
- Pods in the uipath namespace stuck when enabling custom node taints
- Unable to launch Automation Hub and Apps with proxy setup
- Robot cannot connect to an Automation Suite Orchestrator instance
- Log streaming does not work in proxy setups
- Velero backup fails with FailedValidation error
- Accessing FQDN returns RBAC: access denied error

Automation Suite on EKS/AKS installation guide
You can enable and disable products in Automation Suite at any point post-installation.
input.json file and apply the new configuration via uipathctl.Enabling or disabling Action Center
input.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
enable flag and an SQL database.
sql_connection_string_template_odbc in
input.json, then the default database name
is AutomationSuite_Apps.
sql_connection_str inside the Apps field. This overrides the default database and connection string template set in sql_connection_string_template_odbc.
input.json file:
"apps": {
"enabled": "true" //Set to "false" to disable the Apps
"sql_connection_str": "" ////Optional and only require to override the default database name
}"apps": {
"enabled": "true" //Set to "false" to disable the Apps
"sql_connection_str": "" ////Optional and only require to override the default database name
}Enabling or disabling AI Center
enable flag and an SQL database.
sql_connection_string_template_jdbc in input.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.
input.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
}AI Center installed in Automation Suite on AKS/EKS cannot connect to an external Orchestrator.
Enabling or disabling Automation Hub
automation_hub section of the input.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 input.json file.
Enabling or disabling Automation Ops
enable flag and an SQL database.
sql_connection_string_template in input.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.
input.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 Automation Suite Robots
Before enabling Automation Suite Robots, make sure you meet the requirements.
To enable Automation Suite Robots, take the following steps:
-
Enable the
asrobotsflag in thefile. If you want to enable package caching, make sure to properly configure theinput.jsonpackagecachingandpackagecachefolderflags as well.{ "asrobots": { "enabled": Boolean, "packagecaching": Boolean, "packagecachefolder": String } }{ "asrobots": { "enabled": Boolean, "packagecaching": Boolean, "packagecachefolder": String } }Parameter
Default value
Description
packagecachingtrueWhen set totrue, robots use a local cache for package resolution.packagecachefolder/uipath_asrobots_package_cacheThe 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 10GB 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.
asrobots flag in the input.json file.
Enabling or disabling Data Service
enable flag and an SQL database.
sql_connection_string_template in input.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.
input.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
}Enabling or disabling Document Understanding
enable flag and an SQL database.
sql_connection_string_template_odbc in
input.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.
input.json:
"documentunderstanding": {
"enabled": true,
"sql_connection_str": "***" // dotnet connection string,
"datamanager": {
"sql_connection_str": "***" // odbc connection string
"pyodbc_sql_connection_str": "***" // python sql connection string
}
}"documentunderstanding": {
"enabled": true,
"sql_connection_str": "***" // dotnet connection string,
"datamanager": {
"sql_connection_str": "***" // odbc connection string
"pyodbc_sql_connection_str": "***" // python sql connection string
}
}Enabling or disabling Insights
enable flag and an SQL database.
sql_connection_string_template in input.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.
enable_realtime_monitoring flag to true.
Insights has an optional SMTP configuration to enable receiving email notifications. For details, see Configuring input.json.
input.json:
"insights": {
"enabled": "true", //Set to "false" to disable the Insights,
"enable_realtime_monitoring": "false", //Set to "true" to enable Insights Real-time monitoring,
"sql_connection_str": "" //Optional and only require to override the default database name
}"insights": {
"enabled": "true", //Set to "false" to disable the Insights,
"enable_realtime_monitoring": "false", //Set to "true" to enable Insights Real-time monitoring,
"sql_connection_str": "" //Optional and only require to override the default database name
}Enabling or disabling Integration Service
integrationservices section of the input.json file, set the enabled flag to true:
"integrationservices": {
"enabled": "true" //Set to "false" to disable Integration Service
"sql_connection_str": "" //Optional and only require to override the default database name
}"integrationservices": {
"enabled": "true" //Set to "false" to disable Integration Service
"sql_connection_str": "" //Optional and only require to override the default database name
}Enabling or disabling Orchestrator
orchestrator flag to true in
the input.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 input.json file.
Enabling or disabling Process Mining
input.json file:
- Enable the
processminingflag. -
Configure the following connection string templates:
sql_connection_string_templatesql_connection_string_template_jdbcsql_connection_string_template_odbcsql_connection_string_template_sqlalchemy_pyodbc
-
Add a separate connection string for the second SQL Server:
"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.
Enabling or Disabling Studio Web
EKS
studioweb section of the input.json file, set the enabled flag to
true.
"studioweb": {
"enabled": "true" //Set to "false" to disable Studio Web
"sql_connection_str": "" //Optional and only require to override the default database name"studioweb": {
"enabled": "true" //Set to "false" to disable Studio Web
"sql_connection_str": "" //Optional and only require to override the default database nameAKS
studioweb section of the input.json file, set the enabled flag to
true.
Storage quotas for project and package services use default values if other values are not defined. Make sure to define only values that are higher than the default values:
"studioweb": {
"enabled": "true" //Set to "false" to disable Studio Web
"sql_connection_str": "" //Optional and only require to override the default database name
"project_service_storage_quota": "500Gi" (optional)
"package_service_storage_quota": "300Gi" (optional)"studioweb": {
"enabled": "true" //Set to "false" to disable Studio Web
"sql_connection_str": "" //Optional and only require to override the default database name
"project_service_storage_quota": "500Gi" (optional)
"package_service_storage_quota": "300Gi" (optional)Enabling or disabling Task Mining
enable flag and an SQL Database.
sql_connection_string_template in input.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.
input.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_nodenamecommand. - Run the command
kubectl taint nodes task-mining_nodename task.mining/cpu=present:NoSchedule-. - Check taint has disappeared using
kubectl describe node task-mining_nodenamecommand.
Enabling or disabling Test Manager
enable flag and an SQL database.
sql_connection_string_template in input.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.
input.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
}input.json, run the following commands with the uipathctl installer to update the service configuration:
- Run the following command to get an output of what changes will be made to the cluster:
# uipathctl manifest apply --dry-run input.json --versions versions.json# uipathctl manifest apply --dry-run input.json --versions versions.json - To allow the installer to generate configurations, run the following command:For more details, refer to Generating configurations automatically.
uipathctl prereq create input.json --versions versions.jsonuipathctl prereq create input.json --versions versions.json - To check the prerequisites based on the inputs you configured in the
input.json, run the following command:For more details, refer to Checking the prerequisites.uipathctl prereq run input.json --versions versions.jsonuipathctl prereq run input.json --versions versions.json - To apply the changes on the cluster, run:
# uipathctl manifest apply input.json --versions versions.json --log-level info --skip-helm# uipathctl manifest apply input.json --versions versions.json --log-level info --skip-helm
- 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 Integration Service
- Enabling or disabling Orchestrator
- Enabling or disabling Process Mining
- Enabling or Disabling Studio Web
- Enabling or disabling Task Mining
- Enabling or disabling Test Manager
- Step 2: Running the installer to update the new product configuration