Automation Suite on Linux installation guide

Step 1: Changing the product selection in the configuration file​

1. Change the product selection in the configuration file.

   To do that, navigate to the UiPathAutomationSuite folder and edit cluster_config.json.

   assignment

   cd /opt/UiPathAutomationSuite
   nano cluster_config.json #optionally use any favourite editor of your choice.
   cd /opt/UiPathAutomationSuite
   nano cluster_config.json #optionally use any favourite editor of your choice.
   

2. In the services list, set the enable flags to true or false for the specific services you want to enable or disable. See the following examples for individual products.

   Note:

   You can manage Action Center and Apps simply by updating the enable flag. Other products might require an additional step to configure the installation. See the following instructions for details.

Enabling or disabling Action Center​

"actioncenter": {
  "enabled": "true" //Set to "false" to disable the Action Center
}
"actioncenter": {
  "enabled": "true" //Set to "false" to disable the Action Center
}

Enabling or disabling Apps​

"apps": {
  "enabled": "true" //Set to "false" to disable the Apps
  "sql_connection_str": "" ////Optional and only require to override the default database name
}
"apps": {
  "enabled": "true" //Set to "false" to disable the Apps
  "sql_connection_str": "" ////Optional and only require to override the default database name
}

Enabling or disabling AI Center​

• If AI Center does not require an external Orchestrator, see the following configuration details for enabling or disabling AI Center in cluster_config.json:

  assignment

  "aicenter": {
    "enabled": "true", //Set to "false" to disable the AICenter
    "sql_connection_str": "" //Optional and only required to override the default database name
  }
  "aicenter": {
    "enabled": "true", //Set to "false" to disable the AICenter
    "sql_connection_str": "" //Optional and only required to override the default database name
  }
  

• If AI Center requires an external Orchestrator, see the following configuration details for enabling or disabling AI Center in cluster_config.json:

  assignment

  "aicenter": {
      "enabled": "true", //Set to "false" to disable the AI Center
      "sql_connection_str": "" //Optional and only required to override the default database name
      "orchestrator_url": "https://orchestrator.example.com", //Specify the Orchestrator URL for AI Center
      "identity_server_url": "https://orchestrator.example.com/identity", //Specify the Identiy URL for AI Center
      "orchestrator_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to the Orchestrator certificate
      "identity_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to Identity certificate file
      "metering_api_key": "test" //Specify the metering API key
    }
  "aicenter": {
      "enabled": "true", //Set to "false" to disable the AI Center
      "sql_connection_str": "" //Optional and only required to override the default database name
      "orchestrator_url": "https://orchestrator.example.com", //Specify the Orchestrator URL for AI Center
      "identity_server_url": "https://orchestrator.example.com/identity", //Specify the Identiy URL for AI Center
      "orchestrator_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to the Orchestrator certificate
      "identity_cert_file_path": "/opt/UiPathAutomationSuite/UiPath_Installer/orch.cer", //Specify the path to Identity certificate file
      "metering_api_key": "test" //Specify the metering API key
    }
  

  Note:

  metering_api_key is the Document Understanding or AI Units API key from the AI Center cloud account.

./bin/uipathctl service aicenter --installation-token <identity token>
./bin/uipathctl service aicenter --installation-token <identity token>

Enabling or disabling Automation Hub​

"automation_hub": {
  "enabled": "true" //Set to "false" to disable Automation Hub
  "sql_connection_str": "" //Optional and only require to override the default database name
}
"automation_hub": {
  "enabled": "true" //Set to "false" to disable Automation Hub
  "sql_connection_str": "" //Optional and only require to override the default database name
}

Enabling or disabling Automation Ops​

"automation_ops": {
  "enabled": "true", //Set to "false" to disable the Automation Ops
  "sql_connection_str": "" //Optional and only require to override the default database name
}
"automation_ops": {
  "enabled": "true", //Set to "false" to disable the Automation Ops
  "sql_connection_str": "" //Optional and only require to override the default database name
}

Enabling or disabling Automation Suite Robots​

1. Enable the asrobots flag in the cluster_config.json file. If you want to enable package caching, make sure to properly configure the packagecaching and packagecachefolder flags as well.

   assignment

   {
     "asrobots": {
        "enabled": Boolean,
        "packagecaching": Boolean,
        "packagecachefolder": String
     }
   }
   {
     "asrobots": {
        "enabled": Boolean,
        "packagecaching": Boolean,
        "packagecachefolder": String
     }
   }
   

   Parameter	Default value	Description
   packagecaching	true	When set to true, robots use a local cache for package resolution.
   packagecachefolder	/uipath_asrobots_package_cache	The disk location on the serverless agent node where the packages are stored.

   Note:

   Package caching optimizes your process runs and allows them to run faster. NuGet packages are fetched from the filesystem instead of being downloaded from the Internet/network. This requires an additional space of minimum 10GB and should be allocated to a folder on the host machine filesystem of the dedicated nodes.

2. If you use a multi-node HA-ready production setup, you must configure a specialized agent node for Automation Suite Robots. In single-node evaluation mode, an additional node is optional. For instructions, see Adding a dedicated agent node for Automation Suite Robots.

Enabling or disabling Data Service​

"dataservice": {
  "enabled": "true", //Set to "false" to disable the Data Service,
  "sql_connection_str": "" //Optional and only require to override the default database name
}
"dataservice": {
  "enabled": "true", //Set to "false" to disable the Data Service,
  "sql_connection_str": "" //Optional and only require to override the default database name
}

