automation-suite
2024.10
true
UiPath logo, featuring letters U and I in white
Automation Suite on Linux Installation Guide
Last updated Nov 28, 2024

Manual: Installing Automation Suite

The following table lists the steps you must perform for Automation Suite installation:

Steps

Single-node installation

Multi-node installation

Lite mode

Step 1: Accepting the license agreement

available

available

available

Step 2: Installing the Infrastructure on the first server machine

available

available

available

Step 3: Installing the infrastructure on the other server machines

not available

available

available

Step 4: Installing the infrastructure on all the agent machines

not available

available

available

Step 5: Hydrating the in-cluster registry for offline installations

available

available

available

Step 6: Completing the installation

available

available

available

Step 1: Accepting the license agreement

Before running the installation, make sure to read the license agreement.

To accept the license agreement, choose one of the following methods:

  • Option 1 (Environment variable) - Set the LICENSE_AGREEMENT environment variable to accept by running the following command:
    export LICENSE_AGREEMENT=acceptexport LICENSE_AGREEMENT=accept
  • Option 2 (Inline parameter) - Append --accept-license-agreement to every execution of uipathctl.

Step 2: Installing the infrastructure on the first server machine

To install the infrastructure on the first server machine, navigate to the installer folder and run the following command:

cd /opt/UiPathAutomationSuite/<version>/installer

./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k --accept-license-agreementcd /opt/UiPathAutomationSuite/<version>/installer

./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k --accept-license-agreement
Note:
  • The -k parameter installs the infrastructure on the first server machine.
  • Once the infrastructure is installed, the server machine becomes a node in the Automation Suite cluster.

Step 3: Installing the infrastructure on the other server machines

To expand the Automation Suite cluster, install the infrastructure on the additional server machines.

To do that, run the following command on all the additional server machines:

cd /opt/UiPathAutomationSuite/<version>/installer
 
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j server --accept-license-agreementcd /opt/UiPathAutomationSuite/<version>/installer
 
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j server --accept-license-agreement
Note: The -j server parameter adds the machines as server nodes to the existing Automation Suite cluster. The fixed_rke_address flag in the cluster_config.json file connects the exiting Automation Suite cluster.

Step 4: Installing the infrastructure on all the agent machines

If you have additional agent machines, you must install the infrastructure on those machines and add them as agent nodes to the Automation Suite cluster.

To to that, run the following command on all the agents machines:

cd /opt/UiPathAutomationSuite/<version>/installer

./bin/uipathctl rke2 -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j agent --accept-license-agreementcd /opt/UiPathAutomationSuite/<version>/installer

./bin/uipathctl rke2 -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j agent --accept-license-agreement
Note:
The -j server parameter adds the machines as server nodes to the existing Automation Suite cluster. The fixed_rke_address flag in the cluster_config.json file connects the exiting Automation Suite cluster.

Step 5: Hydrating the in-cluster registry for offline installations

This step is required only if you use in-cluster registry for offline installations.

To seed the in-cluster registry from the temporary registry, run the following command:

cd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/cluster_config.jsoncd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/cluster_config.json

Step 6: Completing the installation

At this point, all the nodes should be interconnected to establish the infrastructure for installing Automation Suite. To verify if all nodes are available on the first server node and to complete the installation, run the following command:

export KUBECONFIG=/etc/rancher/rke2/rke2.yaml 
export PATH=$PATH:/var/lib/rancher/rke2/bin 

kubectl get nodesexport KUBECONFIG=/etc/rancher/rke2/rke2.yaml 
export PATH=$PATH:/var/lib/rancher/rke2/bin 

kubectl get nodes

The output of the aforementioned command should look similar to the one shown in the following image. Note that the total number of nodes must match the sum of server and agent nodes.

docs image

After verifying the infrastructure, install the shared components and the services by running the following command:

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

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.