- 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 bundle
- 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
- 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
- Upgrade fails in offline environments
- SQL validation fails during upgrade
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- 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
- 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 Tool
- Exploring Logs
Automation Suite overview
This page outlines the capabilities and product offerings you can enjoy if you install Automation Suite, and helps you get an idea about the architecture you are about to build.
Automation Suite enables you to deploy the full UiPath® automation platform in a Linux environment ranging from bare metal machines to on-premises Virtual Machine infrastructure, or cloud subscriptions to any of the major providers.
Managing multiple server product deployments independently usually requires configuring integrations with enterprise systems for authenticating and managing users, as well as managing and monitoring each deployment from an availability and scale perspective.
Automation Suite contains everything in one package that you can deploy in multi-node HA-ready production mode with automatic scaling and built-in HA, and monitor, configure, and upgrade as a whole. All the functionality available in Automation Cloud is adapted to make it easier for you to manage everything yourself with low total cost of ownership.
What 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.
- Kubernetes-based infrastructure, cluster management, and monitoring tools, all preconfigured, dedicated to and optimized for UiPath®. This enables running all the products at scale and with HA. This means you do not have to design, configure, and validate which Kubernetes versions and components for routing, storage, etc., work well with the UiPath® services.
Everything needed is included and optimized, all supported by UiPath®.
You just need to bring the machines, load balancer, and SQL. For the specific requirements for the machines as well as installation options and instructions, see and the remaining of this section.
- Online single-node evaluation
- Online multi-node HA-ready production
- Offline single-node evaluation
- Offline multi-node HA-ready production
cluster_config.json
configuration at installation time. We also support the ability to add more nodes to either single-node evaluation or multi-node
HA-ready production configurations to scale out. However, we do not support going from non-HA to HA mode.
The upgrade process covers both the infrastructure and the entire UiPath® automation platform.
We are using Rancher as the UI layer for managing our cluster. The UI provides a cluster explorer to manage the deployment.
The platform exposes Grafana, Prometheus, and Alertmanager by default for troubleshooting and monitoring. See how to monitor the cluster, set alerts, create and view dashboards to track the deployment here.
For more details, see Monitoring Stack for UiPath Automation Suite.
Support Bundle tool collects logs from the in-cluster object/blob store, logs from currently running pods (of last four hours), different events, and Kubernetes object definitions.
For more details on how to use the tool, see Support Bundle.
The suite supports backup and recovery for the entire cluster except for external data sources, such as SQL Server.
Cluster backup is enabled by default every 15 minutes.
For more details, see Backing up and restoring the cluster.
The suite supports both SQL authentication and Kerberos authentication for all SQL database connections.
Learn more about Automation Suite products.
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 |