Subscribe

UiPath AI Center

UiPath AI Center

Offline multi-node installation

Overview


Use the following steps to install AI Center on multiple machines in an airgapped environment with no access to the internet. If deploying an environment where the machines have internet access we recommend using the online installation steps which are optimized for that case.

Prerequisites


Hardware and software prerequisites must be completed before proceeding with the installation.

Procedure


Blue background steps are performed on the machine with internet access.
Green background steps are performed on the machines where the installation suite is being deployed.

Step 1: Download the installation script on the first machine


1.1 Download the installation package.

This step needs to be run on a machine with internet access and access to the machines in the air-gapped environment where UiPath AI Center will be installed.

📘

Note:

This machine can be Linux or Windows. The steps provided to be run on this machine. Throughout this document there are examples meant for RHEL-based OS. For Windows or other OS versions, adjust for equivalent steps specific to those environments.

 

ON THE SEPARATE MACHINE WITH INTERNET ACCESS
 
For Linux machines
 
  • The first step is to get the required files to start the install process and trigger the download of the installation bundles so they can happen in parallel while configuring the install.

  • Connect to a machine with internet access and run command to get the interactive wizard file:
  • ssh <user>@<dns_of_vm>
  • If you used an ssh key:
  • ssh -i <path/to/Key.pem> <user>@<dns_of_vm>
  • Download the script installer and bundle. Make sure to keep the ' (single quotes) around the download URL:
  • 
    sudo yum install wget -y
    cd /opt/UiPathAutomationSuite 
    wget -O ./installUiPathAS.sh 'https://download.uipath.com/automation-suite/installUiPathAS.sh'
    wget -O ./sf-installer.zip 'https://download.uipath.com/automation-suite/installer.zip'
    wget -O ./sf.tar.gz 'https://download.uipath.com/automation-suite/sf.tar.gz'
    wget -O ./sf-infra.tar.gz 'https://download.uipath.com/automation-suite/sf-infra-only.tar.gz'
    
    
  • (Optional) To use Document Understanding, download the following bundles:
  • wget -O ~/du-ondemand.tar.gz 'https://download.uipath.com/automation-suite/du.tar.gz'
    wget -O ~/du2110-ondemand.tar.gz 'https://download.uipath.com/automation-suite/du2110.tar.gz'
    Note: Not following this optional step prevents access to the Document Understanding services.
  • (Optional) To use Computer Vision, download the following bundle:
  • wget -O ~/cv-ondemand.tar.gz 'https://download.uipath.com/automation-suite/cv.tar.gz'
    Note: Not following this optional step prevents access to the Computer Vision services.

For Windows machines
 
Download the packages from the links below:
Go to the first target machine for installation
 
  • Run the following command:
  • ssh <user>@<dns_of_vm>
  • If you used an ssh key, run the following command:
  • ssh -i <path/to/Key.pem> <user>@<dns_of_vm>

 

1.2 Get all downloaded files on the first machine.

Make sure to take the following steps:

  • Check that all files have finished downloading on the machine with internet access.
  • Create the target folder on the machine.
  • Copy the files from the online machine to the target machine.
ON THE MAIN MACHINE OF THE CLUSTER
 
Create the installation folder
 
  • Run the following command:
  • sudo su -
    mkdir -p /opt/UiPathAutomationSuite/
    chmod -R 755 /opt/UiPathAutomationSuite
ON THE SEPARATE MACHINE WITH INTERNET ACCESS
 
Copy the files to the first node
 
  • From the machine with internet access, copy the files to the installation folder on the target machine, and the offline bundle(s) to the /uipath/tmp folder.

  • scp ./installUiPathAS.sh ./sf-installer.zip ./sf-infra.tar.gz <username>@<node dns>:/uipath/tmp/
    scp ~/sf.tar.gz <username>@<node dns>:/uipath/tmp/
  • (Optional) To use Document Understanding, copy the following bundle to the /uipath/tmp folder.
  • scp ~/du-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    scp ~/du2110-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    Note: Not following this optional step prevents access to the Document Understanding services.
  • (Optional) To use Computer Vision, copy the following bundle to the /uipath/tmp folder.
  • scp ~/cv-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/
    Note: Not following this optional step prevents access to the Computer Vision services.

 

Step 2: Copy the Orchestrator certificate to the virtual machine


Note: In case of chain certificates, check the Chain certificates section on how to correctly provide certificates.

