- 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
Evaluating your storage needs
An Automation Suite cluster uses the objectstore disks attached to its server nodes as storage resources available to all the products enabled on your cluster. Each product uses these resources differently.
To understand your storage needs and plan for them accordingly, refer to the following terminology and guidelines.
-
Server node disk size – The size of all individual disks attached to each server node.
- Disks on each server may have different sizes as long as the sum of all the disk sizes is identical on all servers.
- Total cluster disk size – Server node disk size multiplied by the number of server nodes.
-
Application available storage – The amount of storage available for applications to consume.
- Application available storage is lower than the total storage attached. This is to ensure we have a higher resiliency to fault tolerance and high availability.
The following table describes the multi-node HA-ready hardware requirements for the Complete product selection in the context of the previously introduced terms.
Number of server nodes |
Server node disk size |
Total cluster disk size |
Application available storage |
---|---|---|---|
3 |
512 GiB |
1.5 TiB |
512 GiB |
As you enable and use products on the cluster, they consume some storage from the application available storage. Products usually have a small enablement footprint as well as some usage-dependent footprint that varies depending on the use case, scale of use, and project. The storage consumption is evenly distributed across all the storage resources (data disks), and you can monitor the levels of storage utilization using the Automation Suite monitoring stack.
You will receive an alert with a warning when the storage consumption exceeds 75%. You will receive another critical alert when the storage consumption exceeds 85%; in this case, the storage will be read-only.
If your evaluated needs do not meet the recommended hardware requirements, you can add more storage capacity using either one or both of the following methods:
- You have to add a new disk on all the server nodes of same size.
- To configure the disk, see our docs.
You can estimate your storage consumption using the product-specific metric in the following tables. These tables describe how much content you can place on your cluster out of the box. For reference, they include the storage footprint of a typical usage scenario of each product.
Product |
Storage-driving metric |
Storage per metric |
Typical use case |
---|---|---|---|
Shared suite capabilities |
|
N/A |
Typically, 7 days of application logs is around 25 GiB. |
Orchestrator |
|
|
Typically, a package is 5 MiB, and buckets, if any, are less than 1 MiB. A mature enterprise has 5 GiB of packages and 6 GiB of buckets deployed. |
Action Center |
|
|
Typically, a document takes 0.15 MiB, and the forms to fill take an additional 0.15 KiB. In a mature enterprise this can roll up to 4 GiB in total. |
Test Manager |
|
|
Typically, all files and attachments add up to approximately 5 GiB. |
Insights |
|
|
2 GiB are required for enablement, with the storage footprint growing with the number. A well-established enterprise-scale deployment requires another few GiB for all the dashboards. |
Automation Hub |
N/A |
N/A |
2 GiB fixed footprint |
Automation Ops |
N/A |
N/A |
No storage footprint |
Apps |
|
|
Typically, the database takes approximately 5 GiB, and a typical complex app consumes approximately 15 MiB. |
AI Center |
|
|
A typical and established installation will consume 8 GiB for 5 packages and an additional 1GiB for the datasets. A pipeline may consume an additional 50 GiB, but only when actively running. |
Document Understanding |
|
|
In a mature deployment, 12GiB will go to ML model, 17GiB to the OCR, and 50GiB to all documents stored. |
Task Mining |
|
|
Typically, about 200GiB of activity log data should be analyzed to suggest meaningful automations. Highly repetitive tasks however, may require much less data. |
Process Mining |
|
|
Minimal footprint only used by users uploading data via the Process Mining portal. Approximately 10 GiB of storage should be enough in the beginning. |