automation-suite
2.2510
true
Automation Suite on Linux installation guide
- Overview
- Requirements
- Deployment templates
- Manual: Preparing the installation
- Manual: Preparing the installation
- Step 2: Configuring the OCI-compliant registry for offline installations
- Step 3: Configuring the external objectstore
- Step 4: Configuring High Availability Add-on
- Step 5: Configuring SQL databases
- Step 7: Configuring the DNS
- Step 8: Configuring the disks
- Step 9: Configuring kernel and OS level settings
- Step 10: Configuring the node ports
- Step 11: 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
- Kerberos authentication 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
- Adding a dedicated agent node with GPU support
- 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
- Running uipathctl
- Manual: Performing the installation
- Post-installation
- Cluster administration
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating Redis from in-cluster to external High Availability Add-on
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Migrating from in-cluster registry 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 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
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library installation
- Best practices and maintenance
- Troubleshooting
- How to troubleshoot services during installation
- How to reduce permissions for an NFS backup directory
- 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 collect DU usage data with in-cluster objectstore (Ceph)
- How to install RKE2 SELinux on air-gapped environments
- How to clean up old differential backups on an NFS server
- How to deploy Insights in a FIPS-enabled cluster
- How to migrate to cgroup v2
- How to recover Kerberos authentication after a VM restart
- How to push a local Docker image to the in-cluster registry
- How to exclude buckets from backup
- Error in downloading the bundle
- Offline installation fails because of missing binary
- Certificate issue in offline installation
- SQL connection string validation error
- Azure disk not marked as SSD
- Failure after certificate update
- TLS certificate validation errors
- Antivirus causes installation issues
- Automation Suite not working after OS upgrade
- Automation Suite requires backlog_wait_time to be set to 0
- Temporary registry installation fails on RHEL 8.9
- Frequent restart issue in uipath namespace deployments during offline installations
- DNS settings not honored by CoreDNS
- In-cluster registry seeding fails due to insufficient memory
- Prerequisite checks fail when Document Understanding modern projects is enabled and AI Center is disabled
- Upgrade fails due to unhealthy Ceph
- RKE2 not getting started due to space issue
- Upgrade fails due to classic objects in the Orchestrator database
- Ceph cluster found in a degraded state after side-by-side upgrade
- Service upgrade fails for Apps
- In-place upgrade timeouts
- Upgrade fails in offline environments
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- Upgrade fails due to overridden Insights PVC sizes
- Upgrade failure due to uppercase hostname
- 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
- ArgoCD repo-server pod in CrashLoopBackOff
- Manual ArgoCD NetworkPolicy mitigation (GHSA-47m3-95c7-g2g8)
- Missing Ceph-rook metrics from monitoring dashboards
- Mismatch in reported errors during diagnostic health checks
- Configuring resource requests and limits for uipathctl-created workloads
- No healthy upstream issue
- Redis startup blocked by antivirus
- AI Center and Document Understanding pods fail to start with TLS certificate verification enabled
- Fluentd does not export logs in IPv6 environments
- Studio Desktop cannot load Integration Service connectors and activities
- Running High Availability with Process Mining
- Process Mining ingestion failed when logged in using Kerberos
- 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
Health endpoints available for monitoring the operational status of Automation Suite services.
To effectively monitor the health of your Automation Suite services, you can use the health endpoints listed in this section. These endpoints allow you to quickly verify if a service is operating correctly.
Platform
https://<automation-suite-fqdn>/pap_/healthhttps://<automation-suite-fqdn>/pdp_/healthhttps://<automation-suite-fqdn>/identity_/.well-known/openid-configurationhttps://<automation-suite-fqdn>/identity_/web/https://<automation-suite-fqdn>/lease_/health/https://<automation-suite-fqdn>/license_/healthhttps://<automation-suite-fqdn>/organization_/healthhttps://<automation-suite-fqdn>/portal_/portal/shallow/healthStatushttps://<automation-suite-fqdn>/audit_/healthhttps://<automation-suite-fqdn>/resourcecatalog_/health
Action Center
https://<automation-suite-fqdn>/actions_/https://<automation-suite-fqdn>/bupproxyservice_/health/readyhttps://<automation-suite-fqdn>/processes_/
AI Center
https://<automation-suite-fqdn>/aifabric_/ai-apphttps://<automation-suite-fqdn>/aifabric_/ai-deployer/actuator/health/readyhttps://<automation-suite-fqdn>/aifabric_/ai-trainer/actuator/health/readyhttps://<automation-suite-fqdn>/aifabric_/ai-pkgmanager/actuator/health/readyhttps://<automation-suite-fqdn>/aifabric_/ai-helper/actuator/health/readyhttps://<automation-suite-fqdn>/aistorage_/health
Apps
https://<automation-suite-fqdn>/<org-name>/apps_/default/api/v1/default/system-health
Automation Hub
https://<automation-suite-fqdn>/automationhub_/fd-api/v1/pinghttps://<automation-suite-fqdn>/automationstore_/fd-api/v1/ping
Data Service
https://<automation-suite-fqdn>/dataservice_/api/HealthCheck/healthhttps://<automation-suite-fqdn>/dataservice_/assets
Document Understanding
https://<automation-suite-fqdn>/du_/api/documentmanager/healthhttps://<automation-suite-fqdn>/du_/api/storage/healthhttps://<automation-suite-fqdn>/du_/api/eventservice/healthhttps://<automation-suite-fqdn>/du_/metering/alivehttps://<automation-suite-fqdn>/du_/ocr/info/readyhttps://<automation-suite-fqdn>/du_/extended-ocr/readyhttps://<automation-suite-fqdn>/du_/classify/MLclassification/info/readyhttps://<automation-suite-fqdn>/du_/svc/formextractor/infohttps://<automation-suite-fqdn>/du_/svc/intelligentkeywords/info
Insights
https://<automation-suite-fqdn>/insights_/health
Integration Services
https://<automation-suite-fqdn>/connections_/schedulerstatushttps://<automation-suite-fqdn>/connections_/dispatcherstatushttps://<automation-suite-fqdn>/elements_/v1/elements/healthhttps://<automation-suite-fqdn>/elements_/elements/api-v2/tickle
Notification Service
https://<automation-suite-fqdn>/notificationservice_/notificationserviceapi/health/readinesshttps://<automation-suite-fqdn>/notificationservice_/usersubscriptionservice/health/readinesshttps://<automation-suite-fqdn>/notificationservice_/publishermetaservice/health/readiness
Orchestrator
https://<automation-suite-fqdn>/orchestrator_/api/health
Robotube
https://<automation-suite-fqdn>/robotube_/healthz
Test Manager
https://<automation-suite-fqdn>/testmanager_/api/health/live
Checking service health
To check the health of a specific service, send a request to its corresponding endpoint, as shown in the following example.
curl -kiso /dev/null -w "%{http_code}" https://<automation-suite-fqdn>/orchestrator_/api/health
curl -kiso /dev/null -w "%{http_code}" https://<automation-suite-fqdn>/orchestrator_/api/health
A successful response with an HTTP status code 200 indicates that the service is healthy.