automation-suite

2024.10

false

Automation Suite on EKS/AKS installation guide

Last updated Mar 31, 2026

Migration prerequisites

Before starting the migration, make sure you meet the following prerequisites:

.NET Runtime 6.0

.NET Runtime 6.0 or later is required to run the UiPath.OrganizationMigrationApp tool. You must download and install it before running UiPath.OrganizationMigrationApp.

Linux

If.NET Runtime 6.0 or later is not present, download and install.NET Runtime for Linux before using UiPath.OrganizationMigrationApp.

To install.NET Runtime 6.0 on RHEL, run the following command:

sudo yum install dotnet-sdk-6.0 -y
sudo yum install dotnet-sdk-6.0 -y

Windows

The UiPath.OrganizationMigrationApp tool requires.NET Runtime 6.0 at a minimum. If.NET Runtime 6.0 and beyond is not present, download and install.NET Runtime 6.0 for Windows before using UiPath.OrganizationMigrationApp.

Docker/Podman

To complete the migration process, you must use a Docker or Podman client that has been authenticated with the private registry. This allows the migrators to run on the MSI databases, making them compatible with the Automation Suite databases.

Docker

To download the Docker binaries, refer to the Install Docker Engine official documentation.
To authenticate the Docker registry, refer to the docker login official documentation. Alternatively, you can use the following command by replacing the sample credentials with your actual registry credentials:
```
docker login my.registry.io:443 --username "admin" --password "secret"
docker login my.registry.io:443 --username "admin" --password "secret"
```

Podman

To download the Podman binaries, refer to the official Podman Installation Instructions.
To authenticate to the Podman registry, refer to the Podman login official documentation. Alternatively, you can use the following command by replacing the sample credentials with your actual registry credentials:
```
podman login my.registry.io:443 --username "admin" --password "secret"
podman login my.registry.io:443 --username "admin" --password "secret"
```

Orchestrator bucket creation setting

To ensure that Orchestrator buckets are automatically created with the correct CORS policy, you must run the following command. The command requires the jq utility to be installed on your machine.

cd <AS install directory>
rm -f values.json && rm -f appsettings.json
kubectl -n <uipath> get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jq '.' > values.json
jq '.AppSettings' values.json > appsettings.json
jq '.["Storage.CreateBucket.OnTenantCreation.Enabled"] = "true"' appsettings.json > temp.json && mv -f temp.json appsettings.json
uipathctl config orchestrator update-config --app-settings appsettings.json
cd <AS install directory>
rm -f values.json && rm -f appsettings.json
kubectl -n <uipath> get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jq '.' > values.json
jq '.AppSettings' values.json > appsettings.json
jq '.["Storage.CreateBucket.OnTenantCreation.Enabled"] = "true"' appsettings.json > temp.json && mv -f temp.json appsettings.json
uipathctl config orchestrator update-config --app-settings appsettings.json

To install jq, use one of the following options:

Option 1: Run the following command:

yum install -y epel-release yum install -y jq
yum install -y epel-release yum install -y jq

Option 2: Run the following commands:

shell
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
shell
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

Warning:

Failing to enable the Orchestrator setting that ensures buckets are automatically created with the correct CORS policy causes issues with downloading from storage buckets, which you must address by making manual updates to the CORS policy.

To confirm that the setting has been enabled, run the following command:

kubectl -n <uipath> get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jq
kubectl -n <uipath> get cm orchestrator-customconfig -o jsonpath='{.data.values\.json}' | jq

If the setting has been enabled, the command should return the following response:

{
  "AppSettings": {
    "Storage.CreateBucket.OnTenantCreation.Enabled": "true"
  }
}
{
  "AppSettings": {
    "Storage.CreateBucket.OnTenantCreation.Enabled": "true"
  }
}

UiPath.OrganizationMigrationApp

The UiPath.OrganizationMigrationApp tool helps you perform operations such as move the Identity data of all tenants from standalone to Automation Suite and merge organizations.

To download UiPath.OrganizationMigrationApp, see Downloading the installation packages.

To see which UiPath.OrganizationMigrationApp version is compatible with your environment, see Compatibility matrix.

Tool for managing Microsoft SQL Server

You must download and install SQL Server Management Studio (SSMS) or a similar tool for managing Microsoft SQL Server. This tool helps you restore the Orchestrator database to the Automation Suite SQL Server instance or a different SQL Server instance.

Download and install SQL Server Management Studio.
Log into the standalone SQL Server using the standalone SQL connection string.
Open port 1433 for the source and target database.

Special character escape rules for connection string passwords

