automation-suite
2023.10
false
- 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
- 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
- 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
- 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
- Executing the upgrade
- Performing post-upgrade operations
- Product-specific configuration
- Using the Orchestrator Configurator Tool
- Configuring Orchestrator parameters
- Orchestrator appSettings
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- 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 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
- 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
- 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
- Support bundle log collection failure
- Test Automation SQL connection string is ignored
- Single-node upgrade fails at the fabric stage
- 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 or later
- Upgrade fails in offline environments
- SQL validation fails during upgrade
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- Longhorn REST API endpoint upgrade/reinstall error
- 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
- Pods cannot communicate with FQDN in a proxy environment
- 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 and Task 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
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
Automation Suite on Linux Installation Guide
Last updated Nov 21, 2024
Network requirements
Automation Suite does not support the IPv6 internet protocol.
We do not support firewalld. The Automation Suite installer automatically disables firewalld during installation; make sure it remains in a disabled state post-installation as well.
Automation Suite sets up default IP table rules on the host machines for necessary inter-node communication. We do not support custom IP table rules, such as those configured via firewalld, as they might conflict with IP table rules configured by Automation Suite. You can, however, apply extra firewall rules at the network level.
We recommend enabling firewall applications at the network gateway, but not between clusters.
This page lists the domains used by the various UiPath® products, components, and integrations in an online deployment. You must allow traffic to and from these domains, otherwise Automation Suite may malfunction.
Add to your allow list those endpoints and ports for the UiPath® products and services you use. For example, if you do not have AI Center, there is no need to add its required domains to your allow list.
To ensure cluster stability, your environment must meet the following requirements:
- Round Trip Time (RTT) between the nodes must be minimal (<10 ms RTT);
- High Availability requirements must be met.
- For downloading the required installer files and configuration scripts:
https://download.uipath.com- downloads the installer script - For downloading container images and metadata:
https://registry-data.uipath.comhttps://registry.uipath.comThe above URLs are required during installation, for adding new nodes to an existing cluster, for upgrading to a newer version, and for application sync using ArogCD. These URLs may also be needed during runtime so that Kubernetes can pull the image.
- For using supportability tools, such as the support bundle generation and diagnostic tools:
https://sfbrprddeploywe.azurecr.iohttps://sfbrprddeploywe.westeurope.data.azurecr.io
- For the installation of Kubernetes or RKE2:
https://rpm.rancher.io - For sending business telemetry to UiPath®:
https://dc.services.visualstudio.comThe above is only required if you opt in to send telemetry data to UiPath®.
Automation Suite portal
- For the Azure Active Directory integration:
https://login.microsoftonline.com/* - (Optional) For application insights:
https://dc.services.visualstudio.com/*
Identity
- For the Azure Active Directory integration:
https://login.microsoftonline.com/*https://graph.microsoft.com/*
- For the SQL connection: the connection you use, possibly through a pipeline
- For the Redis connection: the port number and password that are generated during Redis deployment
- For the Active Directory integration:
- Kerberos: port
88 - LDAP endpoints: port
389 - DNS for DC discovery:
port
53
- Kerberos: port
- For SAML authentication: SAML endpoints, as configured for Automation Suite
- For system email notifications: SMTP server and port, as configured for Automation Suite
- For certificate validation on connection, if CRLs need to be downloaded: the endpoint determined by the certificate
Webhooks
- For the SQL connection: the connection you use, possibly through a pipeline
- HTTP(S) Webhook endpoints, as defined by users in the Orchestrator Webhook definition
Organization management
- For the SQL connection: the connection you use, possibly through a pipeline
- For the Ceph integration: the connection is generated during infrastructure setup
Audit
- For the SQL connection: the connection you use, possibly through a pipeline
Licensing
- For online license activation, update, and other online license operations:
https://activate.uipath.com/ - For the SQL connection: the connection you use, possibly through a pipeline
- For the Redis connection: the port number and password that are generated during Redis deployment
- For the SQL connection: the connection you use, possibly through a pipeline
- HTTP(S) calls via the Webhook connector
- HTTP(S) calls to Xray for Jira (on-premises or cloud), to ServiceNow, and to AzureDevOps
- For the SQL connection: the connection you use, possibly through a pipeline
- The OOB models and metadata are fetched from our GitHub repository, and the models themselves are downloaded from our storage
account. The following URLs cannot be blocked as the OOB scheduler continues to run, and the last three URLs as they are needed
at runtime. Therefore, make sure that you have access to the following:
- The following are needed in order for the OOB metadata to fetch new models being added:
https://github.comhttps://raw.githubusercontent.comhttps://api.github.com
https://uipath.blob.core.windows.netis needed to clone the new models downloaded- The following are needed at runtime for skill deployment and training pipeline for downloading dependencies:
- The Python Package Index:
http://pypi.python.org/andhttp://pypi.org/ - Any Python PIP hosted public domains, based on your model package and required Python libraries in
requirements.txt
- The Python Package Index:
- The following are needed in order for the OOB metadata to fetch new models being added:
https://du-metering.uipath.comNote:This URL is needed only when AI Center is connected to an external Orchestrator.
https://du.uipath.com
- For the SQL connection: the connection you use, possibly through a pipeline
- For OCR:
- The UiPathDocumentOCR endpoint applicable for your region
- Microsoft OCR (optional): The endpoint applicable for your region
- Google OCR (optional):
https://vision.googleapis.com/v1/images:annotate
- For data extraction: the FormExtractor endpoint applicable for your region
https://du-metering.uipath.comNote:This URL is needed only when AI Center is connected to an external Orchestrator.
https://du.uipath.com
- To download desktop clients:
https://download.uipath.com/TaskMining/sf/task-mining-setup.exe(EXE) andhttps://download.uipath.com/TaskMining/sf/task-mining-setup.msi(MSI) - For the SQL connection: the connection you use, possibly through a pipeline
- For system email notifications: SMTP server and port, as configured for Automation Suite
- For the Redis connection: the port number and password that are generated during Redis deployment
- For the Ceph integration: the connection is generated during infrastructure setup
- For the RabbitMQ connection: the connection is generated during infrastructure setup
https://activate.uipath.comsmtp.sendgrid.net(or whichever SMTP server is configured)- Any port-level blocks need to be accounted for.
- Any TLS or SSL certificates associated with the SMTP server should be verifiable without the need for a CRL fetch outside your offline environment.
https://dc.services.visualstudio.com/v2/track
If you use Azure infrastructure, you must allow the RHEL yum mirrors for Azure listed in this section.
These URLs are strictly applicable for Azure. If you use a different cloud services provider (CSP), the URLs are different.
http://rhui-1.microsoft.comhttp://rhui-2.microsoft.comhttp://rhui-3.microsoft.com- For the Azure Active Directory integration:
https://login.microsoftonline.com/*https://graph.microsoft.com/*
For your users to be able to access the official UiPath® documentation for Automation Suite and the bundled products, you must also allow documentation-specific URLs. For the full list, see UiPath® Documentation Website URLs.
