Subscribe

UiPath AI Fabric

UiPath AI Fabric

Prerequisites for Data Manager and OCR Engines

Both Data Manager and OCR Engines are containerized applications that run on top of docker. You cannot run these on the same machine as AI Fabric version 2020.7. In order to run them on a separate machine, the pre-requisites installer commands below can be used to set up docker and optionally the NVidia drivers. These scripts should not be run on the machine where AI Fabric will be installed.


The scripts below work best on “vanilla” or “minimal” machines where none of the dependencies (like Docker or NVIDIA drivers) have been preinstalled, and no unusual customizations have been done.

Docker images can have many GB in size, so the folder Docker uses to hold its files on Linux must be on a partition sufficiently large to not run out of space. By default, it is always on the root partition.
To see how large your root partition is, type the following in the terminal, and look for the line with a / in the rightmost column:

df -h

If the size of that partition is smaller than the minimal storage requirements, then see the Configuring the Docker Data Folder section.

GPU Machine Install

Linux

Run this command:

curl -fsSL https://raw.githubusercontent.com/UiPath/Infrastructure/master/ML/du_prereq_installer.sh | sudo bash -s -- --env gpu

On some systems running the command twice or a system reboot might be required to install all requirements.
Azure Specific: In order to use the NV-series virtual machines you need to either install the NVIDIA driver before executing the above command, or you can use a Driver Extension from Azure to install the necessary NVIDIA driver according to that tier GPU model.

Azure VMs

If you are installing on a VM in Azure, then use this command instead:

curl -fsSL https://raw.githubusercontent.com/UiPath/Infrastructure/master/ML/du_prereq_installer.sh | sudo bash -s -- --env gpu --cloud azure

CPU Machine Install

Linux

Run this command:

curl -fsSL https://raw.githubusercontent.com/UiPath/Infrastructure/master/ML/du_prereq_installer.sh | sudo bash -s -- --env cpu

Azure VMs

If you are installing on a VM in Azure, then use this command instead:

curl -fsSL https://raw.githubusercontent.com/UiPath/Infrastructure/master/ML/du_prereq_installer.sh | sudo bash -s -- --env cpu --cloud azure

Windows 10

  1. Download and install Docker Desktop. On recently updated versions of Windows 10, you will need WSL2 installed. So when presented with a dialog saying "WSL 2 Installation is Incomplete" please click the Restart button.
  2. Open Powershell and run the below command.
docker plugin install uipath/davfs

Note that when running Data Manager you need to create a working folder for each of them (perhaps named "workdir" for Data Manager) and include the path to it in the docker run comand, after the "-v" flag. When doing this on Windows, Docker Desktop will pop up a notification like the one below - you need to click on Share it to proceed.

Configuring the Docker Data Folder (Linux only)

Run this command and then reboot:

curl -fsSL https://raw.githubusercontent.com/UiPath/Infrastructure/master/ML/du_prereq_installer.sh | sudo bash -s -- --change-mount </path/to/folder>

❗️

Warning

After changing the Docker Data Folder, you need to run the prerequisites installer script again.

Docker Cheat Sheet

Docker helps ship software in Docker “images”. A running instance of an image is called a container. A container can be stopped, removed, started again, as many times as needed, as long as the image is available. Once the image is removed, it is lost. The only way to recover it is to pull it again from the registry it came from, if it is still available there.
A running container is analogous to a small Virtual Machine, in that it has an internal filesystem and network interfaces, which are separate from the host machine filesystem and network. Folders and ports can be mapped from the container to the host using –v and –p arguments, respectively.

In the table below you can find a list of common commands for Docker command line.
Click here for the full list of base Docker commands.

Command

Description

"docker login <registry name> -u <username> -p <password>"

Log in to a registry.

"docker pull <registry name>/<image name>:<image tag>"

Download an image from a registry. The tag latest is commonly used to refer to the latest version of an image.

"`docker run –d -p 5000:80 /:

OR

docker run –d –p 5000:80
`"

Run an image in detached mode, while mapping port 80 from inside the container to port 5000 on the host machine, and to . Detached mode means the container does not block the terminal, so you can perform other operations on the same terminal.

"docker images"

List images present on your system.

"docker ps –a"

List all containers (both running and stopped).
The container id is used to refer to that container when one needs to stop it or remove it, for instance.

"docker stop <container id>"

Stop the container.
This command does not remove the container, but is required in advance to removing it.

"docker rm <container id>"

Remove the container.
The container must be stopped beforehand.

"docker logs <container id>"

Display the logs of the container.

"docker rmi <image id>"

Remove one or more images from the system.
This helps save storage space as images can take up a lot of space.

"Docker container prune -f"

Remove all stopped containers.

Linux Terminal Cheat Sheet

Command

Description

"sudo <any_command>"

Run a command as administrator. Try this whenever you get a Permission Denied error.

"ifconfig"

Display information about the network interfaces in your system. Find the IP of your machine in the eth0 or docker0 sections.

"pwd"

Display the path to the current folder.

"ls"

List the content of a directory.

"cd <folder_name>"

Go to a different folder.

"mkdir <folder_name>"

Create a new folder.

Updated 25 days ago


Prerequisites for Data Manager and OCR Engines


Suggested Edits are limited on API Reference Pages

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