Download and save the Orchestrator certificate on your local machine. You can do this by using a browser, or you can ask your IT department to provide the certificate. Certificates must be base64 and .cer format. Copy the certificate to the virtual machine using the command below.

scp /path/to/orch.cer <username>@<node dns>:/opt/UiPathAutomationSuite

Chain certificates

When using a domain-issued certificate, follow the procedure below.

  1. Insert the whole chain in the .cer file created for upload.
  1. Export the first node (root) in a base64 and cer file format. To do so, click View Certificate, then go to the Details tab and click Copy to file.
  1. Create one .cer file, for example 1stcert.cer.
  2. Select the intermediate certificate from the second node in the tree. Click View Certificate, then go to the Details tab and click Copy to file.
  3. Create a second distinct .cer file, for example 2ndcert.cer.
  4. Export the leaf of the certificate file (third node in the tree).
  5. Create a third distinct .cer file, for example 3rdcert.cer.
  6. Concatenate the three certificate files in one bigger file in the order they are displayed in the tree (root, intermediate, leaf).
  7. Open the three files with a text editor and paste them one after the other in a new file.

The resulting file should be similar to the example below.

-----BEGIN CERTIFICATE----- 
first line of the 1stcert file 
second line of the 1stcert file 
-----END CERTIFICATE----- 
-----BEGIN CERTIFICATE----- 
first line of the 2ndcert file 
second line of the 2ndcert file 
-----END CERTIFICATE----- 
-----BEGIN CERTIFICATE----- 
first line of the 3rdcert file 
second line of the 3rdcert file  
-----END CERTIFICATE-----

Step 3: Configure the installation


ON THE MAIN MACHINE OF THE CLUSTER
 
Add prerequisites folder to the current PATH
 
  • The interactive installer requires jq and our offline bundles already includes it. Run the following commands to add it to PATH: (make sure you are still root)
  • mv /uipath/tmp/installUiPathAS.sh /uipath/tmp/sf-installer.zip /opt/UiPathAutomationSuite
    cd /opt/UiPathAutomationSuite
    unzip ./sf-installer.zip -d .
    chmod +x ./bin/jq
    export PATH=${PATH}:/opt/UiPathAutomationSuite/bin
Provide permissions to Installer Folder
 
  • It is required to give adequate permissions to the /opt/UiPathAutomationSuite folder where the install scripts are placed and going to be executed.
    Installer will also create some files (output.json) after execution of each stage.
    Run the following command to provide the permissions:
  • chmod -R 755 /opt/UiPathAutomationSuite
Run the interactive install wizard to create base configure the install options
 
  • Interactive wizard will guide through the configuration steps and generate the config file which can be then customized and used through the remaining install steps.
Run the script to begin interactive wizard
  • Run the following command
  • chmod +x ./installUiPathAS.sh
    ./installUiPathAS.sh
Follow the steps in the wizard

3.1 Use interactive wizard to create base config file.

🚧

Note:

Make sure to not start the install from the script and exit it when config file is generated, it will try to install full Automation suite otherwise.

Note: This script is primarily used for Automation Suite and the displayed information (products, requirements) is relative to Automation Suite. The config file will be adapted to our needs in the next steps of the procedure.

Screen-by-screen sequence
Upon starting the installation wizard, the main menu is displayed. From this menu you need to choose the desired deployment mode: single-node or multi-node. You are prompted with details about each mode once a choice is made. After that, you have the option to continue with the current choice or go back to the main menu.

Deployment configuration steps

  1. Accept the license agreement.

  2. Select the deployment mode: select the Multi-node deployment option.

  1. Select continue.

  2. Select Air-gapped installation.

  3. Enter the DNS hostname.

  4. Specify whether you want to use Kerberos Auth for SQL connections.

  5. Enter the SQL Server URL. Follow the prompt to enter the connection port, username, and password.

  6. Specify whether you want the installer to automatically create the necessary databases.

The cluster configuration file will be generated with a folder as shown in the following image.

Note: As soon as you generate the configuration file and the folder, you can exit the wizard and proceed with the remaining steps below to complete installation. You can ignore the list of products as we will update this in the following steps.

A first version of the cluster_config.json file is now generated. We will update this file to the purpose of the AI Center installation.

3.2. Add AI Center-specific config.

Open the file with your editor (e.g.: vi):

