- 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
AWS Marketplace deployment parameters
This page documents the AWS parameters you need to configure when deploying Automation Suite to AWS.
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Deploy to an existing VPC |
|
Choose
true to deploy Automation Suite in an
existing VPC.
|
|
Parameter label (name) |
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 subnet IDs |
|
List of public subnet IDs to deploy the internet-facing Load Balancer and the Bastion host. |
|
Private Subnet IDs |
|
List of private subnet IDs. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Availability Zones |
|
Choose up to three Availability Zones to use for the VPC subnets. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Number of Availability Zones |
|
Choose the number of Availability Zones to use in the VPC. This must match the number of zones selected in the Availability Zones parameter. |
|
Deploy Bastion host |
|
Deploy a Bastion host inside the public subnet. |
|
CIDR for bastion's ingress for SSH traffic |
|
Ingress Security Group CIDR (for SSH). Configure this parameter only if you have set the Deploy Bastion host parameter to
true. Set to x.x.x.x/32 to allow one specific IP address access, 0.0.0.0/0 to allow all IP addresses access, or another CIDR range.
|
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Server instance type |
|
Choose the node type for the Server node instances. |
|
Server instance count |
|
Choose the number of nodes to be deployed as Server node instances. |
|
Agent instance type |
|
Choose the node type for the Agent node instances. |
|
Agent instance count |
|
Choose the number of nodes to be deployed as Agent node instances. |
|
GPU agent instance type |
|
Choose the node type for the GPU Agent node instance. |
|
Task Mining agent instance type |
|
Choose the node type for the Task Mining Agent node instance. |
|
AS Robots agent instance type |
|
Choose the node type for the AS Robots Agent node instance. |
|
AS Robots agent instance count |
|
Choose the number of nodes to be deployed as AS Robots Agent node instances. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Instance key pair |
|
Existing key pair to connect to virtual machine (VM) instances. |
|
IAM role ARN |
|
ARN of a pre-deployed IAM Role with sufficient permissions for the deployment. Leave empty to create a new role automatically during deployment. |
|
IAM role name |
|
Name of a pre-deployed IAM role with sufficient permissions for the deployment. Leave empty to create a new role automatically during deployment. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Enable cluster backup |
|
Enable the cluster backup. |
|
Use a shared bucket for external storage |
|
Enable a shared bucket across products. If enabled, Process Mining and Data Service still require a dedicated bucket each. |
|
Load balancer |
|
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. |
|
Ingress Security Group CIDR (for https) | Empty string | Ingress Security Group CIDR (for HTTPS). Set the CIDR to
allow access to Automation Suite. Set the CIDR to
x.x.x.x/32 to allow one specific IP address access,
0.0.0.0/0 to allow all IP addresses access, or
another CIDR range.
|
|
Perform installation |
|
Perform the Automation Suite installation. Choose
false to perform only infrastructure provisioning and configuration.
|
|
Automation Suite version |
e.g.
2023.10.1 |
Automation Suite version to install |
|
Add GPU-enabled VMs |
|
Choose
true to add a GPU-enabled VM to the deployment.
|
|
Extra configuration keys |
|
Extra configuration keys to add to the cluster configuration. Leave empty to use the default configuration. |
|
Validity of the self-signed certificate |
| Validity (in days) of the self-signed certificate that the deployment uses to encrypt traffic inside the VPC. |
|
Disable presigned URL |
|
Enable or disable objectstore access via pre-signed URLs. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
External registry Fully Qualified Domain Name |
|
FQDN for the external registry. Leave empty to not use an external registry. |
|
External registry user name |
|
User name for connecting to the external registry. Leave empty to not use an external registry. |
|
External registry password |
|
Password for connecting to the external registry. Leave empty to not use an external registry. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Service install flags (multiple) |
|
Choose if a specific service is installed in the cluster. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Connect AI Center to an external Orchestrator |
|
Register AI Center to an external Orchestrator. |
|
Orchestrator URL |
|
URL of the external Orchestrator to which AI Center connects. Example:
https://my-orchestrator.net |
|
Identity URL |
|
URL of the Identity server used to authorize AI Center. Example:
https://my-orchestrator.net/identity |
|
Base64 encoded Orchestrator certificate |
|
Base64 encoded Orchestrator certificate string Example:
UExBQ0VIT0xERVI= |
|
Base64 encoded Identity certificate |
|
Base64 encoded Identity certificate string Example:
UExBQ0VIT0xERVI= |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Hosting FQDN |
|
Fully qualified domain name (FQDN) for Automation Suite. This must be either a subdomain or root domain of the
ID of Amazon Route 53-hosted zone parameter.
|
|
ID of Amazon Route 53-hosted zone |
|
Enter the ID of the Amazon Route 53-hosted zone or leave blank. For details, see Valid domain name. |
|
ARN of the ACM-hosted certificate |
|
ARN of the certificate present in the Amazon Certificate Manager (ACM) to use with the ALB. Leave empty to create the public certificate during deployment. |
|
Use internal load balancer |
|
Choose if you want to use an internal load balancer. |
|
Parameter label (name) |
Default value |
Description |
|---|---|---|
|
Engine of SQL Server deployed on Amazon RDS |
|
Choose the Amazon Relational Database Service (Amazon RDS) SQL engine |
|
Version of SQL Server deployed on Amazon RDS |
|
Choose the Amazon RDS SQL version. |
|
AWS KMS Key Id used to encrypt Amazon RDS storage |
|
KMS Key ID to use for the encryption of the Amazon RDS storage. Leave empty to skip encrypting the Amazon RDS storage. |
- Table 1. Network choice
- Table 2. Network configuration
- Table 3. Availability Zone configuration
- Table 4. Common networking configuration
- Table 5. Automation Suite node configuration
- Table 6. Automation Suite instance configuration
- Table 7. Automation Suite deployment configuration
- Table 8: Automation Suite external registry configuration
- Table 9. Automation Suite service configuration
- Table 10. Automation Suite external Orchestrator configuration
- Table 11. DNS or SSL configuration
- Table 12. Amazon RDS configuration
