automation-suite
2022.4
false
- Overview
- Requirements
- Installation
- Post-installation
- 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
- Using the Orchestrator Configurator Tool
- Cleaning up the Orchestrator database
- 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 bucket
- 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 TX checksum offloading
- How to address weak ciphers in TLS 1.2
- 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
- Pods cannot communicate with FQDN in a proxy environment
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
Using the Orchestrator Configurator Tool

Automation Suite installation guide
Last updated Feb 24, 2025
Using the Orchestrator Configurator Tool
The Orchestrator Configurator Tool is a bash script that allows you to place files and settings inside the Orchestrator deployment
in Automation Suite. The tool helps you add storage files, credential store plugins, NLog extensions, new NLog configurations,
and override
appSettings
.
The environment where you use the Orchestrator Configurator Tool must be able to run a bash script and have the following tools:
- kubectl configured with a connection to the cluster
- jq 1.6
- s3cmd
Important:
Do not download and use the ArgoCD CLI tool independently. To maintain compatibility and ensure smooth operation, we recommend using the ArgoCD we bundle within the Automation Suite artifacts. To do that, you must add ArgoCD to your path from the latest installer by running the following command:
export PATH="$PATH:/opt/UiPathAutomationSuite/<version>/installer/bin"
export PATH="$PATH:/opt/UiPathAutomationSuite/<version>/installer/bin"
To be able to run Orchestraor Configurator Tool from any location, follow these steps:
Example:
Usage: ./orchestrator_configurator.sh \
-s blobstoragefolder -p pluginsfolder -n nlogextensionsfolder \
-c appsettings.json -l nlog.custom.config
-c|--app-settings
application configuration file containing json with key-value structure
-l|--nlog-config-file
nlog config file, json
-s|--storage-folder
location of the storage folder on the local disk
-n|--nlog-extensions-folder
location of the nlog extensions on the local disk
-p|--securestore-plugins-folder
location of the securestore plugins on the local disk
-d|--dry-run
do not update the orchestrator app with the new values
-y|--accept-all
do not prompt for confirmation of actions and overwriting of files with kubectl cp.
Usage: ./orchestrator_configurator.sh \
-s blobstoragefolder -p pluginsfolder -n nlogextensionsfolder \
-c appsettings.json -l nlog.custom.config
-c|--app-settings
application configuration file containing json with key-value structure
-l|--nlog-config-file
nlog config file, json
-s|--storage-folder
location of the storage folder on the local disk
-n|--nlog-extensions-folder
location of the nlog extensions on the local disk
-p|--securestore-plugins-folder
location of the securestore plugins on the local disk
-d|--dry-run
do not update the orchestrator app with the new values
-y|--accept-all
do not prompt for confirmation of actions and overwriting of files with kubectl cp.
To apply new application settings, run the following command:
./orchestrator_configurator.sh -c appsettings.json
./orchestrator_configurator.sh -c appsettings.json
If the
appsettings.json
file does not exist, you can create it yourself, as shown in the following example:
{
"ExampleSetting.Enabled": true,
"ExampleSetting.Type": "BasicExample",
"ExampleSetting.Count": 3
}
{
"ExampleSetting.Enabled": true,
"ExampleSetting.Type": "BasicExample",
"ExampleSetting.Count": 3
}
To change NLog configuration, run the following command:
./orchestrator_configurator.sh -l nlog.custom.json
./orchestrator_configurator.sh -l nlog.custom.json
Example:
{
"Nlog": {
"targets": {
"robotElasticBuffer": {
"flushTimeout": 1000,
"bufferSize": 1000,
"slidingTimeout": false,
"target": {
"uri": "https://elastic.example.com:9200",
"requireAuth": true,
"username": "elastic-user",
"password": "elastic-password",
"index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
"documentType": "logEvent",
"includeAllProperties": true,
"layout": "${message}",
"excludedProperties": "agentSessionId,tenantId,indexName"
}
}
}
}
}
{
"Nlog": {
"targets": {
"robotElasticBuffer": {
"flushTimeout": 1000,
"bufferSize": 1000,
"slidingTimeout": false,
"target": {
"uri": "https://elastic.example.com:9200",
"requireAuth": true,
"username": "elastic-user",
"password": "elastic-password",
"index": "${event-properties:item=indexName}-${date:format=yyyy.MM}",
"documentType": "logEvent",
"includeAllProperties": true,
"layout": "${message}",
"excludedProperties": "agentSessionId,tenantId,indexName"
}
}
}
}
}