- Overview
- Requirements
- Installation
- Q&A: Deployment templates
- Configuring the machines
- Configuring the external objectstore
- Configuring an external Docker registry
- Configuring the load balancer
- Configuring the DNS
- Configuring Microsoft SQL Server
- Configuring the certificates
- Online multi-node HA-ready production installation
- Offline multi-node HA-ready production installation
- Disaster recovery - Installing the secondary cluster
- Downloading the installation packages
- install-uipath.sh parameters
- Enabling Redis High Availability Add-On for the cluster
- Document Understanding configuration file
- 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
- Post-installation
- Cluster administration
- Monitoring and alerting
- Migration and upgrade
- Migration options
- 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 Insights
- Step 7: Deleting the default tenant
- B) Single tenant migration
- Product-specific configuration
- 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 automatically clean up Longhorn snapshots
- How to disable NIC checksum offloading
- How to manually set the ArgoCD log level to Info
- 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
- GPU node affected by resource unavailability
- Volume unable to mount due to not being ready for workloads
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- Failure to resize PVC
- Failure to resize objectstore PVC
- Rook Ceph or Looker pod stuck in Init state
- StatefulSet volume attachment error
- Failure to create persistent volumes
- Storage reclamation patch
- Backup failed due to TooManySnapshots error
- All Longhorn replicas are faulted
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- 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
- 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
- Issues accessing the ArgoCD read-only account
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unhealthy services after cluster restore or rollback
- Pods stuck in Init:0/X
- Prometheus in CrashloopBackoff state with out-of-memory (OOM) error
- Missing Ceph-rook metrics from monitoring dashboards
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
AWS deployment parameters
This page documents the AWS parameters you need to configure when deploying Automation Suite to AWS.
The Template-hosting S3 Region parameter must match exactly the AWS region in which you try to deploy. If the region does not match, the deployment does not succeed.
Keep the default settings for the parameters labeled Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. If these input parameters are altered, the deployment does not succeed.
Parameter label (name) |
Template |
Default value |
Description |
---|---|---|---|
Availability Zones (
AvailabilityZones )
|
|
|
Choose up to three Availability Zones to use for the VPC subnets. |
Number of Availability Zones (
NumberOfAZs )
|
|
|
Choose the number of Availability Zones to use in the VPC. This must match the number of AZs selected in the Availability Zones parameter. |
Deploy Bastion host |
|
|
Deploy a Bastion host inside the public subnet. |
Parameter label (name) |
Template |
Default value |
Description |
---|---|---|---|
VPC CIDR |
|
|
VPC CIDR block. Example:
x.y.0.0/16 , x.y.z.0/24 .
|
VPC ID |
|
|
ID of the existing VPC. |
Public Subnets IDs |
|
|
List of public subnet IDs to deploy the internet-facing Load Balancer and the Bastion host. |
Private Subnets IDs |
|
|
List of private subnet IDs. |
Parameter label (name) |
Template |
Default value |
Description |
---|---|---|---|
Instance key pair (
KeyPairName )
|
|
|
Existing key pair to connect to virtual machine (VM) instances. |
Instance AMI id |
|
|
AMI ID to be used for the creation of the EC2 instances of the cluster. When AMI ID is not specified, the default version deployed is RHEL 8.3 for non GPU VM and RHEL 8.2 for GPU VM. |
GPU instance AMI id |
|
|
AMI ID to be used for the creation of the GPU enabled EC2 instance. |
IAM Role ARN |
|
|
ARN of a pre-deployed IAM Role with sufficient permissions for the deployment. |
IAM Role name |
|
|
Name of a pre-deployed IAM Role with sufficient permissions for the deployment |
Parameter label (name) |
Template |
Default value |
Description |
---|---|---|---|
Specify Deployment Type (
MultiNode )
|
|
|
Install Automation Suite in single-node evaluation mode or multi-node HA-ready production mode. |
Enable cluster backup |
|
|
Enable the cluster backup. |
Load Balancer (
UseLevel7LoadBalancer )
|
|
|
Select either an Application Load Balancer (ALB) or a Network Load Balancer (NLB). If you select a Network Load Balancer, then you need to manually configure the TLS certificates post deployment. |
Perform Installation |
|
|
Perform the Automation Suite installation. |
Automation Suite Version (
UiPathVersion )
|
|
eg.
22.10.0 |
UiPath version to install |
Installer download URL |
|
|
Choose to add a GPU-enabled VM to the deployment. |
Extra configuration keys |
|
|
Extra configuration keys to add to the cluster configuration. |
Parameter label (name) |
Template |
Default value |
Description |
---|---|---|---|
Services Install flags (multiple) |
|
|
Choose if the specific service is installed in the cluster. |
Parameter label |
Template |
Default value |
Description |
---|---|---|---|
ExternalRegistryFQDN |
| Blank string | External registry Fully Qualified Domain Name |
ExternalRegistryUsername |
| Blank string | External registry username. |
ExternalRegistryPassword |
| Blank string | External registry password. |
Parameter label (name) |
Template |
Default value |
Description |
---|---|---|---|
Connect AI Center to an external Orchestrator |
|
|
Register AI Center to an external Orchestrator. |
Orchestrator URL |
|
|
URL of the external Orchestrator. Example:
https://my-orchestrator.net |
Identity URL |
|
|
URL of the Identity server used. Example:
https://my-orchestrator.net/identity |
Base64 encoded Orchestrator certificate |
|
|
Base64 encoded string Orchestrator certificate Example:
UExBQ0VIT0xERVI= |
Base64 encoded Identity certificate |
|
|
Base64 encoded string Identity certificate Example:
UExBQ0VIT0xERVI= |
Parameter label (name) |
Templates |
Default value |
Description |
---|---|---|---|
Cluster FQDN (
UiPathFQDN )
|
|
|
Fully qualified domain name (FQDN) for Automation Suite. This must be either a subdomain or root domain of the of
ID of Route 53 hosted zone parameter.
|
ID of Route 53 hosted zone (
HostedZoneID )
|
|
|
ID of Route 53 hosted zone or leave blank. For details, see Valid domain name. |
ARN of the ACM hosted certificate to use |
|
|
ARN of the certificate present in the ACM (Amazon Certificate Manager) to use with the ALB. |
Use Internal Load Balancer |
|
|
Choose if you want to use an internal load balancer. |
Parameter label (name) |
Template |
Default value |
Description |
---|---|---|---|
Engine of SQL Server deployed on RDS |
|
|
Choose the RDS Microsoft SQL engine. |
Version of SQL Server deployed on RDS |
|
|
Choose the RDS Microsoft SQL version. |
KMS Key Id used to encrypt RDS storage |
|
|
KMS Key ID to use for the encryption of the RDS storage. |
Parameter label (name) | Template | Default value | Description |
---|---|---|---|
Template folder |
|
| You must not change the value. |
Template-hosting S3 Region |
|
|
Must match the region where you deploy the resources in AWS. For example, if you want to deploy in
us-east-1 , select us-east-1 .
|
- Table 1. Availability Zone configuration
- Table 2. Network configuration
- Table 3. Automation Suite instance configuration
- Table 4. Automation Suite deployment configuration
- Table 5. Automation Suite service configuration
- Table 6: Automation Suite external registry configuration
- Table 7. AI Center with external Orchestrator
- Table 8. DNS or SSL configuration
- Table 9. RDS configuration
- Table 10. Partner Solution S3 bucket configuration