Enabling or disabling Document Understanding​

"documentunderstanding": {
  "enabled": "true", //Set to "false" to disable the Document Understanding
  "sql_connection_str": "" //Optional and only required to override the default database name
}
  "pyodbc_sql_connection_str": "" //Optional and only required to override the default database name
    }
"documentunderstanding": {
  "enabled": "true", //Set to "false" to disable the Document Understanding
  "sql_connection_str": "" //Optional and only required to override the default database name
}
  "pyodbc_sql_connection_str": "" //Optional and only required to override the default database name
    }

"documentunderstanding": {
  "enabled": "true", //Set to "false" to disable the Document Understanding
  "sql_connection_str": "" //Optional and only required to override the default database name
}
  "pyodbc_sql_connection_str": "" //Optional and only required to override the default database name
  "modernProjects": {
      "enabled": "true" //Set to "false" to disable Document Understanding modern projects
      "enable_cpu_inference": "false"  //Set to "true" to use CPU instead of GPU for AIHM and SSDE services during DU installation. 
    }
"documentunderstanding": {
  "enabled": "true", //Set to "false" to disable the Document Understanding
  "sql_connection_str": "" //Optional and only required to override the default database name
}
  "pyodbc_sql_connection_str": "" //Optional and only required to override the default database name
  "modernProjects": {
      "enabled": "true" //Set to "false" to disable Document Understanding modern projects
      "enable_cpu_inference": "false"  //Set to "true" to use CPU instead of GPU for AIHM and SSDE services during DU installation. 
    }

Enabling or disabling Insights​

"insights": {
  "enabled": "true", //Set to "false" to disable the Insights,
  "enable_realtime_monitoring": "false", //Set to "true" to enable Insights Real-time monitoring,
  "sql_connection_str": "" //Optional and only require to override the default database name
}
"insights": {
  "enabled": "true", //Set to "false" to disable the Insights,
  "enable_realtime_monitoring": "false", //Set to "true" to enable Insights Real-time monitoring,
  "sql_connection_str": "" //Optional and only require to override the default database name
}

Enabling or disabling Integration Service​

"integrationservices": {
  "enabled": "true" //Set to "false" to disable Integration Service
  "sql_connection_str": "" //Optional and only require to override the default database name
}
"integrationservices": {
  "enabled": "true" //Set to "false" to disable Integration Service
  "sql_connection_str": "" //Optional and only require to override the default database name
}

Enabling or disabling Orchestrator​

"orchestrator": {
  "enabled": "true" //Set to "false" to disable Orchestrator
  "sql_connection_str": "" //Optional and only require to override the default database name
}
"orchestrator": {
  "enabled": "true" //Set to "false" to disable Orchestrator
  "sql_connection_str": "" //Optional and only require to override the default database name
}

Enabling or disabling Process Mining​

1. Enable the processmining flag.

2. Configure the following connection string templates:

   • sql_connection_string_template
   • sql_connection_string_template_jdbc
   • sql_connection_string_template_odbc
   • sql_connection_string_template_sqlalchemy_pyodbc

3. In multi-node HA-ready production installations, add a separate connection string for the second SQL Server. Note that in single-node evaluation installations, the seconds SQL Server is recommended. For instructions on how to configure the seconds SQL Server, see SQL requirements for Process Mining

   assignment

   "processmining": {
     "enabled": true,
     "sql_connection_str": "", // dotnet connection string
     "sqlalchemy_pyodbc_sql_connection_str": "", 
     "warehouse": {
           "sql_connection_str": "",
           "sqlalchemy_pyodbc_sql_connection_str": ""
        }
   }
   "processmining": {
     "enabled": true,
     "sql_connection_str": "", // dotnet connection string
     "sqlalchemy_pyodbc_sql_connection_str": "", 
     "warehouse": {
           "sql_connection_str": "",
           "sqlalchemy_pyodbc_sql_connection_str": ""
        }
   }
   

Enabling or disabling Test Manager​

"test_manager": {
  "enabled": "true", //Set to "false" to disable the Test Manager,
  "sql_connection_str": "" //Optional and only require to override the default database name
}
"test_manager": {
  "enabled": "true", //Set to "false" to disable the Test Manager,
  "sql_connection_str": "" //Optional and only require to override the default database name
}

Step 2: Running the installer to update the new product configuration​

1. Create the prerequisites required for the shared components installation, by running the following command:

   assignment

   ./bin/uipathctl prereq create /opt/UiPathAutomationSuite/cluster_config.json --versions versions/helm-charts.json
   ./bin/uipathctl prereq create /opt/UiPathAutomationSuite/cluster_config.json --versions versions/helm-charts.json
   

2. Validate the prerequisites required by the shared components installation, by running the following command:

   assignment

   ./bin/uipathctl prereq run /opt/UiPathAutomationSuite/cluster_config.json --versions versions/helm-charts.json
   ./bin/uipathctl prereq run /opt/UiPathAutomationSuite/cluster_config.json --versions versions/helm-charts.json
   

3. Run the following command on the installer to update the service configuration:

   assignment

   ./bin/uipathctl manifest apply cluster_config.json --versions versions/helm-charts.json
   ./bin/uipathctl manifest apply cluster_config.json --versions versions/helm-charts.json