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:

• Configuring appSettings

• Configuring NLog

• Overriding cluster-level storage configuration

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

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"

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

• 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

Usage example

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.