UiPath Documentation
automation-suite
2023.10
false
UiPath logo, featuring letters U and I in white

Automation Suite on Linux installation guide

Last updated Mar 26, 2026

Step 5: Updating the migrated product connection strings

Downloading uipathctl

uipathctl is included in the as-installer.zip installation package. To download installer.zip, see Downloading the installation packages.

Generating the configuration file

To generate the cluster_config.json configuration file, take one of the following steps:

  • Option A: Generate the latest cluster_config.json file:
    uipathctl manifest get-revision | Out-File -Encoding ascii cluster_config.json
    uipathctl manifest get-revision | Out-File -Encoding ascii cluster_config.json
    
  • Option B: List all the past cluster_config.json files and determine which one you want to choose:
    uipathctl manifest list-revisions
    uipathctl manifest list-revisions
    

Replacing the connection string and starting the installation

  1. Move the versions.json file to the same directory as cluster_config.json. You can get versions.json from the Automation Suite installation folder.

  2. Provide the new connection strings for the installed products.

    • To provide the restored connection string to the Orchestrator service, add or update sql_connection_str under orchestrator in the cluster_config.json file:
      "orchestrator": {
        "sql_connection_str": "<restored orchesrator connection string>",   (added line)
        "enabled": true
      }
      "orchestrator": {
        "sql_connection_str": "<restored orchesrator connection string>",   (added line)
        "enabled": true
      }
      
    • If Test Automation tables are placed inside the standalone Orchestrator database, you can also add the same connection string for Test Automation feature inside the cluster_config.json file:
      "orchestrator": {
        "testautomation": {
          "enabled": true,
          "sql_connection_str": "<restored orchestrator connection string>"
        },
        "sql_connection_str": "<restored orchestrator connection string>",   (added line)
        "enabled": true
      }
      "orchestrator": {
        "testautomation": {
          "enabled": true,
          "sql_connection_str": "<restored orchestrator connection string>"
        },
        "sql_connection_str": "<restored orchestrator connection string>",   (added line)
        "enabled": true
      }
      
    • If Test Automation tables are not placed inside the standalone Orchestrator database, you have to add or update sql_connection_str under testautomation in the cluster_config.json:
      "testautomation": {
         "enabled": true,   
         "sql_connection_str": "<restored test-automation connection string>",  (added line)
      }
      "testautomation": {
         "enabled": true,   
         "sql_connection_str": "<restored test-automation connection string>",  (added line)
      }
      
    • To provide the restored connection string to the Insights service, add or update sql_connection_str under insights in the cluster_config.json file.
      "insights": {   
         "sql_connection_str": "<restored connection string>",   (added line)
         "enabled": true }
      "insights": {   
         "sql_connection_str": "<restored connection string>",   (added line)
         "enabled": true }
      
    • To provide the restored connection string to the Test Manager service, add or update sql_connection_str under test_manager in the cluster_config.json file.
      "test_manager": {
        "sql_connection_str": "<restored test_manager connection string>",   (added line)
        "enabled": true
      }
      "test_manager": {
        "sql_connection_str": "<restored test_manager connection string>",   (added line)
        "enabled": true
      }
      
  3. Update the cluster_config.json file by running the installer.

    • To migrate Orchestrator only, run the following command:
      uipathctl manifest apply cluster_config.json --only orchestrator --versions versions.json
      uipathctl manifest apply cluster_config.json --only orchestrator --versions versions.json
      
    • To migrate Insights only, run the following command:
      uipathctl manifest apply cluster_config.json --only insights --versions versions.json
      uipathctl manifest apply cluster_config.json --only insights --versions versions.json
      
    • To migrate Test Manager only, run the following command:
      ./bin/uipathctl manifest apply cluster_config.json --only test_manager --versions versions/helm-chart.json
      ./bin/uipathctl manifest apply cluster_config.json --only test_manager --versions versions/helm-chart.json
      
  4. Remap the organization IDs in the Insights tables. For more details, see Remapping the organization IDs.

  5. Run the Test Manager migration script and provide the necessary parameters:

    ./testmanager_migrator.sh -k <encryption_key> -y
    ./testmanager_migrator.sh -k <encryption_key> -y
    
    1. To migrate the Test Automation module, as part of Orchestrator, run the following command:
      ./bin/uipathctl manifest apply cluster_config.json --only testautomation --versions versions/helm-chart.json
      ./bin/uipathctl manifest apply cluster_config.json --only testautomation --versions versions/helm-chart.json
      

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated