Procedure

Step 1: Download the installation script on the first machine

1.1 Download the installation packages

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.

Follow the steps below on the separate machine with internet access to get the required files to start the installation process:

1. Connect to a machine with internet access and run the following command to get the interactive wizard file:

   ssh <user>@<dns_of_vm>

2. If you used an SSH key, run the following command:

   ssh -i <path/to/Key.pem> <user>@<dns_of_vm>

3. Download the following packages:
   • installUiPathAS.sh - Mandatory. See installUiPath.as for download instructions.
   • sf-installer.zip - Mandatory. See sf-installer.zip for download instructions.
   • sf.tar.gz - Mandatory. See sf.tar.gz for download instructions.
   • sf-infra.tar.gz - Optional. Only needd if you want to join additional nodes, including Task Mining and GPU. See sf-infra.tar.gz for download instructions.
   • du-ondemand.tar.gz - Optional. Needed only for Document Understanding. See du-ondemand.tar.gz for download instructions.
     Note: Not following this optional step limits the functionality of the Document Understanding services.
   • cv-ondemand.tar.gz – Optional. Needed only for Computer Vision. See cv-ondemand.tar.gz for download instructions.
     Note: Not following this optional step prevents access to the Computer Vision services.

Make sure to download the package suitable for your AI Center version and your operating system.

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.

Create the installation folder on the main machine of the cluster by running the following command:

sudo su -
mkdir -p /opt/UiPathAutomationSuite/
chmod -R 777 /opt/UiPathAutomationSuite
mkdir -p /uipath/tmp
chmod -R 777 /uipath/tmp

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/
  scp ~/sf-infra.tar.gz <username>@<node dns>:/uipath/tmp/

• (Optional) To use Document Understanding, copy the following bundles to the /uipath/tmp folder.

  scp ~/du-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.

Make sure that /opt/UiPathAutomationSuite has the right permission for files to be copied over scp, or copy the file into your home directory and then move it to /opt/UiPathAutomationSuite.

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

If Identity Server is different from Orchestrator, repeat the steps for identityserver.cer as well.

Chain certificates

When using a domain-issued certificate, make sure to export the root certificate as follows:

1. Open the certificate, go to the Certification Path tab and select the first certificate. Click on View certificate.
   
   

   

   
   
2. Once the root certificate is displayed, go to the Details tab and click Copy to file.
   
   

   

   
   
3. Make sure to select base64 cer file format.
4. Save it with the name of your choice and then send it to AI Center machine.

The resulting file should be similar to the example below.

-----BEGIN CERTIFICATE----- 
certificate
base64
encoded
-----END CERTIFICATE-----

Step 3: Configure the installation

Basic configuration

The following prerequisites are applicable for the main machine of the cluster.

1. Add the following prerequisites 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

2. 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

3. Run the interactive install wizard to configure the installation 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.

4. Run the script the begin the interactive wizard by running the following command:

   chmod +x ./installUiPathAS.sh
   ./installUiPathAS.sh

5. Follow the steps in the wizard below.

3.1 Use the 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. 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.

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.

Follow the deployment configuration steps:

1. Accept the license agreement.
2. Select the deployment mode: select the Multi-node deployment option.
   
   

   

   
   
3. Select continue.
4. Select Air-gapped installation.
5. Select Complete installation.
6. Enter the DNS hostname.
7. Specify whether you want to use Kerberos Auth for SQL connections.
8. Enter the SQL Server URL. Follow the prompt to enter the connection port, username, and password.
9. 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 configuration

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": {
  "enabled": "true",
  "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:

1. Copy the ~/UiPathAutomationSuite folder to all other nodes by running:

   scp -r ~/UiPathAutomationSuite <username>@<node dns>:/opt

   Note: Since we are in an air-gapped environment, you might need to use the private IP of the target node.
2. 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: Running the installation

1. Run the infrastructure installer on all nodes:
   1. Set up the primary machine by executing 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

   2. Join the rest of the servers to the cluster by executing the following commands on the rest of the server nodes:

      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

   3. Join the rest of the agents to the cluster by executing the following commands on the rest of the agent nodes:

      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

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

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

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.

   ./configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/du-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp"

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

   ./configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp"