- Overview
- Requirements
- Installation
- Post-installation
- Accessing Automation Suite
- Managing the Certificates
- Resizing PVC
- Updating the SQL connection strings
- Cluster administration
- Managing products
- Managing the cluster in ArgoCD
- Setting up the external NFS server
- Automated: Enabling the Backup on the Cluster
- Automated: Disabling the Backup on the Cluster
- Automated, Online: Restoring the Cluster
- Automated, Offline: Restoring the Cluster
- Manual: Enabling the Backup on the Cluster
- Manual: Disabling the Backup on the Cluster
- Manual, Online: Restoring the Cluster
- Manual, Offline: Restoring the Cluster
- Additional configuration
- Migrating objectstore from persistent volume to raw disks
- Monitoring and alerting
- Migration and upgrade
- Migration options
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone product database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the migrated product connection strings
- Step 6: Migrating standalone Insights
- Step 7: Deleting the default tenant
- B) Single tenant migration
- 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 clear Redis data
- How to enable Istio logging
- How to manually clean up logs
- How to clean up old logs stored in the sf-logs bundle
- How to disable streaming logs for AI Center
- How to debug failed Automation Suite installations
- How to delete images from the old installer after upgrade
- How to automatically clean up Longhorn snapshots
- How to disable NIC 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
- First installation fails during Longhorn setup
- SQL connection string validation error
- Prerequisite check for selinux iscsid module fails
- Azure disk not marked as SSD
- Failure After Certificate Update
- Automation Suite not working after OS upgrade
- Automation Suite Requires Backlog_wait_time to Be Set 1
- Volume unable to mount due to not being ready for workloads
- RKE2 fails during installation and upgrade
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- Failure to Resize Objectstore PVC
- Rook Ceph or Looker pod stuck in Init state
- StatefulSet volume attachment error
- Failure to create persistent volumes
- Storage reclamation patch
- Backup failed due to TooManySnapshots error
- All Longhorn replicas are faulted
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- Cannot Log in After Migration
- 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).
- Alarm Received for Failed Kerberos-tgt-update Job
- SSPI Provider: Server Not Found in Kerberos Database
- Login Failed for User <ADDOMAIN><aduser>. Reason: The Account Is Disabled.
- ArgoCD login failed
- 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
- After the Initial Install, ArgoCD App Went Into Progressing State
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unexpected Inconsistency; Run Fsck Manually
- Degraded MongoDB or Business Applications After Cluster Restore
- Missing Self-heal-operator and Sf-k8-utils Repo
- Unhealthy Services After Cluster Restore or Rollback
- RabbitMQ pod stuck in CrashLoopBackOff
- Prometheus in CrashloopBackoff state with out-of-memory (OOM) error
- Missing Ceph-rook metrics from monitoring dashboards
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
Updating the SQL connection strings
There are multiple scenarios where you may want to update the connection string used by Automation Suite products to connect to the SQL database, such as the following:
- When periodically rotating the password used to connect to the database, for security and compliance;
- When changing the FQDN for the SQL server;
- When migrating the database to another SQL server for maintenance purposes;
- When adding, modifying, or removing one or more connection attributes, such as
MultiSubnetFailover
; - When switching from basic authentication to integrated authentication using Kerberos and AD.
Important:
Products in Automation Suite do not create tables or schema at the time of updating the SQL database connection string. Make sure your new connection string refers to the same database that you currently use.
To avoid downtime during the update process, make sure that your current connection string is valid at the time of the update process. You can revoke your old connection string after the update.
- Generate the
cluster_config.json
file. - Provide the new connection strings for the installed products.
- Run the service installer.
Generate the latest cluster_config.json file as follows:
-
A: If you have the old
cluster_config.json
, generate the configuration file from the cluster using the following command:cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o ./cluster_config.json
cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -i /path/to/old/cluster_config.json -o ./cluster_config.json -
B: If you do not have the old
cluster_config.json
file, generate an override of any default values resulted during the installation of the previous version using the following command:cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -o ./cluster_config.json
cd /opt/UiPathAutomationSuite/{version}/installer ./configureUiPathAS.sh config get -o ./cluster_config.json
There are two ways to provide the connection strings for products running in Automation Suite:
-
A: Provide a connection string template that will be common to all the products running in Automation Suite. This approach will assume the default database names for all the products.
-
B: Provide connection strings specific to each product.
Make sure you escape NET, JDBC, or ODBC passwords as follows:
-
for NET: add
'
at the beginning and end of the password, and double any other'
. -
for JDBC/ODBC: add
{
at the beginning of the password and}
at the end, and double any other}
.
TrustServerCertificate=False
, then you may have to provide an additional CA certificate for the SQL Server. This is required if the SQL Server certificate
is self-signed or signed by an internal CA. For details, see Updating the CA certificates.
A: Providing a common connection string for all products
All the products running in Automation Suite refer to a common template connection string. One use case for choosing this method would be when you want to change the password for all the products at once. Note that, in this case, the password will be the same for all the products.
In this scenarios, the database names for all products must be the default ones, as required by Automation Suite. If the database names you configured do not meet the Automation Suite requirements, follow the next step.
Check the list of the databases and their default names:
-
Single-node evaluation: Configuring Microsoft SQL server
-
Multi-node HA-ready production: Configuring Microsoft SQL Server
The following table explains which template format the product services accept:
Parameter |
Description |
Products |
---|---|---|
|
Full ADO.NET connection string where Catalog name is set to
DB_NAME_PLACEHOLDER . The installer will replace this placeholder with the default database names for the installed suite services.
|
Platform, Orchestrator, Test Manager, Automation Hub, Automation Ops, Insights, Task Mining, Data Service |
|
Full JDBC connection string where database name is set to
DB_NAME_PLACEHOLDER . The installer will replace this placeholder with the default database names for the installed suite services.
|
AI Center |
|
Full ODBC connection string where database name is set to
DB_NAME_PLACEHOLDER . The installer will replace this placeholder with the default database names for the installed suite services.
|
Document Understanding |
Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=testadmin;Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;
Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=testadmin;Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;
sql_connection_string_template_jdbc example
jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;Connection Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"
jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;Connection Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"
sql_connection_string_template_odbc example
SERVER=sfdev1804627-c83f074b-sql.database.windows.net,1433;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"
SERVER=sfdev1804627-c83f074b-sql.database.windows.net,1433;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"
cluster_config.json
with the new connection string template you want to update.
B: Providing connection strings specific to each product
Platform
AutomationSuite_Platform
.
cluster_config.json
file:
"platform": {
"sql_connection_str": "***" // dotnet connection string
}
"platform": {
"sql_connection_str": "***" // dotnet connection string
}
Orchestrator
AutomationSuite_Orchestrator
.
cluster_config.json
file:
"orchestrator": {
"sql_connection_str": "***" // dotnet connection string
}
"orchestrator": {
"sql_connection_str": "***" // dotnet connection string
}
Automation Hub
AutomationSuite_Automation_Hub
.
cluster_config.json
file:
"automation_hub": {
"sql_connection_str": "***" // dotnet connection string
}
"automation_hub": {
"sql_connection_str": "***" // dotnet connection string
}
Automation Ops
AutomationSuite_Platform
.
cluster_config.json
file:
"automation_ops": {
"sql_connection_str": "***" // dotnet connection string
}
"automation_ops": {
"sql_connection_str": "***" // dotnet connection string
}
AI Center
AutomationSuite_AICenter
.
cluster_config.json
file:
"aicenter": {
"sql_connection_str": "***" // jdbc connection string
}
"aicenter": {
"sql_connection_str": "***" // jdbc connection string
}
Data Service
AutomationSuite_DataService
.
cluster_config.json
file:
"dataservice": {
"sql_connection_str": "***" // dotnet connection string
}
"dataservice": {
"sql_connection_str": "***" // dotnet connection string
}
Document Understanding
AutomationSuite_DU_Datamanager
.
cluster_config.json
file:
"documentunderstanding": {
"datamanager": {
"sql_connection_str": "***" // odbc connection string
}
}
"documentunderstanding": {
"datamanager": {
"sql_connection_str": "***" // odbc connection string
}
}
Insights
AutomationSuite_Insights
.
cluster_config.json
file:
"insights": {
"sql_connection_str": "***" // dotnet connection string
}
"insights": {
"sql_connection_str": "***" // dotnet connection string
}
Task Mining
AutomationSuite_Task_Mining
.
cluster_config.json
file:
"task_mining": {
"sql_connection_str": "***" // dotnet connection string
}
"task_mining": {
"sql_connection_str": "***" // dotnet connection string
}
Test Manager
AutomationSuite_Test_Manager
.
cluster_config.json
file:
"test_manager": {
"sql_connection_str": "***" // dotnet connection string
}
"test_manager": {
"sql_connection_str": "***" // dotnet connection string
}
Online
To run the service installer in an online environment, use the following command:
cd /opt/UiPathAutomationSuite/{version}/installer
./install-uipath.sh -i ./cluster_config.json -s -o output.json --accept-license-agreement
cd /opt/UiPathAutomationSuite/{version}/installer
./install-uipath.sh -i ./cluster_config.json -s -o output.json --accept-license-agreement
Offline
To run the service installer in an offline environment, use the following command:
cd /opt/UiPathAutomationSuite/{version}/installer
./install-uipath.sh -i ./cluster_config.json -s --install-type offline -o output.json --accept-license-agreement
cd /opt/UiPathAutomationSuite/{version}/installer
./install-uipath.sh -i ./cluster_config.json -s --install-type offline -o output.json --accept-license-agreement
This step is necessary only if you modified the SQL connection strings for Test Manager or Document Understanding.
- Get the list of all Test Manager/Document Understanding
pods:
// for Test Manager kubectl get pods -A | grep testmanager | awk '{print $2}' //for Document Understanding kubectl get pods -A | grep du-datamanager | awk '{print $2}'
// for Test Manager kubectl get pods -A | grep testmanager | awk '{print $2}' //for Document Understanding kubectl get pods -A | grep du-datamanager | awk '{print $2}' - Delete all listed pods. This forces the pods to restart with the correct SQL connection
string.
kubectl delete pods <pod name>
kubectl delete pods <pod name>