- Overview
- Requirements
- Recommended: Deployment templates
- Manual: Preparing the installation
- Manual: Preparing the installation
- Step 1: Configuring the OCI-compliant registry for offline installations
- Step 2: Configuring the external objectstore
- Step 3: Configuring High Availability Add-on
- Step 4: Configuring Microsoft SQL Server
- Step 5: Configuring the load balancer
- Step 6: Configuring the DNS
- Step 7: Configuring the disks
- Step 8: Configuring kernel and OS level settings
- Step 9: Configuring the node ports
- Step 10: Applying miscellaneous settings
- Step 12: Validating and installing the required RPM packages
- Step 13: Generating cluster_config.json
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- External OCI-compliant registry configuration
- Disaster recovery: Active/Passive and Active/Active configurations
- High Availability Add-on configuration
- Orchestrator-specific configuration
- Insights-specific configuration
- Process Mining-specific configuration
- Document Understanding-specific configuration
- Automation Suite Robots-specific configuration
- Monitoring configuration
- Optional: Configuring the proxy server
- Optional: Enabling resilience to zonal failures in a multi-node HA-ready production cluster
- Optional: Passing custom resolv.conf
- Optional: Increasing fault tolerance
- install-uipath.sh parameters
- Adding a dedicated agent node with GPU support
- Adding a dedicated agent Node for Task Mining
- Connecting Task Mining application
- Adding a Dedicated Agent Node for Automation Suite Robots
- Step 15: Configuring the temporary Docker registry for offline installations
- Step 16: Validating the prerequisites for the installation
- Manual: Performing the installation
- Post-installation
- Cluster administration
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating objectstore from persistent volume to raw disks
- Migrating from in-cluster to external High Availability Add-on
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Migrating to an external OCI-compliant registry
- Switching to the secondary cluster manually in an Active/Passive setup
- Disaster Recovery: Performing post-installation operations
- Converting an existing installation to multi-site setup
- Guidelines on upgrading an Active/Passive or Active/Active deployment
- Guidelines on backing up and restoring an Active/Passive or Active/Active deployment
- Redirecting traffic for the unsupported services to the primary cluster
- Monitoring and alerting
- Migration and upgrade
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone product database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the migrated product connection strings
- Step 6: Migrating standalone Orchestrator
- Step 7: Migrating standalone Insights
- Step 8: Deleting the default tenant
- B) Single tenant migration
- Migrating from Automation Suite on Linux to Automation Suite on EKS/AKS
- Upgrading Automation Suite
- Downloading the installation packages and getting all the files on the first server node
- Retrieving the latest applied configuration from the cluster
- Updating the cluster configuration
- Configuring the OCI-compliant registry for offline installations
- Executing the upgrade
- Performing post-upgrade operations
- Product-specific configuration
- Using the Orchestrator Configurator Tool
- Configuring Orchestrator parameters
- Orchestrator appSettings
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Best practices and maintenance
- Troubleshooting
- How to troubleshoot services during installation
- How to uninstall the cluster
- How to clean up offline artifacts to improve disk space
- How to clear Redis data
- How to enable Istio logging
- How to manually clean up logs
- How to clean up old logs stored in the sf-logs bucket
- How to disable streaming logs for AI Center
- How to debug failed Automation Suite installations
- How to delete images from the old installer after upgrade
- How to disable TX checksum offloading
- How to upgrade from Automation Suite 2022.10.10 and 2022.4.11 to 2023.10.2
- How to manually set the ArgoCD log level to Info
- How to expand AI Center storage
- How to generate the encoded pull_secret_value for external registries
- How to address weak ciphers in TLS 1.2
- Unable to run an offline installation on RHEL 8.4 OS
- Error in downloading the bundle
- Offline installation fails because of missing binary
- Certificate issue in offline installation
- First installation fails during Longhorn setup
- SQL connection string validation error
- Prerequisite check for selinux iscsid module fails
- Azure disk not marked as SSD
- Failure after certificate update
- Antivirus causes installation issues
- Automation Suite not working after OS upgrade
- Automation Suite requires backlog_wait_time to be set to 0
- Volume unable to mount due to not being ready for workloads
- Support bundle log collection failure
- Test Automation SQL connection string is ignored
- Single-node upgrade fails at the fabric stage
- Cluster unhealthy after automated upgrade from 2021.10
- Upgrade fails due to unhealthy Ceph
- RKE2 not getting started due to space issue
- Volume unable to mount and remains in attach/detach loop state
- Upgrade fails due to classic objects in the Orchestrator database
- Ceph cluster found in a degraded state after side-by-side upgrade
- Unhealthy Insights component causes the migration to fail
- Service upgrade fails for Apps
- In-place upgrade timeouts
- Docker registry migration stuck in PVC deletion stage
- AI Center provisioning failure after upgrading to 2023.10 or later
- Upgrade fails in offline environments
- SQL validation fails during upgrade
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- Longhorn REST API endpoint upgrade/reinstall error
- Setting a timeout interval for the management portals
- Authentication not working after migration
- Kinit: Cannot find KDC for realm <AD Domain> while getting initial credentials
- Kinit: Keytab contains no suitable keys for *** while getting initial credentials
- GSSAPI operation failed due to invalid status code
- Alarm received for failed Kerberos-tgt-update job
- SSPI provider: Server not found in Kerberos database
- Login failed for AD user due to disabled account
- ArgoCD login failed
- Update the underlying directory connections
- Failure to get the sandbox image
- Pods not showing in ArgoCD UI
- Redis probe failure
- RKE2 server fails to start
- Secret not found in UiPath namespace
- ArgoCD goes into progressing state after first installation
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unhealthy services after cluster restore or rollback
- Pods stuck in Init:0/X
- Missing Ceph-rook metrics from monitoring dashboards
- Pods cannot communicate with FQDN in a proxy environment
- Running High Availability with Process Mining
- Process Mining ingestion failed when logged in using Kerberos
- After Disaster Recovery Dapr is not working properly for Process Mining and Task Mining
- Unable to connect to AutomationSuite_ProcessMining_Warehouse database using a pyodbc format connection string
- Airflow installation fails with sqlalchemy.exc.ArgumentError: Could not parse rfc1738 URL from string ''
- How to add an IP table rule to use SQL Server port 1433
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
Step 7: Configuring the disks
Before performing an Automation Suite installation, you must partition and configure the disk using LVM, so that you can alter its size easily and without any data migration or data loss.
/var
partition, which is allocated only 8 GiB of space by default.
- The supported format for the disks is
ext4
orxfs
. - You must create all partitions using LVM to ensure that the cluster data can reside on a different disk but still be viewed coherently. This also helps extend the partition size in the future without the risk of data migration or loss.
- All the pods and application logs are stored under the
/var/log/pods
directory. Make sure that the capacity of this directory is at least 8 GiB. We also recommend configuringlogrotate
to rotate the logs at an interval ranging from daily to weekly.
The disk requirements for online and offline installations are the same, except for the extra space needed to unpack the offline UiPath® bundle.
For the RHEL OS, make sure you have the following minimum mount point sizes on the machine.
Disk label |
Server |
Agent |
Partition |
Size |
Purpose |
---|---|---|---|---|---|
Cluster disk |
|
|
|
190 GiB |
Stores the container images and layers. |
|
56 GiB |
Stores runtime Kubernetes configurations such as secrets, configmaps, and emptyDir. | |||
|
10 GiB |
Stores the installer binary. | |||
etcd disk |
|
|
|
16 GiB |
Stores the distributed database for Kubernetes |
Block storage |
|
|
|
15 GiB |
Required for Insights. |
|
50 GiB |
Required for the monitoring tools. | |||
/datadisk/registry 1 |
200 GiB |
Required for the Docker registry. | |||
/datadisk/objectstore 2 |
10 Gib |
Required for ceph-mon. | |||
Objectstore2 |
|
|
N/A | 512 GiB |
Required for in-cluster objectstore. |
AI Center3 |
|
|
N/A |
51 GiB minimum and 105 GiB recommended for 1 training pipeline. |
Required only if you install AI Center. |
UiPath® bundle disk |
|
| /uipath | 512 GiB |
Required only for offline installations to store the offline bundle |
2 This refers to the in-cluster objectstore and is not applicable if you use an external objectstore.
3 This refers to the storage required by the AI Center training pipeline. The disk is required only on the machines on which you plan to run the AI Center training pipeline and on the dedicated Task Mining node. We recommend attaching this disk on the agent machines.
We recommend that you do not use OS disk for any of the above purposes, to ensure processes get their fair share of resources.
configureUiPathDisks.sh
script to configure and partition the disks.
For download instructions, see configureUiPathDisks.sh.
configureUiPathDisks.sh
script for the following purposes:
- Configure the disks and mount points for a new Automation Suite cluster installation;
- Resize the data disk post-installation.
To make the script executable, run the following command:
chmod +x ./configureUiPathDisks.sh
chmod +x ./configureUiPathDisks.sh
To provide the required permissions to the script, run the following command:
chmod +x configureUiPathDisks.sh
chmod +x configureUiPathDisks.sh
For more details on the script usage, run the following command:
sudo ./configureUiPathDisks.sh --help
sudo ./configureUiPathDisks.sh --help
To configure the cluster disk, run the following command on all the machines:
./configureUiPathDisks.sh --cluster-disk-name name_of_cluster_disk
./configureUiPathDisks.sh --cluster-disk-name name_of_cluster_disk
To configure the etcd disk, run the following command on all the server machines:
./configureUiPathDisks.sh --etcd-disk-name name_of_etcd_disk
./configureUiPathDisks.sh --etcd-disk-name name_of_etcd_disk
To configure the data disk, run the following command on all the server machines and provide the necessary flags based on your requirements:
./configureUiPathDisks.sh --volume name_of_data_disk
./configureUiPathDisks.sh --volume name_of_data_disk
Flag |
Value |
---|---|
|
Disk name example:
/dev/sde You need the disk name when partitioning the disks that host the various mounts for monitoring, Insights, objectstore, and registry. Providing the disk name is mandatory in the first-time configuration of the disk. If it is not provided during the subsequent
run, then any existing disk associated with
uipathdatavg is used to create the partition for the selected component.
|
|
Optional. Only required if the external registry is not available. |
|
Optional. If the flag is not passed during the first run execution, it automatically creates the partition for monitoring
(Prometheus storage). However, the flag is required in the subsequent run, during the resize of the monitoring partition along
with the
--resize flag.
|
|
Optional. Only required if the external objectstore is not available. |
|
Optional. If the flag is not passed during the first run execution, it automatically creates the partition for Insights. However,
it is required in the subsequent run, during the resize of the Insights partition along with the
--resize flag.
|
|
Optional. If the integer value is provided, the selected component is resized, provided that enough space is available. Otherwise, the entire disk is consumed to expand the selected partition. It is mandatory to indicate precisely one partition that must be resized. |
|
Path to the location on the Automation Suite Robots node to download the package for caching. This must be performed only on the Automation Suite Robots node. |
--resize
flag, as shown in the following example:
./configureUiPathDisks.sh --volume /dev/sde --docker-registry --resize 300
./configureUiPathDisks.sh --volume /dev/sde --docker-registry --resize 300
/dev/sde
disk to the existing data disk and how to resize the docker registry partition to 300 GiB.
This step is only required if the external objectstore is not available.
You can add or expand your storage size for the in-cluster objectstore by running the following script on all server nodes:
./configureUiPathDisks.sh --ceph-raw-disk-name name_ceph_raw_disk
./configureUiPathDisks.sh --ceph-raw-disk-name name_ceph_raw_disk
-
An Azure known issue incorrectly marks the Azure disk as non-SSD. If Azure is your cloud provider, and you want to configure the Objectstore disk, follow the instructions in Troubleshooting.
-
Vertical scaling of the existing disks is not supported. To increase the size of your in-cluster storage post-installation, add new raw disks.
To configure the AI Center disk, run the following command on the machines where you plan to execute the training pipelines:
./configureUiPathDisks.sh --aicenter-disk-name name_of_aicenter_disk_to_partition
./configureUiPathDisks.sh --aicenter-disk-name name_of_aicenter_disk_to_partition
To extend the storage for AI Center:
-
If you want to add a new AI Center disk, run the following command on the machine where you plan to add the disk:
./configureUiPathDisks.sh --aicenter-storage-extend name_of_new_aicenter_disk_to_attach
./configureUiPathDisks.sh --aicenter-storage-extend name_of_new_aicenter_disk_to_attach -
If you have expanded the existing AI Center disk, run the following command on the machine where the underlying AI Center disk is expanded:
./configureUiPathDisks.sh --aicenter-storage-extend
./configureUiPathDisks.sh --aicenter-storage-extend
This step is required for single-node setups without a dedicated Automation Suite Robot agent.
To host the Automation Suite Robot package cache on the server node, you need to create a disk of at least 10 GB:
./configureUiPathDisks.sh --volume name_of_data_disk --robot-package-cache
./configureUiPathDisks.sh --volume name_of_data_disk --robot-package-cache
This step is required in the following scenarios:
-
When performing an offline (air-gapped) installation;
-
When an external registry is not available.
To configure the bundle disk, run the following command only on the first server node:
./configureUiPathDisks.sh --bundle-disk-name name_of_bundle_disk
./configureUiPathDisks.sh --bundle-disk-name name_of_bundle_disk
fstab
file and to include the nofail
option in those fstab
entries so that it does not affect the VM boot in case of failure.
/etc/fstab
is correctly configured and can handle a reboot of the system, take the following steps, run the following command:
mount -afv
mount -afv
You should get the following output:
/var/lib/rancher : already mounted
/var/lib/kubelet : already mounted
/opt/UiPathAutomationSuite : already mounted
/datadisk/monitoring : already mounted
/datadisk/insights : already mounted
/var/lib/rancher/rke2/server/db : already mounted
# Additional mount point is require if customer is installing offline with internal registry
/datadisk/registry : already mounted
# Additional mount point is require if customer is using in-cluster objectstore
/datadisk/objectstore : already mounted
/var/lib/rancher : already mounted
/var/lib/kubelet : already mounted
/opt/UiPathAutomationSuite : already mounted
/datadisk/monitoring : already mounted
/datadisk/insights : already mounted
/var/lib/rancher/rke2/server/db : already mounted
# Additional mount point is require if customer is installing offline with internal registry
/datadisk/registry : already mounted
# Additional mount point is require if customer is using in-cluster objectstore
/datadisk/objectstore : already mounted
- Partitioning the disks
- Using the script to configure the disks
- Downloading the script
- Running the script
- Configuring the cluster disk on all the machines
- Configuring the etcd disk on all the server machines
- Configuring the data disk on all the server machines
- Configuring the objectstore disk on all the server machines
- Configuring the AI Center disk on selected machines
- Configuring the hosting disk for the Automation Suite Robot package cache
- Configuring the bundle disk on the first server node for the in-cluster registry
- Validating disk mounts