- Overview
- Requirements
- 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 SQL databases
- 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
- 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
- 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
- Scaling a single-node (evaluation) deployment to a multi-node (HA) deployment
- Monitoring and alerting
- Migration and upgrade
- Migrating standalone products to Automation Suite
- Step 1: Restoring the standalone product database
- Step 2: Updating the schema of the restored product database
- Step 3: Moving the Identity organization data from standalone to Automation Suite
- Step 4: Backing up the platform database in Automation Suite
- Step 5: Merging organizations in Automation Suite
- Step 6: Updating the migrated product connection strings
- Step 7: Migrating standalone Orchestrator
- Step 8: Migrating standalone Insights
- Step 9: Deleting the default tenant
- Performing a single tenant migration
- 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 work with certificates
- How to schedule Ceph backup and restore data
- How to clean up unused Docker images from registry pods
- 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
- Temporary registry installation fails on RHEL 8.9
- 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
- Upgrade fails due to overridden Insights PVC sizes
- Failure to upgrade to Automation Suite 2024.10.1
- Upgrade fails due to Velero migration issue
- 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
- Robot cannot connect to an Automation Suite Orchestrator instance
- 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
- Mismatch in reported errors during diagnostic health checks
- No healthy upstream issue
- 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
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
- Exploring summarized telemetry
Automation Suite on Linux installation guide
Using the Automation Suite support bundle
The Automation Suite support bundle collects application-level logs of UiPath® services and and relevant objects required to evaluate and fix the problem. The Automation Suite support bundle also contains historical logs you can use to analyze patterns when troubleshooting a problem. Historic logs are particularly helpful when the potential root cause of an issue is not evident just by looking at the state of the cluster.
The Automation Suite support bundle is also needed when asking for guidance or a fix from the UiPath® Support team as they need it for analysis purposes.
The Automation Suite support bundle does not collect or store any PII or confidential data of you, your user, or your automation. UiPath® applications not not leak or log any confidential information in their records. At the platform level, the log collector is designed to mask any such critical information.
- High-level summarized usage telemetry is also exported with this tool generating an XML file. This telemetry includes:
- Robot execution duration per month by robot type.
- Robot concurrency - the maximum number of robots that executed at the same time.
- Metrics on jobs run, processes run, queue items, job failure rate, and users.
- Environment information.
- You can upload the XML file in the Customer Portal to share your high-level self-hosted usage telemetry with the UiPath Support team.
-
You can opt out of generating this summarized telemetry by listing service-metrics in the excluded list in Automation Suite 2024.10 and higher.
To generate the support bundle, run the following command from the installer directory:
./bin/uipathctl health bundle cluster_config.json --versions versions/helm-charts.json./bin/uipathctl health bundle cluster_config.json --versions versions/helm-charts.jsonThis tool requires some time to gather and store all the logs in a temporary location on your local or management machine.
The following table lists the optional flags that you can use for the support bundle tool:
|
Flags |
Description |
|---|---|
|
|
Specify the directory to store the support bundle. |
|
|
Specify the namespace where UiPath Automation Suite is deployed. |
|
|
Specify additional components (comma separated) to include in the bundle (such as
--include=historical-logs).
|
|
|
Specify components (comma separated) to exclude from the bundle (such as
--exclude=rke2-bundle or --exclude=service-metrics).
|
|
|
The start date to collect the historical logs in YYYY-MM-DD format. |
|
|
The number of days from the start date for which to collect the historical logs. |
|
|
Limits the size of the logs of running pods by providing the integer value in bytes. |
--from flag is not specified, then the historical logs will be collected for the past 2 days starting from today, irrespective of
the --days specified. If the --from is specified and --days is not specified, then the historical logs will be collected for 2 days starting from the specified start date.
flag --exclude=rke2-bundle.
--include=historical-logs.
.tar.gz archive contains following files and folders:
|
File/folder |
Description |
|---|---|
|
|
Contains the historical logs collected from ceph or external object store. |
|
|
Contains the live logs (such as logs for current and previous instance of pods). |
|
|
Contains the event descriptions from all the namespaces. |
|
|
Contains the active prometheus alerts in the cluster. |
|
|
Contains the RKE2 bundle for every node in the cluster. |
|
|
Contains the object descriptions for the server-preferred/custom namespace and cluster-scoped resources. |
service-metrics | Contains high level usage telemetry stored in individual XML files. |
The RKE2 bundle structure is as follows:
|
Directory |
Description |
|---|---|
|
|
Contains the logs related to system events, security audits, and general system messages. |
|
|
Contains the information about the running processes, disk usage, cpu utilisation and so on. |
|
|
Contains the information related to the data storage of the
etcd key-value store.
|
|
|
Contains the logs managed by
systemd-journald.
|
|
|
Contains the network configuration details such as iptables, routing and so on. |
|
|
Contains the kubelet logs, agent and server certificates, info on crictl and the resources running on the cluster and the pod logs. |
service-metrics | Contains high level usage telemetry stored in individual XML files. |