In most instances, connection passwords are encapsulated within a single quotation mark ('). However, when the password includes special characters such as ` or $, a different approach is required.

In these cases, the password must be formatted as \`"<password>\`", replacing <password> with the actual password. Moreover, you must also adhere to the escape rules as detailed in the following table:

Original format in ADUC	Escaped format in PowerShell string
`cn=James $ Smith`	"cn=James `$ Smith"
`cn=Sally Wilson + Jones`	`"cn=Sally Wilson \+ Jones"`
`cn=William O'Brian`	`"cn=William O'Brian"`
cn=William O`Brian	"cn=William O``Brian"
`cn=Richard #West`	`"cn=Richard #West"`
`cn=Roy Johnson$`	`"cn=Roy Johnson$"`

Example

Assume that the original password is 7'8:<=XMe$y[@vC?_4ZeY8c-~y'W!1dU4gnczuf'/p>j<I. Adhering to the special character escape rules, it becomes: Password=\`"7'8:<=XMe`$y[@vC?_4ZeY8c-~y'W!1dU4```gnczuf'/p>```j<I\`".

The full command, with the password configured in destination connection string, looks as follows:

./UiPath.OrganizationMigrationApp.exe migrate -a -m -s "Server=tcp:abc.com,1433;Initial Catalog=UiPath_20230531;Persist Security Info=False;User ID=username;Password=asiodhyf;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;" -d "Server=tcp:cde.net,1433;Initial Catalog=AutomationSuite_Platform;Persist Security Info=False;User Id=testadmin@sfdev3980732-sql.database.windows.net;Password=\`"7'8:<=XMe`$y[@vC?_4ZeY8c-~y'W!1dU4```gnczuf'/p>```j<I\`""
./UiPath.OrganizationMigrationApp.exe migrate -a -m -s "Server=tcp:abc.com,1433;Initial Catalog=UiPath_20230531;Persist Security Info=False;User ID=username;Password=asiodhyf;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;" -d "Server=tcp:cde.net,1433;Initial Catalog=AutomationSuite_Platform;Persist Security Info=False;User Id=testadmin@sfdev3980732-sql.database.windows.net;Password=\`"7'8:<=XMe`$y[@vC?_4ZeY8c-~y'W!1dU4```gnczuf'/p>```j<I\`""

Note:

Ensure that the command only gets executed on a machine that has authorized access to the RDS database.

Administrator group configuration requirement

Before starting the migration, you must add the Administrator group in every tenant.

If you are performing an organization merge and the Administrator group is not added in all tenants, you can lock yourself out of the Orchestrator instance after the merge completes.

Adding the Administrator group in each tenant ensures that administrative access is preserved throughout the migration and merge process.

Test Manager migration script

The Test Manager migration script (testmanager_migrator.sh) helps you to perform multiple automatic operations for migrating various configurations and files, such as:

Execute kubectl operations, such as updating secrets and configurations maps.
Perform ArgoCD synchronizations via the CLI.
Override configuration settings and restart deployments.
Add storage files to the Ceph object store.
Restore and update the DataEncryptionKey in the Kubernetes secrets from the MSI instance.
Synchronize Test Manager in ArgoCD.
Migrate folders or files from a Windows file store to the destination object store, creating the required directory hierarchy in the bucket defined by Kubernetes secrets.

Environment requirements to run the Test Manager migration script

To successfully run the Test Manager migration script you need to ensure you meet the following environment requirements:

Configure kubectl with a connection to the Automation Suite cluster.

Important:
Ensure that kubeconfig is set as an environment variable.
Install the jq utility using the following command yum install jq.
Install the argocd CLI. Visit Installing Argo CD for more information.
Install Rclone. Visit the RClone documentation for more information.

Note:
Minimum required version for Rclone is 1.56.0.

Note:

If your Identity is managed in Azure, then make sure you run the script using an Azure machine.

Common Test Manager migration script commands

Check the following commands that you can perform using the Test Manager migration script:

 ./testmanager_migrator.sh -d -y \
  -k \"enc key value\" \
  -s blobstoragefolder
    -k|--encryption-key
        The value of the encryption key that will override the key generated during installation.
    -s|--storage-folder
        The location of the storage folder on the local disk.
    -is-|--use-incluster-storage
        Use in cluster Ceph object store.
    -d|--dry-run
        Do not update Test Manager with the new values
    -y|--accept-all
        Do not prompt for confirmation of actions
 ./testmanager_migrator.sh -d -y \
  -k \"enc key value\" \
  -s blobstoragefolder
    -k|--encryption-key
        The value of the encryption key that will override the key generated during installation.
    -s|--storage-folder
        The location of the storage folder on the local disk.
    -is-|--use-incluster-storage
        Use in cluster Ceph object store.
    -d|--dry-run
        Do not update Test Manager with the new values
    -y|--accept-all
        Do not prompt for confirmation of actions

Was this page helpful?

PREVIOUSPerforming a full migration

NEXTMigration compatibility matrix

Automation Suite on EKS/AKS installation guide

.NET Runtime 6.0​

Linux​

Windows​

Docker/Podman​

Docker​

Podman​

Orchestrator bucket creation setting​

UiPath.OrganizationMigrationApp​

Tool for managing Microsoft SQL Server​

Special character escape rules for connection string passwords​

Example​

Administrator group configuration requirement​

Test Manager migration script​

Environment requirements to run the Test Manager migration script​

Common Test Manager migration script commands​