- Overview
- Requirements
- Deployment templates
- Manual: Preparing the installation
- Manual: Preparing the installation
- Step 2: Configuring the OCI-compliant registry for offline installations
- Step 3: Configuring the external objectstore
- Step 4: Configuring High Availability Add-on
- Step 5: Configuring SQL databases
- Step 7: Configuring the DNS
- Step 8: Configuring the disks
- Step 9: Configuring kernel and OS level settings
- Step 10: Configuring the node ports
- Step 11: Applying miscellaneous settings
- Step 12: Validating and installing the required RPM packages
- Step 13: Generating cluster_config.json
- Cluster_config.json Sample
- General configuration
- Profile configuration
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- ArgoCD configuration
- Kerberos authentication 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
- AI Center-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
- Adding a dedicated agent node with GPU support
- 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
- Running uipathctl
- Manual: Performing the installation
- Post-installation
- Cluster administration
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating Redis from in-cluster to external High Availability Add-on
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Migrating from in-cluster registry 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
- Scaling a single-node (evaluation) deployment to a multi-node (HA) deployment
- Monitoring and alerting
- Migration and upgrade
- Migrating between Automation Suite clusters
- 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
- Best practices and maintenance
- Troubleshooting
- How to troubleshoot services during installation
- How to reduce permissions for an NFS backup directory
- 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 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
- How to check the TLS version
- How to work with certificates
- How to schedule Ceph backup and restore data
- How to collect DU usage data with in-cluster objectstore (Ceph)
- How to install RKE2 SELinux on air-gapped environments
- How to clean up old differential backups on an NFS server
- Error in downloading the bundle
- Offline installation fails because of missing binary
- Certificate issue in offline installation
- SQL connection string validation error
- 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
- Temporary registry installation fails on RHEL 8.9
- Frequent restart issue in uipath namespace deployments during offline installations
- DNS settings not honored by CoreDNS
- Upgrade fails due to unhealthy Ceph
- RKE2 not getting started due to space issue
- Upgrade fails due to classic objects in the Orchestrator database
- Ceph cluster found in a degraded state after side-by-side upgrade
- Service upgrade fails for Apps
- In-place upgrade timeouts
- Upgrade fails in offline environments
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- Upgrade fails due to overridden Insights PVC sizes
- Upgrade failure due to uppercase hostname
- 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
- Missing Ceph-rook metrics from monitoring dashboards
- Mismatch in reported errors during diagnostic health checks
- No healthy upstream issue
- Redis startup blocked by antivirus
- Running High Availability with Process Mining
- Process Mining ingestion failed when logged in using Kerberos
- 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
- Automation Suite certificate is not trusted from the server where CData Sync is running
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
- Exploring summarized telemetry

