- Overview
- Requirements
- Installation
- Prerequisite checks
- Downloading the installation packages
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster upgrade
- uipathctl config
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config additional-ca-certificates get
- uipathctl config tls-certificates get
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config additional-ca-certificates update
- uipathctl config tls-certificates update
- uipathctl health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test
- uipathctl identity
- uipathctl identity add-host-admin
- uipathctl identity enable-basic-auth
- uipathctl identity get-saml-certificate
- uipathctl identity get-token-signing-certificate
- uipathctl identity rotate-saml-certificates
- uipathctl identity rotate-token-signing-certificates
- uipathctl identity update-saml-certificate
- uipathctl identity update-token-signing-certificate
- uipathctl manifest
- uipathctl manifest apply
- uipathctl manifest diff
- uipathctl manifest get
- uipathctl manifest list-applications
- uipathctl manifest render
- uipathctl prereq
- uipathctl prereq create
- uipathctl prereq run
- uipathctl resource
- uipathctl resource report
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- uipathctl sso
- uipathctl sso generate-connector
- uipathctl sso generate-overlays
- uipathctl sso generate-rbac
- uipathctl version
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite on EKS/AKS
- Migration options
- 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 Insights
- Step 7: Deleting the default tenant
- B) Single tenant migration
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
Automation Suite overview
Automation Suite enables you to deploy the UiPath® business automation platform in your environment of your choice. Depending on your needs, you can deploy the platform on Linux servers (bare-metal or virtual machines) in your data center or public cloud (Azure, AWS, or GCP), or on your Kubernetes clusters in Amazon Web Services (Elastic Kubernetes Service) or Microsoft Azure (Azure Kubernetes Service).
Automation Suite includes:
-
All Server Products (except for any new products shipping in Automation Cloud first).
-
All Shared Suite Capabilities that enable you to easily configure the integration with existing enterprise systems, such as AD, AAD, or SAML, across all products; a common experience is offered across the suite for the user, tenant, external applications, and license management.
-
Common end-user portal.
This guide provides documentation for installing Automation Suite on your EKS or AKS clusters.
You can deploy Automation Suite in an online environment, with or without a proxy.
Automation Suite is pre-configured with optional OPA policies and network policies to follow the principles of the least privilege. In addition, to control the OPA policies, Automation Suite also bundles an optional Gatekeeper component.
Before installing Automation Suite, you must make sure that your cluster meets the infrastructure requirements.
uipathctl
CLI tool, which handles
operations such as running prerequisite validations, installing
Automation Suite on your cluster, and performing upgrades.
uipathctl
, such as adding new products, updating
certificates, configuring Automation Suite in maintenance mode, taking backups, and
monitoring.
This section provides more details on how to upgrade Automation Suite or your infrastructure underneath Automation Suite, and how to migrate from standalone products to Automation Suite.
For details, see Upgrade and Migration options.
We aim to provide feature parity between our Automation Suite deployment models. However, there will always be some differences you should be aware of.
User scenario/Feature | Embedded | Azure/AKS | Amazon/EKS |
---|---|---|---|
Service capabilities | |||
Orchestrator |
YES | YES | YES |
AI Center | YES | YES | YES |
AI Center with external orchestrator (standalone) | YES |
NO |
NO |
Apps | YES | YES | YES |
Action Center | YES | YES | YES |
Automation Hub | YES | YES | YES |
Automation Ops | YES | YES | YES |
Data Service | YES | YES | YES |
Document Understanding | YES | YES | YES |
Insights | YES | YES | YES |
Automation Suite Robots | YES | YES | YES |
Process Mining | YES | YES | YES |
Task Mining | YES | YES | YES |
Test Manager | YES | YES | YES |
Integration Service |
NO | NO | NO |
Communications mining | NO | NO | NO |
Studio Web | NO | NO | NO |
Architecture | |||
Kubernetes | Rancher RKE2 | AKS | EKS |
Databases |
MS SQL Note:
Additional Microsoft SQL platforms, such as Azure SQL Database or Azure SQL Managed Instance, as well as Amazon Relational Database Service are also supported as long as the Microsoft SQL Server database engine meets the requirements. | ||
Storage |
UiPath provides the Longhorn and Ceph. |
|
|
Service Mesh and Routing |
Rancher provided Istio Service Mesh, Routing via envoy ingress gateway |
OSS Istio Service Mesh Routing via WASM plugin |
OSS Istio Service Mesh Routing via WASM plugin |
OPA |
OSS Gatekeeper |
OSS Gatekeeper |
OSS Gatekeeper |
Monitoring |
Rancher provided Prometheus & Grafana |
OSS Prometheus & Grafana |
OSS Prometheus & Grafana |
Caching |
Embedded Redis with in the cluster and provided by UiPath |
Cloud Redis outside the cluster and managed by customer |
Cloud Redis outside the cluster and managed by customer |
Logging Aggregation |
Rancher provided Fluend/Fluent-bit |
OSS Fluend/Fluent-bit |
OSS Fluend/Fluent-bit |
Cert Manager |
OSS Cert Manager |
OSS Cert Manager |
OSS Cert Manager |
Deployment tool |
OSS ArgoCD |
OSS ArgoCD |
OSS ArgoCD |
Deployment scenario | |||
Single Node (Non-production) |
YES |
NO |
NO |
Multi Node (HA) |
YES (requires additional HAA license) |
YES |
YES |
Online |
YES | YES | YES |
Offline | YES |
NO |
NO |
Deployment method | |||
Advanced CLI | install-uipath.sh |
| uipathctl |
Interactive Installer |
YES (
InstallUipathAS.sh )
|
NO |
NO |
Cloud deployment templates |
YES (AWS, Azure, GCP) |
NO |
NO |
Marketplace |
YES (AWS QS Only) |
NO |
NO |
Installation | |||
A la carte product selection |
YES | YES | YES |
Custom domain | YES | YES | YES |
Custom certificates | YES | YES | YES |
Hardware requirements validation | YES | YES | YES |
Proxy configuration | YES | YES | YES |
Optional OSS/fabric component |
NO | YES | YES |
Enterprise grade features | |||
Disaster Recovery |
YES (Active Passive deployment) | YES
(Multi-zone architecture for UiPath services without zone affinity. Insights not supported.) | YES
(Multi-zone architecture without zone affinity. Insights not supported.) |
Backup/restore | YES | YES | YES |
Upgrade |
YES | YES | YES |
Troubleshooting | |||
Support bundle | YES
(
support-bundle.sh )
|
NO |
NO |
Diagnostic tool | YES
(
diagnostics-report.sh )
| YES
(
uipathctl )
| YES (uipathctl )
|
Health Checks |
NO | YES (uipathctl )
| YES (uipathctl )
|
Security | |||
FIPS enabled host |
YES |
NO |
NO |
Gatekeeper/OPA policy | YES | YES | YES |
Network policy |
NO | YES | YES |
Hardened Uipath service container images | YES | YES | YES |
ArgoCD SSO | YES (LDAP only)
|
NO |
NO |
mTLS for service communication |
YES |
YES |
YES |
Migration options | |||
Standalone Orchestrator to Automation Suite full migration | YES | YES | YES |
Standalone Orchestrator to Automation single tenant migration options | YES | YES | YES |
Automation Suite embedded to AS on AKS/EKS |
NO |
NO |
NO |
Details |
Instructions |
---|---|
Requirements and installation instructions for Automation Suite. |
Details |
Instructions |
---|---|
Complete an initial platform configuration. | |
Connect your first robot | |
Monitor the stack, troubleshoot issues, create alerts, and view dashboards from a centralized location. |
The following instructions take you to the corresponding product guides.
Product |
Evaluation checklist |
---|---|
Orchestrator | |
Automation Suite Robots | |
Automation Hub | |
Automation Ops | |
Test Manager | |
AI Center | |
Action Center | |
Task Mining | |
Apps | |
Insights | |
Data Service | |
Process Mining | |
Document Understanding |