- Overview
- Requirements
- Pre-installation
- Preparing the installation
- Downloading the installation packages
- Configuring the OCI-compliant registry
- Granting installation permissions with cluster roles
- Granting installation permissions without cluster roles
- Installing and configuring the service mesh
- Installing and configuring the GitOps tool
- Installing the External Secrets Operator
- Deploying Redis through OperatorHub
- Applying miscellaneous configurations
- Running uipathctl
- Installation
- Post-installation
- Migration and upgrade
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library installation
- AI Trust Layer
- Troubleshooting
- 500 errors and rate limiting on S3 requests in ODF
- External Secrets troubleshooting
- Configuring CSI driver tolerations for ODF 4.20
- Temporal as a Service troubleshooting
- AI Center and Document Understanding pods fail to start with TLS certificate verification enabled
- Studio Desktop cannot load Integration Service connectors and activities
- TLS certificate validation errors
- Manual ArgoCD NetworkPolicy mitigation (GHSA-47m3-95c7-g2g8)
- Configuring resource requests and limits for uipathctl-created workloads
Managing products
Enable, disable, and manage products in Automation Suite post-installation on OpenShift.
You can enable and disable products in Automation Suite at any point post-installation.
To do that, you must access and update the input.json file and apply the new configuration via uipathctl.
You cannot enable or disable any product during an Automation Suite upgrade.
Step 1: Changing the product selection in the configuration file
-
Change the product selection in the configuration file.
To do that, edit
input.jsonwith the editor of your choice. -
In the services list, set the
enableflags totrueorfalsefor the specific services you want to enable or disable.Note:You can manage Action Center and Apps simply by updating the
enableflag. Other products might require an additional step to configure the installation. Refer to the following instructions for details.The following examples provide configuration details for individual products.
Enabling or disabling Action Center
See the following configuration details for enabling or disabling Action Center in the 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
Apps requires updating the enable flag and an SQL database.
If you previously set a value for sql_connection_string_template_odbc in input.json, then the default database name is AutomationSuite_Apps.
To change the default database name, you need to update the sql_connection_str inside the Apps field. This overrides the default database and connection string template set in sql_connection_string_template_odbc.
See the following configuration details for enabling or disabling Apps in the input.json file:
"apps": {
"enabled": "true" //Set to "false" to disable the Apps
"sql_connection_str": "" ////Optional and only required to override the default database name
}
"apps": {
"enabled": "true" //Set to "false" to disable the Apps
"sql_connection_str": "" ////Optional and only required to override the default database name
}
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 input.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 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
}
Enabling or disabling Agents
To enable Agent Builder, in the agents section of the input.json file, set the enabled flag to true:
"agents": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name - dotnet connection string
}
"agents": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name - dotnet connection string
}
Enabling or disabling AI Trust Layer
To enable all AI Trust Layer components, in the llmgateway and llmobservability sections of the input.json file, set the enabled flag to true:
"llmgateway": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name
},
"llmobservability": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name
"llmgateway": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name
},
"llmobservability": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name
Enabling or disabling Automation Hub
To enable Automation Hub, in the 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 required to override the default database name
}
"automation_hub": {
"enabled": "true" //Set to "false" to disable Automation Hub
"sql_connection_str": "" //Optional and only required to override the default database name
}
To disable Automation Hub, set the enabled flag to false in the automation_hub section of the input.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 input.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 input.json:
"automation_ops": {
"enabled": "true", //Set to "false" to disable the Automation Ops
"sql_connection_str": "" //Optional and only required to override the default database name
}
"automation_ops": {
"enabled": "true", //Set to "false" to disable the Automation Ops
"sql_connection_str": "" //Optional and only required 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 theinput.jsonfile. If you want to enable package caching, make sure to properly configure thepackagecachingandpackagecachefolderflags as well.{ "asrobots": { "enabled": Boolean, "packagecaching": Boolean, "packagecachefolder": String } }{ "asrobots": { "enabled": Boolean, "packagecaching": Boolean, "packagecachefolder": String } }Parameter Default value Description packagecachingtrueWhen set to true, 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.
To disable Automation Suite Robots, disable the asrobots flag in the input.json file.
Enabling or disabling Context Grounding
To enable Context Grounding Service, in the ecs section of the input.json file, set the enabled flag to true:
"ecs": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "", //Optional and only required to override the default database name
"sql_vector_connection_str": "", //Optional and only required to override the default database name
}
"ecs": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "", //Optional and only required to override the default database name
"sql_vector_connection_str": "", //Optional and only required to override the default database name
}
Enabling or disabling Data Service
Data Service requires updating the enable flag and an SQL database.
If you previously set a value for sql_connection_string_template in input.json, then the default database name is AutomationSuite_DataService.
To change the default database name, you need to update the sql_connection_str inside the Data Service 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 Data Service in input.json:
"dataservice": {
"enabled": "true", //Set to "false" to disable the Data Service,
"sql_connection_str": "" //Optional and only required to override the default database name
}
"dataservice": {
"enabled": "true", //Set to "false" to disable the Data Service,
"sql_connection_str": "" //Optional and only required 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 input.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.
See the following configuration details for enabling or disabling Document Understanding in input.json:
"documentunderstanding": {
"enabled": "true", //Set to "false" to disable the Document Understanding
"sql_connection_str": "" //Optional and only required to override the default database name
}
"pyodbc_sql_connection_str": "" //Optional and only required to override the default database name
}
"documentunderstanding": {
"enabled": "true", //Set to "false" to disable the Document Understanding
"sql_connection_str": "" //Optional and only required to override the default database name
}
"pyodbc_sql_connection_str": "" //Optional and only required to override the default database name
}
Enabling or disabling Healing Agent
See the following configuration details for enabling or disabling Healing Agent in the input.json file:
"semanticproxy": {
"enabled": true //Set to "false" to disable
}
"semanticproxy": {
"enabled": true //Set to "false" to disable
}
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 input.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.
To enable the Insights Real-time monitoring feature, set the enable_realtime_monitoring flag to true.
Insights has an optional SMTP configuration to enable receiving email notifications. For details, refer to Configuring input.json.
See the following configuration details for enabling or disabling Insights in 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 required 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 required to override the default database name
}
Enabling or disabling Integration Service
To enable Integration Service, in the 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 required to override the default database name
}
"integrationservices": {
"enabled": "true" //Set to "false" to disable Integration Service
"sql_connection_str": "" //Optional and only required to override the default database name
}
Enabling or disabling MCP Servers
To enable MCP Servers, set the agenthub flag to true in the input.json file.
"agenthub": {
"enabled": "true" //Set to "false" to disable MCP Servers
}
"agenthub": {
"enabled": "true" //Set to "false" to disable MCP Servers
}
To disable MCP Servers, set the agenthub flag to false in the input.json file.
Enabling or disabling Orchestrator
To enable Orchestrator, set the orchestrator flag to true in the input.json file.
"orchestrator": {
"enabled": "true" //Set to "false" to disable Orchestrator
"sql_connection_str": "" //Optional and only required to override the default database name
}
"orchestrator": {
"enabled": "true" //Set to "false" to disable Orchestrator
"sql_connection_str": "" //Optional and only required to override the default database name
}
To disable Orchestrator, set the orchestrator flag to false in the input.json file.
Enabling or disabling Process Mining
If Process Mining is enabled, PostgreSQL is required for the AutomationSuite_Airflow database.
For details, refer to SQL requirements for Process Mining.
To enable Process Mining, make the following changes to the 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": "" } }
To disable Process Mining, disable the processmining flag.
Enabling or disabling ScreenPlay
See the following configuration details for enabling or disabling ScreenPlay in the input.json file:
"semanticproxy": {
"enabled": true //Set to "false" to disable
}
"semanticproxy": {
"enabled": true //Set to "false" to disable
}
Enabling or Disabling Studio Web
To enable Studio Web, in the 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 required 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 required to override the default database name
"project_service_storage_quota": "500Gi" (optional)
"package_service_storage_quota": "300Gi" (optional)
}
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 input.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 input.json:
"test_manager": {
"enabled": "true", //Set to "false" to disable the Test Manager,
"sql_connection_str": "" //Optional and only required to override the default database name
}
"test_manager": {
"enabled": "true", //Set to "false" to disable the Test Manager,
"sql_connection_str": "" //Optional and only required to override the default database name
}
Enabling or disabling Autopilot for Everyone
To enable Autopilot for Everyone, in the autopiloteveryone section of the input.json file, set the enabled flag to true:
"autopiloteveryone": {
"enabled": true //Set to "false" to disable
}
"autopiloteveryone": {
"enabled": true //Set to "false" to disable
}
Enabling or disabling Autopilot for developers
To enable Autopilot for developers, in the a4d section of the input.json file, set the enabled flag to true:
"a4d": {
"enabled": true, //Set to "false" to disable
"sqlalchemy_asyncpg_postgresql_connection_str": "" //Optional and only require to override the default database name - postgresql connection string
}
"a4d": {
"enabled": true, //Set to "false" to disable
"sqlalchemy_asyncpg_postgresql_connection_str": "" //Optional and only require to override the default database name - postgresql connection string
}
Enabling or disabling LLM gateway
To enable LLM gateway, in the llmgateway section of the input.json file, set the enabled flag to true:
"llmgateway": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name - dotnet connection string
}
"llmgateway": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name - dotnet connection string
}
Enabling or disabling LLM observability
To enable LLM observability, in the llmobservability section of the input.json file, set the enabled flag to true:
"llmobservability": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name - dotnet connection string
}
"llmobservability": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "" //Optional and only required to override the default database name - dotnet connection string
}
Enabling or disabling Solutions
To enable Solutions, in the automationsolutions section of the input.json file, set the enabled flag to true:
"automationsolutions": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "", //Optional and only required to override the default database name - dotnet connection string
}
"automationsolutions": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "", //Optional and only required to override the default database name - dotnet connection string
}
Enabling or disabling Maestro
To enable Maestro, in the maestro section of the input.json file, set the enabled flag to true:
"maestro": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "", //Optional and only required to override the default database name - dotnet connection string
}
"maestro": {
"enabled": true, //Set to "false" to disable
"sql_connection_str": "", //Optional and only required to override the default database name - dotnet connection string
}
Enabling or disabling Temporal as a Service (TaaS)
To enable Temporal as a Service (TaaS), in the taas section of the input.json file, set the enabled flag to true:
"taas": {
"enabled": true, //Set to "false" to disable
"temporal": {
"postgresql_connection_str": "", //Optional and only required to override the default database name - postgresql connection string
"postgresql_visibility_connection_str": "" //Optional and only required to override the default database name - postgresql connection string
}
}
"taas": {
"enabled": true, //Set to "false" to disable
"temporal": {
"postgresql_connection_str": "", //Optional and only required to override the default database name - postgresql connection string
"postgresql_visibility_connection_str": "" //Optional and only required to override the default database name - postgresql connection string
}
}
Step 2: Running the installer to update the new product configuration
Once you update the 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:
uipathctl prereq create input.json --versions versions.jsonuipathctl prereq create input.json --versions versions.jsonFor details, refer to Setting up the required resources.
-
To check the prerequisites based on the inputs you configured in the
input.json, run the following command:uipathctl prereq run input.json --versions versions.jsonuipathctl prereq run input.json --versions versions.jsonFor details, refer to Running the prerequisite checks.
-
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 Agents
- Enabling or disabling AI Trust Layer
- Enabling or disabling Automation Hub
- Enabling or disabling Automation Ops
- Enabling or disabling Automation Suite Robots
- Enabling or disabling Context Grounding
- Enabling or disabling Data Service
- Enabling or disabling Document Understanding
- Enabling or disabling Healing Agent
- Enabling or disabling Insights
- Enabling or disabling Integration Service
- Enabling or disabling MCP Servers
- Enabling or disabling Orchestrator
- Enabling or disabling Process Mining
- Enabling or disabling ScreenPlay
- Enabling or Disabling Studio Web
- Enabling or disabling Test Manager
- Enabling or disabling Autopilot for Everyone
- Enabling or disabling Autopilot for developers
- Enabling or disabling LLM gateway
- Enabling or disabling LLM observability
- Enabling or disabling Solutions
- Enabling or disabling Maestro
- Enabling or disabling Temporal as a Service (TaaS)
- Step 2: Running the installer to update the new product configuration