- Overview
- Requirements
- Pre-installation
- Preparing the installation
- Downloading the installation packages
- Configuring the OCI-compliant registry
- Granting installation permissions
- Installing and configuring the service mesh
- Installing and configuring the GitOps tool
- Installing the External Secrets Operator in Kubernetes
- Applying miscellaneous configurations
- Prerequisite checks
- Output example: prerequisite check
- Running uipathctl
- Installation
- Post-installation
- Migration and upgrade
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library installation
- AI Trust Layer
- Troubleshooting
- The backup setup does not work due to a failure to connect to Azure Government
- Pods in the uipath namespace stuck when enabling custom node taints
- Unable to launch Automation Hub and Apps with proxy setup
- Velero backup fails with FailedValidation error
- External Secrets troubleshooting
- Temporal as a Service troubleshooting
- AI Center and Document Understanding pods fail to start with TLS certificate verification enabled
- TLS certificate validation errors
- Fluentd does not export logs in IPv6 environments
- Studio Desktop cannot load Integration Service connectors and activities
- Manual ArgoCD NetworkPolicy mitigation (GHSA-47m3-95c7-g2g8)
- Configuring resource requests and limits for uipathctl-created workloads
Prerequisite checks
Validation checks performed before Automation Suite installation on EKS/AKS.
It is recommended to run prerequisite checks to ensure that you properly configured the cloud infrastructure and to validate input.json before starting the Automation Suite installation.
You can run a prerequisite check using the command. By default, this command verifies all the prerequisites. You can use the following flags:
--excluded, if you want to exclude components from the execution.--verbose, if you want to access the detailed prerequisites check output. You can skip this flag for a more concise and simplified output.
The prerequisite and health checks/tests run in the <uipath> namespace. You must either grant the uipathctl tool the necessary permissions to allow the creation of the <uipath> namespace or create it yourself before running the checks/tests. Additionally, some checks/tests require that you enable the use of hostNetwork.
The checks in the following table are run on each node:
| Check | Description |
|---|---|
| SQL Connection | Validates that Automation Suite can successfully connect to the SQL server for UiPath® products and shared services (such as Identity, Portal, Org Management, etc.) using the SQL connection strings provided in the input.json file. This is mandatory for a successful installation. |
| SQL DB roles | Validates the necessary roles and permissions required by UiPath® products. This is mandatory for a successful installation. |
| SQL DB compatibility | Validates SQL DB compatibility requirements. |
| FQDN resolution | Validates that the FQDN and the sub-domains are successfully resolvable. |
| Object Storage API | Validates that objectstore APIs are accessible based on access information provided in the input.json file. This is mandatory for a successful installation of the UiPath® services. |
| Cache / Redis | Validates the connection to Cloud Redis or ElastiCache. This is mandatory for a successful installation. |
| Capacity | Validates you have minimum CPU and RAM capacity on the worker nodes based on the products enabled in the input.json file. |
| Storage Class | Validates that the storage classes for File Storage are configured as required for Automation Suite Robots. |
| Optional Components | Validates that your cluster has components that you chose to exclude from the Automation Suite installation. |
| Ingress | Validates that the cluster ingress is configured correctly and the FQDN URL requests can reach UiPath® products. |
| Network Policies | Checks if the network policies configured in Automation Suite are compatible with the cluster. |
| Registry | Validates that Automation Suite can access the UiPath® docker registry. This is mandatory for a successful installation. |
| Cluster Connectivity | Validates whether the cluster communication is configured properly: - Between two random pods completed - Between pod and a multinode ClusterIP - Between pod and a multinode ClusterIP without a clusterIP - Between pod and a multinode ClusterIP using HostNetwork - Between pod and a multinode ClusterIP without a clusterIP set using HostNetwork - Between two pods colocated on the same node via ClusterIP |
| Queues | Validates that queue APIs are accessible based on access information provided in input.json and that the required queues exist. This is mandatory for a successful installation. |