automation-suite
2024.10
true
- Overview
- Requirements
- Pre-installation
- Preparing the installation
- Installing and configuring the service mesh
- Downloading the installation packages
- Configuring the OCI-compliant registry
- Granting installation permissions
- Installing and configuring the GitOps tool
- Deploying Redis through OperatorHub
- Generating the configuration file using a wizard
- input.json example
- Applying miscellaneous configurations
- Running uipathctl
- 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
- Cluster administration
- Product-specific configuration
- Troubleshooting
input.json example

Automation Suite on OpenShift installation guide
Last updated May 16, 2025
input.json example
The following an example shows an
input.json
file with all the products enabled, as well as the mandatory and optional configuration parameters for Automation Suite.
You can use the example as reference and make changes according to your environment requirements.
Note that the minimum UiPath® product selection requires the platform services to be enabled. Make sure to replace FQDNs, hostnames, usernames and passwords, and SQL connection strings with your own configurations.
{
"fqdn": "automationsuite.mycompany.com",
"admin_username": "admin",
"admin_password": "****",
"registries": {
"docker": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "****",
"pull_secret_value": "****"
},
"helm": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "xxxxxx"
}
},
"sql_connection_string_template": "Server=tcp:sql.mycompany.com,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=testadmin@sql.mycompany.com;Password='g%3qI2x2_%NPZE3Dvdm9Ng_@J_a%YB_sV_B4NncOHMuM%RTE';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
"sql_connection_string_template_odbc": "SERVER=sql.mycompany.com;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD={g%3qI2x2_%NPZE3Dvdm9Ng_@J_a%YB_sV_B4NncOHMuM%RTE};;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=sql.mycompany.com",
"sql_connection_string_template_jdbc": "jdbc:sqlserver://sql.mycompany.com;database=DB_NAME_PLACEHOLDER;user=testadmin@sql.mycompany.com;password={UW1zVTc1NkRZYW5IMVFvbFlzdm1rVldrOFA1Y1RRalkK};encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;",
"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sql.mycompany.com:<password>@sql.mycompany.com:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=no&Encrypt=yes",
"postgresql_connection_string_template_sqlalchemy_pyodbc": "postgresql+psycopg2://sa:<passowrd>@135.235.240.165:5432/DB_NAME_PLACEHOLDER",
"orchestrator": {
"enabled": true
},
"profile": "default",
"kubernetes_distribution": "openshift",
"ingress": {
"gateway_selector": {
"istio": "ingressgateway"
},
"ingress_gateway_secret": "istio-ingressgateway-certs",
"namespace": "<istio-system>"
},
"istioMinProtocolVersion": "TLSV1_3",
"argocd": {
"application_namespace": "uipath",
"project": "uipath"
},
"storage_class": "managed-premium",
"storage_class_single_replica": "managed-premium",
"exclude_components": [
"argocd",
"monitoring",
"istio",
"logging",
"gatekeeper",
"network-policies",
"velero",
"alerts",
"cert-manager",
"dapr"
],
"sql": {
"server_url": "sql.mycompany.com",
"port": "1433",
"username": "testadmin",
"password": "****",
"create_db": true
},
"namespace": "uipath",
"fabric": {
"redis": {
"hostname": "redis.mycompany.com",
"port": 6380,
"password": "xxxxx=",
"tls": true
}
},
"external_object_storage": {
"enabled": true,
"storage_type": "s3",
"fqdn": "s3storage.mycompany.com",
"port": 443,
"region": "us-east-2",
"access_key": "***",
"secret_key": "***"
},
"telemetry_optout": true,
"platform": {
"enabled": true
},
"automation_hub": {
"enabled": true
},
"automation_ops": {
"enabled": true
},
"action_center": {
"enabled": true
},
"apps": {
"enabled": true
},
"test_manager": {
"enabled": true
},
"dataservice": {
"enabled": true
},
"aicenter": {
"enabled": true
},
"documentunderstanding": {
"enabled": true
},
"processmining": {
"enabled": true
},
"insights": {
"enabled": true
}
}
{
"fqdn": "automationsuite.mycompany.com",
"admin_username": "admin",
"admin_password": "****",
"registries": {
"docker": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "****",
"pull_secret_value": "****"
},
"helm": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "xxxxxx"
}
},
"sql_connection_string_template": "Server=tcp:sql.mycompany.com,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=testadmin@sql.mycompany.com;Password='g%3qI2x2_%NPZE3Dvdm9Ng_@J_a%YB_sV_B4NncOHMuM%RTE';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
"sql_connection_string_template_odbc": "SERVER=sql.mycompany.com;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD={g%3qI2x2_%NPZE3Dvdm9Ng_@J_a%YB_sV_B4NncOHMuM%RTE};;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=sql.mycompany.com",
"sql_connection_string_template_jdbc": "jdbc:sqlserver://sql.mycompany.com;database=DB_NAME_PLACEHOLDER;user=testadmin@sql.mycompany.com;password={UW1zVTc1NkRZYW5IMVFvbFlzdm1rVldrOFA1Y1RRalkK};encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;",
"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sql.mycompany.com:<password>@sql.mycompany.com:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=no&Encrypt=yes",
"postgresql_connection_string_template_sqlalchemy_pyodbc": "postgresql+psycopg2://sa:<passowrd>@135.235.240.165:5432/DB_NAME_PLACEHOLDER",
"orchestrator": {
"enabled": true
},
"profile": "default",
"kubernetes_distribution": "openshift",
"ingress": {
"gateway_selector": {
"istio": "ingressgateway"
},
"ingress_gateway_secret": "istio-ingressgateway-certs",
"namespace": "<istio-system>"
},
"istioMinProtocolVersion": "TLSV1_3",
"argocd": {
"application_namespace": "uipath",
"project": "uipath"
},
"storage_class": "managed-premium",
"storage_class_single_replica": "managed-premium",
"exclude_components": [
"argocd",
"monitoring",
"istio",
"logging",
"gatekeeper",
"network-policies",
"velero",
"alerts",
"cert-manager",
"dapr"
],
"sql": {
"server_url": "sql.mycompany.com",
"port": "1433",
"username": "testadmin",
"password": "****",
"create_db": true
},
"namespace": "uipath",
"fabric": {
"redis": {
"hostname": "redis.mycompany.com",
"port": 6380,
"password": "xxxxx=",
"tls": true
}
},
"external_object_storage": {
"enabled": true,
"storage_type": "s3",
"fqdn": "s3storage.mycompany.com",
"port": 443,
"region": "us-east-2",
"access_key": "***",
"secret_key": "***"
},
"telemetry_optout": true,
"platform": {
"enabled": true
},
"automation_hub": {
"enabled": true
},
"automation_ops": {
"enabled": true
},
"action_center": {
"enabled": true
},
"apps": {
"enabled": true
},
"test_manager": {
"enabled": true
},
"dataservice": {
"enabled": true
},
"aicenter": {
"enabled": true
},
"documentunderstanding": {
"enabled": true
},
"processmining": {
"enabled": true
},
"insights": {
"enabled": true
}
}