Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Deployment architecture and installation best practices

This page offers insight into the Automation Suite architecture and describes the components bundled into the installer.

Deployment architecture

Single-node deployment diagram


Multi-node deployment diagram


Online deployment diagram


Offline deployment diagram


Node types


 

High Availability Add-on


In a multi-node setup, High Availability (HA) is enabled by default. However, the Redis-based in-memory cache used by cluster services is running on a single node and represents a single point of failure. To mitigate the impact of a cache node failure or restart, you can purchase the High Availability Add-on (HAA), which enables redundant, multi-node deployment of the cache.

For more details on how to enable HAA in a multi-node setup, see Enabling High Availability Add-on for the cluster.

 

Components installed by the installer


The Automation Suite installer bundles both required and optional components.
The following table lists out these components:

Component

Optional/Required

Description

RKE2

Required

Rancher-provided Kubernetes distribution. It is the container orchestration platform that runs all the architectural components and services.

Rancher Server

Required

Rancher’s Kubernetes management tool.

Longhorn

Required

Rancher-provided distributed block storage for Kubernetes. It helps expose external storages inside Kubernetes clusters for workloads to claim and use like mounted persistent storage.

CEPH Object Store

Required

Open-source storage provider that exposes Amazon S3-compliant object/blob storage on top of persistent volumes created by Longhorn. It enables services to use blob storage like functionality for their operations.

Argo CD

Required

Open-source declarative CD tool for Kubernetes. It follows the GitOps pattern of using Git repositories as the source of truth for defining the desired application state. It provides application lifecycle management (ALM) capabilities for Automation Suite components and UiPath services that run in a Kubernetes cluster.

Docker registry

Required

Open-source docker registry used for pushing and pulling install time and runtime container images in your premises.

Istio

Required

Open-source service mesh that provides functionality such as ingress, request routing, traffic monitoring etc., for the microservices running inside the Kubernetes cluster.

Prometheus

Required

Open-source system monitoring toolkit for Kubernetes. It can scrape or accept metrics from Kubernetes components as well as workloads running in the clusters and store those in time series database.

Grafana

Required

Open-source visualization tool used for querying and visualizing data stored in Prometheus. You can create and ship a variety of dashboards for cluster and service monitoring.

Alertmanager

Required

Open-source tool that helps handling alerts sent by client applications such as the Prometheus server. It is responsible for deduplicating, grouping, and routing them to the correct receiver integrations, such as email, PagerDuty, or OpsGenie.

Redis

Required

Redis Enterprise non-HA (single shard) used by some UiPath services to get centralized cache functionality.

RabbitMQ

Required

Open-source reliable message broker used by some UiPath services to implement asynchronous execution patterns.

MongoDB

Optional

MongoDB is a source-available cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas. MongoDB is deployed only when "Uipath Apps" is enabled

FluentD and Fluentbit

Required

Open-source reliable log scraping solution. The logging operator deploys and configures a background process on every node to collect container and application logs from the node file system.

Gatekeeper

Required

Open-source tool that allows a Kubernetes administrator to implement policies for ensuring compliance and best practices in their cluster.

 

External components


You also need to bring a few external components, such as external load balancers, an SQL server, blob/file storage, key vaults, log sinks, and notification tools. Note that the suite provides some extension points.

 

Installation best practices


The installation process takes approximately 20-30 minutes. To avoid your SSH session getting interrupted, we recommend initiating a tmux session and then running the installation process in the context of that session. If run under the tmux session, the SSH session can be interrupted, and you can reconnect to the previous session from where installer was initiated.

Take the following steps:

  1. SSH into the remote machine.

  2. Install tmux on the machine using the following command:

sudo yum install tmux
  1. Create a tmux session by running the following command.
tmux new -s uipath_install
  1. Once inside tmux, you can start the installation process.
  • Commands such as the one below run in the session.
./installUiPathAS.sh
sudo ./install-uipath.sh -i ./cluster_config.json -o ./output.json -k -j server --offline-bundle ./sf-infra.tar.gz --offline-tmp-folder /var/tmp --install-offline-prereqs --accept-license-agreement
  • To list all sessions, run the following command:
tmux ls
  • To connect to most recent session, run the following command:
tmux a
  • To connect to a session by name, run the following command:
tmux attach -t uipath_install
  1. To leave or detach from the tmux session, press Ctrl+B and then press D.

Updated about a month ago


Deployment architecture and installation best practices


This page offers insight into the Automation Suite architecture and describes the components bundled into the installer.

Suggested Edits are limited on API Reference Pages

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