automation-suite
2.2510
true
Automation Suite on OpenShift installation guide
- 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
input.json example
Complete input.json configuration example for Automation Suite installation on OpenShift.
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": "<your-password>",
"registries": {
"docker": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "<your-password>",
"pull_secret_value": "<your-pull-secret>"
},
"helm": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "<your-password>"
}
},
"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='<your-password>';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={<your-password>};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={<your-password>};encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;",
"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sql.mycompany.com:<your-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:<your-password>@135.235.240.165:5432/DB_NAME_PLACEHOLDER",
"postgresql_connection_string_template_sqlalchemy_asyncpg": "postgresql+asyncpg://sa:<password>@135.235.240.165:5432/DB_NAME_PLACEHOLDER",
"orchestrator": {
"enabled": true
},
"profile": "default",
"network": {
"ipv4": { "enabled": true },
"ipv6": { "enabled": true }
},
"kubernetes_distribution": "openshift",
"ingress": {
"gateway_selector": {
"istio": "ingressgateway"
},
"ingress_gateway_secret": "istio-ingressgateway-certs",
"namespace": "<istio-system>",
"istio_gateway_service_name": "istio-ingressgateway"
},
"istioMinProtocolVersion": "TLSV1_3",
"argocd": {
"application_namespace": "uipath",
"project": "uipath"
},
"storage_class": "managed-premium",
"storage_class_single_replica": "managed-premium",
"storage_class_name_with_rwx_support": "managed-premium",
"exclude_components": [
"argocd",
"monitoring",
"istio",
"istio-configure",
"logging",
"gatekeeper",
"network-policies",
"velero",
"alerts",
"cert-manager",
"external-secrets"
],
"sql": {
"server_url": "sql.mycompany.com",
"port": "1433",
"username": "testadmin",
"password": "<your-password>",
"create_db": true
},
"namespace": "uipath",
"fabric": {
"redis": {
"hostname": "redis.mycompany.com",
"port": 6380,
"password": "<your-password>",
"tls": true
}
},
"external_object_storage": {
"enabled": true,
"storage_type": "s3",
"fqdn": "s3storage.mycompany.com",
"port": 443,
"region": "us-east-2",
"access_key": "<your-access-key>",
"secret_key": "<your-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
},
"semanticproxy": {
"enabled": true
},
"insights": {
"enabled": true
},
"ecs": {
"enabled": true
},
"llmgateway": {
"enabled": true,
},
"llmobservability": {
"enabled": true,
},
"automationsolutions": {
"enabled": true,
},
"autopiloteveryone": {
"enabled": true,
},
"maestro": {
"enabled": true,
},
"taas": {
"enabled": true
},
},
"a4d": {
"enabled": true,
}
}
{
"fqdn": "automationsuite.mycompany.com",
"admin_username": "admin",
"admin_password": "<your-password>",
"registries": {
"docker": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "<your-password>",
"pull_secret_value": "<your-pull-secret>"
},
"helm": {
"url": "registry.mycompany.com",
"username": "registryuser",
"password": "<your-password>"
}
},
"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='<your-password>';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={<your-password>};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={<your-password>};encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;",
"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sql.mycompany.com:<your-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:<your-password>@135.235.240.165:5432/DB_NAME_PLACEHOLDER",
"postgresql_connection_string_template_sqlalchemy_asyncpg": "postgresql+asyncpg://sa:<password>@135.235.240.165:5432/DB_NAME_PLACEHOLDER",
"orchestrator": {
"enabled": true
},
"profile": "default",
"network": {
"ipv4": { "enabled": true },
"ipv6": { "enabled": true }
},
"kubernetes_distribution": "openshift",
"ingress": {
"gateway_selector": {
"istio": "ingressgateway"
},
"ingress_gateway_secret": "istio-ingressgateway-certs",
"namespace": "<istio-system>",
"istio_gateway_service_name": "istio-ingressgateway"
},
"istioMinProtocolVersion": "TLSV1_3",
"argocd": {
"application_namespace": "uipath",
"project": "uipath"
},
"storage_class": "managed-premium",
"storage_class_single_replica": "managed-premium",
"storage_class_name_with_rwx_support": "managed-premium",
"exclude_components": [
"argocd",
"monitoring",
"istio",
"istio-configure",
"logging",
"gatekeeper",
"network-policies",
"velero",
"alerts",
"cert-manager",
"external-secrets"
],
"sql": {
"server_url": "sql.mycompany.com",
"port": "1433",
"username": "testadmin",
"password": "<your-password>",
"create_db": true
},
"namespace": "uipath",
"fabric": {
"redis": {
"hostname": "redis.mycompany.com",
"port": 6380,
"password": "<your-password>",
"tls": true
}
},
"external_object_storage": {
"enabled": true,
"storage_type": "s3",
"fqdn": "s3storage.mycompany.com",
"port": 443,
"region": "us-east-2",
"access_key": "<your-access-key>",
"secret_key": "<your-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
},
"semanticproxy": {
"enabled": true
},
"insights": {
"enabled": true
},
"ecs": {
"enabled": true
},
"llmgateway": {
"enabled": true,
},
"llmobservability": {
"enabled": true,
},
"automationsolutions": {
"enabled": true,
},
"autopiloteveryone": {
"enabled": true,
},
"maestro": {
"enabled": true,
},
"taas": {
"enabled": true
},
},
"a4d": {
"enabled": true,
}
}