automation-suite
2024.10
true
- 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
- Cluster_config.json Sample
- General configuration
- Profile configuration
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- ArgoCD 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 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
- Manual: Installing Automation Suite
- Disaster recovery - Installing the secondary cluster
- 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
- 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 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 schedule Ceph backup and restore data
- 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
- 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
- Data loss when reinstalling or upgrading Insights following Automation Suite upgrade
- Unable to access Automation Hub following upgrade to Automation Suite 2024.10.0
- Single-node upgrade fails at the fabric stage
- 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
- 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
- Partial failure to restore backup in Automation Suite 2024.10.0
- 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
- Pods stuck in Init:0/X
- Missing Ceph-rook metrics from monitoring dashboards
- 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
- 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
- Task Mining troubleshooting
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
Automation Suite on Linux Installation Guide
Last updated Jan 27, 2025
Manual: Installing Automation Suite
The following table lists the steps you must perform for Automation Suite installation:
|
Steps |
Single-node installation |
Multi-node installation |
Lite mode |
|---|---|---|---|
|
Step 1: Accepting the license agreement |
|
|
|
|
Step 2: Installing the Infrastructure on the first server machine |
|
|
|
| Step 3: Installing the infrastructure on the other server machines |
|
|
|
| Step 4: Installing the infrastructure on all the agent machines |
|
|
|
| Step 5: Hydrating the in-cluster registry for offline installations |
|
|
|
| Step 6: Completing the installation |
|
|
|
Before running the installation, make sure to read the license agreement.
To accept the license agreement, choose one of the following methods:
- Option 1 (Environment variable) - Set the
LICENSE_AGREEMENTenvironment variable toacceptby running the following command:export LICENSE_AGREEMENT=acceptexport LICENSE_AGREEMENT=accept
- Option 2 (Inline parameter) - Append
--accept-license-agreementto every execution ofuipathctl.
To install the infrastructure on the first server machine, navigate to the installer folder and run the following command:
cd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k --accept-license-agreementcd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k --accept-license-agreementNote:
-
The
-kparameter installs the infrastructure on the first server machine. -
Once the infrastructure is installed, the server machine becomes a node in the Automation Suite cluster.
To expand the Automation Suite cluster, install the infrastructure on the additional server machines.
To do that, run the following command on all the additional server machines:
cd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j server --accept-license-agreementcd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j server --accept-license-agreementNote: The
-j server parameter adds the machines as server nodes to the existing Automation Suite cluster. The fixed_rke_address flag in the cluster_config.json file connects the exiting Automation Suite cluster.
If you have additional agent machines, you must install the infrastructure on those machines and add them as agent nodes to the Automation Suite cluster.
To to that, run the following command on all the agents machines:
cd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j agent --accept-license-agreementcd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 install -i /opt/UiPathAutomationSuite/cluster_config.json -o ./output.json -k -j agent --accept-license-agreementNote:
The
-j server parameter adds the machines as server nodes to the existing Automation Suite cluster. The fixed_rke_address flag in the cluster_config.json file connects the exiting Automation Suite cluster.
This step is required only if you use in-cluster registry for offline installations.
To seed the in-cluster registry from the temporary registry, run the following command:
cd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/cluster_config.jsoncd /opt/UiPathAutomationSuite/<version>/installer
./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/cluster_config.jsonAt this point, all the nodes should be interconnected to establish the infrastructure for installing Automation Suite.
To complete the installation, take the following steps:
-
Verify if all nodes are available on the first server node, by running the following command:
The output of the aforementioned command should look similar to the one shown in the following image. Note that the total number of nodes must match the sum of server and agent nodes.export KUBECONFIG=/etc/rancher/rke2/rke2.yaml export PATH=$PATH:/var/lib/rancher/rke2/bin kubectl get nodesexport KUBECONFIG=/etc/rancher/rke2/rke2.yaml export PATH=$PATH:/var/lib/rancher/rke2/bin kubectl get nodes -
Create the prerequisites required for the shared components installation, by running the following command:
These are primarily object storage buckets and SQL databases. The SQL databases required for the installation are created on the SQL server if the./bin/uipathctl prereq create cluster_config.json --versions versions/helm-charts.json./bin/uipathctl prereq create cluster_config.json --versions versions/helm-charts.jsonsql.create_db keyis set in the config file. The object storage buckets are created in the cloud provider if theobject_storage.create_bucketkey is set in the config file. -
Validate the prerequisites required by the shared components installation, by running the following command:
./bin/uipathctl prereq run cluster_config.json --versions versions/helm-charts.json./bin/uipathctl prereq run cluster_config.json --versions versions/helm-charts.json -
After verifying the infrastructure, install the shared components and the services by running the following command:
./bin/uipathctl manifest apply /opt/UiPathAutomationSuite/cluster_config.json --versions ./versions/helm-charts.json./bin/uipathctl manifest apply /opt/UiPathAutomationSuite/cluster_config.json --versions ./versions/helm-charts.json
- Step 1: Accepting the license agreement
- Step 2: Installing the infrastructure on the first server machine
- Step 3: Installing the infrastructure on the other server machines
- Step 4: Installing the infrastructure on all the agent machines
- Step 5: Hydrating the in-cluster registry for offline installations
- Step 6: Completing the installation
