- 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
Step 3: Post-deployment steps
This page provides instructions on the operations you can perform after deploying Automation Suite to AWS.
- Under CloudFormation > Stacks, you can find all of your deployments.
- Click on the stack you deployed, a status of CREATE_COMPLETE indicates the deployment has completed successfully.
The installation process generates self-signed certificates on your behalf. By default, these certificates are compliant with FIPS 140-2 and expire after 1825 days, but you can choose any of the following expiry periods at the time of deployment: 90, 365, 730, 1825, or 3650 days.
You must replace the self-signed certificates with certificates signed by a trusted Certificate Authority (CA) as soon as the installation completes. If you do not update the certificates, the installation will stop working after the certificate expiry date.
If you installed Automation Suite on a FIPS 140-2-enabled host and want to update the certificates, make sure they are compatible with FIPS 140-2.
For instructions, see Managing certificates.
After completing an Automation Suite installation using the AWS deployment template, you can enable FIPS 140-2 on your machines. For instructions, see Security and compliance.
/root/installer
directory.
The Cluster Administration portal is a centralized location where you can find all the resources required to complete an Automation Suite installation and perform common post-installation operations. For details, see Getting started with the Cluster Administration portal.
To access the Cluster Administration portal, take the following step:
https://${CONFIG_CLUSTER_FQDN}/uipath-management
.The general-use Automation Suite user interface serves as a portal for both organization administrators and organization users. It is a common organization-level resource from where everyone can access all Automation Suite areas: administration pages, platform-level pages, service-specific pages, and user-specific pages.
To access Automation Suite, take the following steps:
- Go to the following URL:
https://{CONFIG_CLUSTER_FQDN}
. - Switch to the Default organization.
- The username is orgadmin.
- Retrieve the password by clicking the secrets link provided in the output table for AutomationSuiteSecret. Go to Retrieve Secret Value for the credentials.
The host portal is where system administrators configure the Automation Suite instance. The settings configured from this portal are inherited by all your organizations, and some can be overwritten at the organization level.
To access host administration, take the following steps:
- Go to the following URL:
https://{CONFIG_CLUSTER_FQDN}
. - Switch to the Host organization.
- The username is admin.
- Retrieve the password by clicking the secrets link provided in the output table for HostAdministrationSecret. Go to Retrieve Secret Value for the credentials.
You can use the ArgoCD console to manage installed products.
To access ArgoCD, take the following steps:
- Go to the following URL:
https://alm.${CONFIG_CLUSTER_FQDN}
. - The username is admin if you want to use the ArgoCD admin account, or argocdro if you want to use the ArgoCD read-only account.
- Retrieve the password by clicking to the secrets link provided in the output table for ArgoCdSecret. Go to Retrieve Secret Value for the credentials.
To access the monitoring tools for the first time, log in as an admin with the following default credentials:
- Username: admin
- Password: to retrieve the password , run the
following
command:
kubectl get secrets/dex-static-credential -n uipath-auth -o "jsonpath={.data['password']}" | base64 -d
kubectl get secrets/dex-static-credential -n uipath-auth -o "jsonpath={.data['password']}" | base64 -d
To update the default password used for accessing the monitoring tools, take the following steps:
-
Run the following command by replacing
newpassword
with your new password:password="newpassword" password=$(echo -n $password | base64) kubectl patch secret dex-static-credential -n uipath-auth --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]"
password="newpassword" password=$(echo -n $password | base64) kubectl patch secret dex-static-credential -n uipath-auth --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]" -
Run the following command by replacing
<cluster_config.json>
with the path to your configuration file:/opt/UiPathAutomationSuite/UiPath_Installer/install-uipath.sh -i <cluster_config.json> -f -o output.json --accept-license-agreement
/opt/UiPathAutomationSuite/UiPath_Installer/install-uipath.sh -i <cluster_config.json> -f -o output.json --accept-license-agreement
The templates provide automations for cluster operations leveraging Systems Manager documents.
Description
The SSM document creates a new Launch Template version for the server and agent Automatic Scaling Groups with an updated AMI ID.
Usage
The document exposes 2 parameters:
ImageName
(e.g.:RHEL-8.6*_HVM-20*
) – If theImageName
parameter is provided and AMI that matches theImageName
will be set on the Automatic Scaling Groups;AmiId
(e.g.:ami-032e5b6af8a711f30
) – If provided, theAmiId
takes precedence overImageName
and is set on the Automatic Scaling Groups.
ImageName
stored in Parameter Store is used as default value.
Description
The SSM document registers AI Center to the external Orchestrator provided at deployment time.
Usage
IdentityToken
, which is an installation access token generated by the external Identity service. Since the token has a short availability
(approximately 1-2 hours), we recommend generating it just before running the SSM document. For instructions, see Installation key.
Description
Creates a snapshot of the Automation Suite cluster. Does not perform a backup on the SQL server.
Usage
This SSM document does not require any parameters.
Execution logs
captureOnDemandBackup
step.
Description
Lists all snapshot available in the Automation Suite cluster.
Usage
This SSM document does not require any parameters.
Execution logs
getSnapshotList
step.
After performing an Automation Suite cluster upgrade, AWS template deployments require some changes to ensure a new node joins the cluster correctly. To automate the changes, we recommend using the dedicated script. For instructions, see the AWS deployment template docs.
- Validating the installation
- Updating certificates
- Enabling FIPS 140-2
- Accessing the installer package
- Accessing the deployment outputs
- Accessing the Cluster Administration portal
- Accessing the Automation Suite portal
- Accessing host administration
- Accessing ArgoCD
- Accessing the monitoring tools
- Accessing cluster VMs
- Performing cluster operations
- Using Systems Manager documents
- UpdateAMIDocument
- RegisterAiCenter
- OnDemandBackup
- GetAllBackups
- OnDemandRestore
- Completing an upgrade