ai-center
2022.4
true
- Getting Started
- Network requirements
- Single-node requirements and installation
- Multi-node requirements and installation
- Post-installation
- Accessing AI Center
- Provision an AI Center tenant
- Updating Orchestrator and Identity Server certificates
- Resizing PVC
- Adding a new node to the cluster
- ML packages offline installation
- Configuring the cluster
- Configuring the FQDN post-installation
- Backing up and restoring the cluster
- Using the monitoring stack
- Setting up a Kerberos authentication
- Provisioning a GPU
- Using the configuration file
- Node scheduling
- Migration and upgrade
- Basic Troubleshooting Guide
Procedure
AI Center Installation Guide
Last updated Jun 6, 2024
Procedure
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:
- Connect to a machine with internet access and run the following command to get the interactive wizard file:
ssh <user>@<dns_of_vm>
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>
ssh -i <path/to/Key.pem> <user>@<dns_of_vm> - 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 Automation Suite version and your operating system.
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 755 /opt/UiPathAutomationSuite
mkdir -p /uipath/tmp
chmod -R 777 /uipath/tmp
sudo su -
mkdir -p /opt/UiPathAutomationSuite/
chmod -R 755 /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 <username>@<node dns>:/uipath/tmp scp ~/sf.tar.gz <username>@<node dns>:/uipath/tmp/
scp ~/installUiPathAS.sh ~/sf-installer.zip <username>@<node dns>:/uipath/tmp scp ~/sf.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/
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/
scp ~/cv-ondemand.tar.gz <username>@<node dns>:/uipath/tmp/Note: Not following this optional step prevents access to the Computer Vision services.
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
scp /path/to/orch.cer <username>@<node dns>:/opt/UiPathAutomationSuite
When using a domain-issued certificate, make sure to export the root certificate as follows:
- Open the certificate, go to the Certification Path tab and select the first certificate. Click on View certificate.
- Once the root certificate is displayed, go to the Details tab and click Copy to file.
- Make sure to select base64
cer
file format. - 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-----
-----BEGIN CERTIFICATE-----
certificate
base64
encoded
-----END CERTIFICATE-----
- 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
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
- The interactive installer requires
- 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
chmod -R 755 /opt/UiPathAutomationSuite
- It is required to give adequate permissions to the
- 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.
- Run the script the begin the interactive wizard by running the following command:
chmod +x ./installUiPathAS.sh ./installUiPathAS.sh
chmod +x ./installUiPathAS.sh ./installUiPathAS.sh - Follow the steps in the wizard
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.
Follow the deployment configuration steps:
- Accept the license agreement.
- Select the deployment mode: select the Single-node deployment option.
- Select continue.
- Select Air-gapped installation.
- Enter the DNS hostname.
- Specify whether you want to use Kerberos Auth for SQL connections.
- Enter the SQL Server URL. Follow the prompt to enter the connection port, username, and password.
- 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.
Open the file with your editor (e.g.: vi):
vi /opt/UiPathAutomationSuite/cluster_config.json
vi /opt/UiPathAutomationSuite/cluster_config.json
Replace the following block:
"aicenter": {
"enabled": "false"
},
"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":"<a href="https://orchestrator-url.com">https://orchestrator-url.com</a>",
"identity_server_url": "<a href="https://orchestrator-url.com/identity">https://orchestrator-url.com/identity</a>",
"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>"
},
"aicenter": {
"enabled": "true",
"orchestrator_url":"<a href="https://orchestrator-url.com">https://orchestrator-url.com</a>",
"identity_server_url": "<a href="https://orchestrator-url.com/identity">https://orchestrator-url.com/identity</a>",
"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>"
},
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 single-node installation, note that you cannot enable High Availability.
For advanced configuration, see Using the configuration file.
- Run the infrastructure installer.
Go to the
UiPath_Installer
folder and Run the infrastructure installer with the AI Center standalone flag./opt/UiPathAutomationSuite ./install-uipath.sh -i cluster_config.json -o output.json --offline-bundle "/uipath/tmp/sf.tar.gz" --offline-tmp-folder /uipath/tmp --accept-license-agreement --install-offline-prereqs --install-standalone-aicenter -k
/opt/UiPathAutomationSuite ./install-uipath.sh -i cluster_config.json -o output.json --offline-bundle "/uipath/tmp/sf.tar.gz" --offline-tmp-folder /uipath/tmp --accept-license-agreement --install-offline-prereqs --install-standalone-aicenter -k - Install fabric (software components).
Run the installer with the AI Center stand-alone flag.
./install-uipath.sh -i cluster_config.json -o output.json --offline-bundle "/uipath/tmp/sf.tar.gz" --offline-tmp-folder /uipath/tmp --accept-license-agreement --install-offline-prereqs --install-standalone-aicenter -f
./install-uipath.sh -i cluster_config.json -o output.json --offline-bundle "/uipath/tmp/sf.tar.gz" --offline-tmp-folder /uipath/tmp --accept-license-agreement --install-offline-prereqs --install-standalone-aicenter -f - Run the software installer.
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 --offline-bundle /uipath/tmp/sf.tar.gz --accept-license-agreement --install-standalone-aicenter --offline-tmp-folder /uipath/tmp -s
./install-uipath.sh -i cluster_config.json -o output.json --offline-bundle /uipath/tmp/sf.tar.gz --accept-license-agreement --install-standalone-aicenter --offline-tmp-folder /uipath/tmp -s - Load the optional Document Understanding bundles commands.
To load the optional Document Understanding 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 /configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
./install-uipath.sh -i ./cluster_config.json -o ./output.json /configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement - Load the optional Computer Vision bundles commands.
To load the optional Computer Vision bundle, execute the following command:
./install-uipath.sh -i ./cluster_config.json -o ./output.json /configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
./install-uipath.sh -i ./cluster_config.json -o ./output.json /configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/cv-ondemand.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement
- Step 1: Download the installation script
- 1.1 Download the installation package
- 1.2 Get all downloaded files on the machine
- Step 2: Copy the Orchestrator certificate to the virtual machine
- Chain certificates
- Step 3: Configure the installation
- 3.1 Use the interactive wizard to create base config file
- 3.2 Add AI Center-specific configuration
- 3.3 (Optional) Advanced configuration
- Step 4: Running the installation