- 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
- 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
EKS backup and restore
Configure Velero backups and restore procedures for Automation Suite on EKS.
Amazon EKS supports backup and restore through AWS Backup, which protects Kubernetes cluster resources and persistent volumes and enables policy-based restores to existing or new EKS clusters. For details, refer to Amazon EKS backups.
In addition to AWS Backup, Kubernetes-native tools such as Velero can be used to back up and restore EKS cluster resources, particularly for scenarios requiring more granular Kubernetes-level control or custom backup policies for your use case and compliance requirements.
For details, refer to the following AWS resources:
- Amazon EKS backup and restore FAQs
- Backing up and restoring Amazon EKS cluster resources using Velero
Automation Suite on EKS uses two main storage types:
- Amazon EBS (Elastic Block Store) - This provides block-level storage for Kubernetes workloads.
- Amazon EFS (Elastic File System) - This provides shared file storage for workloads that require concurrent access.
To support both storage types and cross-region disaster recovery, UiPath recommends using Velero File System Backup (FSB) with Amazon S3 and Cross-Region Replication (CRR).
With this configuration, backups are stored in the designated S3 bucket, and CRR automatically replicates them to a secondary AWS region for resiliency.
Prerequisites
Before setting up Velero, make sure the following prerequisites are met:
- Velero installation: You must deploy Velero in the EKS cluster using Helm or the Velero CLI.
- IAM permissions: You must grant the Velero service account the required permissions to write to Amazon S3.
- S3 bucket: You must create an Amazon S3 bucket with versioning enabled.
For detailed setup instructions, refer to the official Velero File System Backup setup guide.
Configuring Velero policies
Velero supports flexible policies that determine which resources and volumes are included in backups. For more information about configuring Velero backup policies, refer to the official Velero documentation.
When defining a backup policy, consider the following guidelines:
- PVC exclusion: You must exclude any
PersistentVolumeClaim(PVC) labeled withvelero.io/exclude-from-backup: "true". Velero skips any PVC with this label during the backup process. - Configuring file system backup: You must apply file system backups to PVCs that use supported storage classes. The following storage classes support file system backups:
- EFS storage class (
efs-sc) - EBS storage class (
ebs-sc)Use the following sample policy to configure exclusions and file system backups for these storage classes:
policy: | version: v1 volumePolicies: - conditions: pvcLabels: velero.io/exclude-from-backup: "true" action: type: skip - conditions: csi: driver: efs.csi.aws.com storageClass: - efs-sc action: type: fs-backup - conditions: csi: driver: ebs.csi.aws.com storageClass: - ebs-sc action: type: fs-backuppolicy: | version: v1 volumePolicies: - conditions: pvcLabels: velero.io/exclude-from-backup: "true" action: type: skip - conditions: csi: driver: efs.csi.aws.com storageClass: - efs-sc action: type: fs-backup - conditions: csi: driver: ebs.csi.aws.com storageClass: - ebs-sc action: type: fs-backup - EFS storage class (
- Backup destination: With file system backup, all backup data is uploaded to the configured Amazon S3 bucket. If Cross-Region Replication (CRR) is enabled, backups are automatically replicated across regions for improved resiliency.
Running backups and restores
To create a backup in Velero:
- Follow the Velero backup guide.
- Configure a Backup Custom Resource (CR) to define the namespaces and resources included in the backup.
Automation Suite namespaces are automatically labeled with created-by=uipath. You can selectively back up only UiPath-related namespaces by including only those labeled with this key. This ensures all UiPath-specific resources are safely backed up.
For details, refer to Velero resource filtering.
To restore workloads from a backup:
- Follow the Velero restore guide.
- Reference a Restore Custom Resource (CR) that specifies the backup and target resources.
When restoring in a cluster that has the Cluster Autoscaler enabled, Velero may report partial restore failures. You might see an error such as node-agent pod is not running in node: daemonset pod not found in running state in node.
If you encounter this issue, you must check the status of podvolumerestore (PVR) objects. If all PVRs show Success, you can consider the restore successful.
For details, refer to Velero issue #7170 and Velero issue #9203.