- Overview
- Requirements
- Installation
- Post-installation
- Cluster administration
- Monitoring and alerting
- Migration and upgrade
- 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 Disable TLS 1.0 and 1.1
- 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 debug failed Automation Suite installations
- How to disable NIC checksum offloading
- 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
- Failure After Certificate Update
- Automation Suite Requires Backlog_wait_time to Be Set 1
- Cannot Log in After Migration
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- 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 With Error: An Invalid Status Code Was Supplied (Client's Credentials Have Been Revoked).
- Login Failed for User <ADDOMAIN><aduser>. Reason: The Account Is Disabled.
- Alarm Received for Failed Kerberos-tgt-update Job
- SSPI Provider: Server Not Found in Kerberos Database
- 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
- Unexpected Inconsistency; Run Fsck Manually
- Missing Self-heal-operator and Sf-k8-utils Repo
- Degraded MongoDB or Business Applications After Cluster Restore
- Unhealthy Services After Cluster Restore or Rollback
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
Network Requirements
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 (services), components, and integrations in an online deployment.
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.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:
- 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.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.
/etc/sysctl.d/ folder, using the following command:
cat <<EOF >>"/etc/sysctl.d/99-sysctl.conf"
net.bridge.bridge-nf-call-iptables = 1
net.ipv4.ip_forward = 1
net.bridge.bridge-nf-call-ip6tables = 1
EOFcat <<EOF >>"/etc/sysctl.d/99-sysctl.conf"
net.bridge.bridge-nf-call-iptables = 1
net.ipv4.ip_forward = 1
net.bridge.bridge-nf-call-ip6tables = 1
EOF- The previous command is an OS level setting, and it is recommended to be used only by Linux admins. Ensure the changes you make are according to the control process of your environment.
- The
nf-call-iptablesis needed for most Kubernetes deployments. Kubernetes creates virtual networks internal to the cluster. This allows every pod to have its own IP address, which is used in conjunction with the internal name services to facilitate service-to-service communication. The cluster does not work withoutnf-call-iptablesenabled. For details, see the official Kubernetes documentation.