Automation Suite on Linux installation guide
Step 1: Preparing the AWS Marketplace deployment
This page lists the steps you need to take before deploying Automation Suite to AWS.
To prevent data loss, ensure the infrastructure you use does not automatically delete cluster disks on cluster reboot or shutdown. If this capability is enabled, make sure to disable it.
Getting started on AWS
The AWS deployment requires a moderate level of familiarity with AWS services.
If you are new to AWS, you can start by reading the following introductory materials to get familiar. They provide basic materials for how to design, deploy, and operate infrastructure and applications on the AWS Cloud.
This deployment also assumes familiarity with AWS Services listed in the Request resources quotas section of this guide. For a detailed diagram and description of the architecture, see:
Creating an AWS account
If you don't already have an AWS account, create one by following the step-by-step instructions. Your AWS account is automatically signed up for all AWS services. You are charged only for the services you use.
Configuring your AWS account
The following sections walk you through the steps you need to take to configure your AWS Account specific to the Automation Suite deployment requirements.
Amazon EC2 key pairs
You need at least one EC2 key pair in the AWS account in the Region where you will deploy the AWS Marketplace offering.
To create a key pair, see Amazon EC2 key pairs and Linux instances.
Take note of the key-pair name as it is needed during the deployment.
For testing or evaluation purposes, we recommend creating a new key pair instead of using an existing one.
Valid domain name
This deployment requires you to have established ownership of the parent domain under which the web application will be served. If you want to register a domain, see Registering a public domain.
If you have registered the domain using AWS Route 53, then the hosted zone is preconfigured, and no additional configuration is necessary.
Otherwise, you should set up a hosted zone in your AWS account, with the required name server, start of authority, CNAME, and text records. For further details on how to create a public hosted zone, see Working with public hosted zones.
To use other DNS provider, leave the hosted zone id parameter empty. This pauses the deployment after the load balancer creation, allowing you to manually configure the DNS. To resume the deployment, search for the WaitConditionHandle resource in the routing stack. The Physical Id of this resource is an URL. Execute a POST request as described here.
Request resource quotas
If necessary, request service quota increases for the following resources. You might need to request increases if your existing deployment currently uses these resources and if the AWS Marketplace deployment could result in exceeding the default quotas. The Service Quotas console displays your usage and quotas for some aspects of some services.
For more information, see What is Service Quotas? and AWS service quotas.
| Resource | Requirement |
|---|---|
| VPCs | 1 |
| Subnets | Up to 6 |
| NAT gateways | 2 |
| VPC endpoints | 1 |
| Internet gateways | 1 |
| Elastic IP addresses | Up to 6 |
| AWS Identity and Access Management (IAM) security groups | 1 |
| IAM roles | Up to 7 |
| Auto Scaling groups | Up to 2 |
| Application Load Balancers | Either 0 or 1 |
| Network Load Balancers | Either 1 or 2 |
| Public certificate authorities (CA) | 1 |
| Hosted zone | 1 |
| RDS instances | 1 |
| Bastion hosts | 1 |
| Secrets | 4 |
| Parameters in Parameter Store | 3 |
| SSM documents | Either 0 or 3 |
| Lambda Functions | 3 |
| Instance Profiles | 2 |
| Security Groups | 3 |
Supported AWS regions
In order for the AWS Marketplace deployment to work in a Region other than its default Region, all the services that are part of the deployment must also be supported in that Region.
For an up-to-date list of AWS Regions and the AWS services they support, see AWS Regional Services.
Certain Regions are available on an opt-in basis. For more information, see Managing AWS Regions.
To test whether a specific Region is supported, you can launch the AWS Marketplace deployment for that Region and, if you get an Unrecognized resource type error, then the deployment is not supported in that Region.
IAM permissions
Before launching the AWS Marketplace deployment, you must sign in to the AWS Management Console with IAM permissions for the resources that the templates deploy. The AdministratorAccess managed policy within IAM provides sufficient permissions, although your organization may choose to use a custom policy with more restrictions.
For more information, see AWS managed policies for job functions.
For a complete list of roles and policies that the CloudFormation template creates, see Roles and policies.
Connections to external endpoints
The following table describes all the external endpoints that the service interacts with:
| Requirements | Details |
|---|---|
| AWS metadata service | Provides details about your Amazon EC2 instance |
| AWS management APIs | Used via AWS CLI or lambda functions |
| AWS bootstrap archive | Used for services to provision and manage resources. Retrieved from the following URL: https://s3.amazonaws.com/cloudformation-examples/aws-cfn-bootstrap-py3-latest.tar.gz |
| AWS CLI package | Used for the command line interface to interact with AWS services from a machine. You can access the package from the following URL: https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip |
| AWS SSM Agent | Used for managing instances via remote commands at scale. You can download the agent from the following URL: https://s3.${AWS::Region}.amazonaws.com/amazon-ssm-${AWS::Region}/latest/linux_amd64/amazon-ssm-agent.rpm |
| AWS Cloudwatch Agent | Used for collecting system and application logs for monitoring. You can download the agent from the following URL: https://s3.amazonaws.com/amazoncloudwatch-agent/redhat/amd64/latest/amazon-cloudwatch-agent.rpm |
| Nvidia drivers | Required for GPU-enabled VMs. You can get the drivers from the Nvidia repository. |
| External repository if used | N/A |
| UiPath S3 buckets for templates / lambda functions usage / bash scripts for installation. | N/A |
For more details, see Network requirements.
Connecting AI Center to an external Orchestrator
To connect AI Center to an external Orchestrator, you must set Connect AiCenter to an external Orchestrator to true and provide certificates for Orchestrator and Identity to the parameters listed in AWS Marketplace deployment parameters. For details on how to obtain the certificates, see Chain certificates.
To encode the certificates in base64 format, run the following commands:
cat orchestrator.cer | base64 | tr -d '\n' > orchestratorCert
cat identity.cer | base64 | tr -d '\n' > identityCert
cat orchestrator.cer | base64 | tr -d '\n' > orchestratorCert
cat identity.cer | base64 | tr -d '\n' > identityCert
To register AI Center to the external Orchestrator, you must run this SSM document.
Backing up the cluster
The AWS template allows you to enable a backup at deployment time. By default, the backup interval is set to 90 minutes, and the retention interval is set to 72 hours. You can change the default values post-deployment.
Enabling FIPS 140-2
You can only enable FIPS 140-2 on your machines after completing an Automation Suite installation. For instructions, see Security and compliance.
Insights does not support FIPS 140-2, and you must disable it for a successful installation.
- Getting started on AWS
- Creating an AWS account
- Configuring your AWS account
- Amazon EC2 key pairs
- Valid domain name
- Request resource quotas
- Supported AWS regions
- IAM permissions
- Connections to external endpoints
- Connecting AI Center to an external Orchestrator
- Backing up the cluster
- Enabling FIPS 140-2