vi /opt/UiPathAutomationSuite/cluster_config.json

Replace the following block:

"aicenter": {
  "enabled": "false"
},

Note: Document Understanding is enabled by default if AI Center is enabled.

With the following information (replacing the information between <> with your values):

"aicenter": {
  "orchestrator_url":"<https://orchestrator-url.com>",
  "identity_server_url": "<https://orchestrator-url.com/identity>",
  "orchestrator_cert_file_path": "</opt/UiPathAutomationSuite/orch.cer or custom path>",
  "identity_cert_file_path":  "</opt/UiPathAutomationSuite/orch.cer or custom path>",
  "identity_access_token": "<placeholder will be replaced later>"
},

3.3. (Optional) Advanced configuration

You can find the cluster_config.json file in the UiPathAutomationSuite folder. You can use this file to configure your SQL DBs and their respective connection strings and certificates. You can also enable proxy settings if you use a proxy for internet connection.

For advanced configuration, see Using the configuration file.

 

Step 4: Copy the installation files on all the other cluster machines.


From the first machine in the cluster, where the configuration was performed, copy the entire install folder to all other machines.

ON THE FIRST MACHINE IN THE CLUSTER
 
  1. Copy the ~/UiPathAutomationSuite folder to all other nodes by running:
  2. scp -r ~/UiPathAutomationSuite <username>@<node dns>:/var/tmp
    🛈 Since we are in an air-gapped environment, you might need to use the private IP of the target node.

  3. Add -i <cert.pem> if you are using a certificate to login. If you copy the .pem contents to a local file, the new file will need to have correct permissions. You can do chmod 400 <cert.pem> for granting them.

📘

Note:

The step above ensures the same configuration is replicated on all machines along with all the downloaded packages for the install bundle.

 

Step 5: Stand-alone installation


ON THE MAIN MACHINE OF THE CLUSTER
 

5.1. Run the infrastructure installer on all nodes
Set up the primary machine

  • Execute the following commands on the primary server:
cd /opt/UiPathAutomationSuite
./install-uipath.sh -i ./cluster_config.json -o ./output.json -k --offline-bundle ./sf-infra.tar.gz --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement --install-standalone-aicenter

Join the rest of the servers to the cluster:

  • Execute the following commands on the rest of the server nodes:
mv /uipath/tmp/UiPathAutomationSuite /opt
cd /opt/UiPathAutomationSuite
sudo chmod -R 755 /opt/UiPathAutomationSuite
sudo ./install-uipath.sh -i ./cluster_config.json -o ./output.json -k -j server --offline-bundle ./sf-infra.tar.gz --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement --install-standalone-aicenter

Join the rest of the agents to the cluster:

  • Execute the following commands on the rest of the agent nodes:
mv /uipath/tmp/UiPathAutomationSuite /opt
cd /opt/UiPathAutomationSuite
sudo chmod -R 755 /opt/UiPathAutomationSuite
sudo ./install-uipath.sh -i ./cluster_config.json -o ./output.json -k -j agent --offline-bundle ./sf-infra.tar.gz --offline-tmp-folder /uipath/tmp --install-offline-prereqs --accept-license-agreement --install-standalone-aicenter

5.2 Run the fabric installer on primary node

cd /opt/UiPathAutomationSuite
export TMPDIR="/uipath/lib/containers/tmp"
mkdir -p "/uipath/lib/containers/tmp"
./install-uipath.sh -i ./cluster_config.json -o ./output.json -f --offline-bundle /uipath/tmp/sf.tar.gz --offline-tmp-folder /uipath/tmp --accept-license-agreement --install-standalone-aicenter

5.3. Run the software installer on primary node
First you need to connect to identity server and retrieve an installation token. Then copy this token and paste it in placeholder we had in step 3.2. (in the cluster_config.json file).
Once the token is there, you can run the AI Center install.

./install-uipath.sh -i cluster_config.json -o output.json --install-type offline --accept-license-agreement --install-standalone-aicenter -s

5.4. Load the optional Document Understanding bundles commands.
To load the optional bundles, execute the following command. Make sure to use the bundle name that you need to load.

./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/du-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/du2110-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement

5.5. Load the optional Computer Vision bundle command.
To load the optional Computer Vision bundle, execute the following command:

./install-uipath.sh -i ./cluster_config.json -o ./output.json --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement

Updated 4 days ago

Offline multi-node installation


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.