Automation Suite
2023.10
false
- Overview
- Requirements
- Installation
- Prerequisite checks
- Downloading the installation packages
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster migration
- uipathctl cluster migration export
- uipathctl cluster migration import
- uipathctl cluster migration run
- uipathctl cluster upgrade
- uipathctl config
- uipathctl config add-host-admin
- uipathctl config additional-ca-certificates
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config argocd
- uipathctl config argocd ca-certificates
- uipathctl config argocd ca-certificates get
- uipathctl config argocd ca-certificates update
- uipathctl config argocd generate-dex-config
- uipathctl config argocd generate-rbac
- uipathctl config argocd registry
- uipathctl config argocd registry get
- uipathctl config argocd registry update
- uipathctl config enable-basic-auth
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config saml-certificates get
- uipathctl config saml-certificates rotate
- uipathctl config saml-certificates update
- uipathctl config tls-certificates
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl config token-signing-certificates
- uipathctl config token-signing-certificates get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- uipathctl health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test
- uipathctl manifest
- uipathctl manifest apply
- uipathctl manifest diff
- uipathctl manifest get
- uipathctl manifest get-revision
- uipathctl manifest list-applications
- uipathctl manifest list-revisions
- uipathctl manifest render
- uipathctl prereq
- uipathctl prereq create
- uipathctl prereq run
- uipathctl resource
- uipathctl resource report
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- uipathctl version
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite on EKS/AKS
- 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 Orchestrator
- Step 7: Migrating standalone Insights
- Step 8: Deleting the default tenant
- B) Single tenant migration
- Migrating from Automation Suite on Linux to Automation Suite on EKS/AKS
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
Using the Orchestrator Configurator Tool
Automation Suite on EKS/AKS Installation Guide
Last updated Apr 19, 2024
Using the Orchestrator Configurator Tool
The Orchestrator Configurator Tool is a bash script designed to facilitate the placement of files and settings within the
Orchestrator deployment in Automation Suite. It assists in adding storage files, credential store plugins, NLog extensions,
new NLog configuration, and overriding
appSettings
.
Examples of operations that can be performed using this tool include:
The environment where you use the Orchestrator Configurator Tool must be capable of running a bash script and should have the following tools:
- kubectl configured with a connection to the cluster
- jq 1.6
- rclone (installation steps)
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 Orchestrator Configurator Tool from any location, update the
PATH
variable to include <installer-dir>/Tools
, as shown in the following example:
export PATH="$PATH:/opt/UiPathAutomationSuite/online_installer_<version>/Tools"
export PATH="$PATH:/opt/UiPathAutomationSuite/online_installer_<version>/Tools"
Make sure that the version of the
jq
utility is 1.6. If it is not, update it using one of the following options:
-
Option 1:
yum install -y epel-release yum install -y jq
yum install -y epel-release yum install -y jq -
Option 2:
curl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpm jq --version
curl https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/j/jq-1.6-2.el7.x86_64.rpm --output /tmp/jq-1.6-2.el7.x86_64.rpm yum localinstall /tmp/jq-1.6-2.el7.x86_64.rpm jq --version
Usage: ./orchestrator_configurator.sh \
-s blobstoragefolder -p pluginsfolder -n nlogextensionsfolder \
-c appsettings.custom.config -l nlog.custom.config
-k|--encryption-key
the value of the encryption key that will override the key generated at install
-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
--use-external-storage
use external storage instead of in cluster CEPH storage
-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.custom.config -l nlog.custom.config
-k|--encryption-key
the value of the encryption key that will override the key generated at install
-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
--use-external-storage
use external storage instead of in cluster CEPH storage
-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.