- 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 kernel and OS level settings
- Step 8: Configuring the disks
- 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
- 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
- Migrating to an external OCI-compliant registry
- Executing the upgrade
- Performing post-upgrade operations
- 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 disable NIC 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
- 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
- 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
- Upgrade fails in offline environments
- 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
- Running the diagnostics tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
Step 1: Preparing the AWS deployment
This page lists the steps you need to take before deploying Automation Suite to 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 Quick Start 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:
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.
The following sections walk you through the steps you need to take to configure your AWS Account specific to the Automation Suite deployment requirements.
You need at least one EC2 key pair in the AWS account in the Region where you will deploy the Quick Start.
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.
This Quick Start 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.
WaitConditionHandle
resource in the routing stack. The Physical Id
of this resource is an URL. Execute a POST
request as described here.
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 this Quick Start 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 |
In order for the Quick Start 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.
Unrecognized resource type
error, then Quick Start is not supported in that Region.
Before launching the Quick Start, 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.
Connect AiCenter to an external Orchestrator
to true
and provide certificates for Orchestrator and Identity to the parameters listed in AWS 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.
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.
If you deploy Automation Suite in AWS GovCloud regions, FIPS 140-2 is enabled by default.
If you are not on AWS GovCloud, 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.
To deploy Automation Suite to AWS GovCloud, you must meet the following requirements:
-
You must only use an existing VPC.
-
You must create a Route53 resource for your custom domain and associate it with the existing VPC to which you plan to deploy. You must provide the Route53 ID as a value for the
ID of Route 53 hosted zone
parameter. -
If you use an ALB load balancer, you must import your certificate in Certificate Manager and provide the certificate ARN as a value for the
ARN of the ACM hosted certificate to use
parameter before installation.