- 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
- How to forward application logs to Splunk
- 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
- Data loss when reinstalling or upgrading Insights following Automation Suite upgrade
- 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
- 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
- Task Mining troubleshooting
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
Automation Suite on Linux Installation Guide
Upgrading Automation Suite
-
Automation Suite 2023.4.5 and 2023.10.2 include an upgrade to Kubernetes 1.26.11. As such, when upgrading Automation Suite, you must ensure you do not downgrade Kubernetes. To do that, when moving from Automation Suite 2023.4.5 or a later minor version to the next major version, you must upgrade to 2023.10.2 at a minimum.
-
For the available upgrade paths, see Automation Suite upgrade paths.
-
If you plan to upgrade from Automation Suite 2022.10 or earlier, and Process Mining is enabled, you must migrate process apps to the new process graph layout before starting the upgrade.
-
If you upgrade from an Automation Suite version installed a machine with FIPS 140-2 disabled, you can enable FIPS 140-2 by following the instructions on Security and compliance.
-
Make sure you meet the hardware and software requirements for the new Automation Suite version. If AI Center is enabled, make sure you meet the CUDA requirements.
-
Make sure you follow the Automation Suite upgrade best practices and perform the upgrade process that best suits your needs.
Automation Suite supports two upgrade processes:
-
In-place upgrade
-
Side-by-side upgrade
The Automation Suite in-place upgrade process allows you to move to a new Automation Suite version while keeping your settings and data intact on the same hardware.
-
In the in-place upgrade process, you first upgrade Kubernetes and other infrastructure components, and then upgrade the shared components and UiPath® product services.
-
In case of hard failure beyond recovery during the upgrade process, you need to roll back to the previous version using the backup and restore capability.
The Automation Suite side-by-side upgrade leverages an enterprise upgrade experience that is usually called blue-green and is a standard process across the industry.
-
The side-by-side upgrade allows you to perform an upgrade safely using a parallel environment instead of upgrading in place.
-
This method allows administrators to switch traffic from the old Automation Suite cluster (i.e., the blue deployment) to the new Automation Suite cluster (i.e., the green deployment) after verifying the new deployment. If you detect a problem, you can quickly roll back to the old deployment.
Capability |
Upgrade mechanism | |
---|---|---|
In-place upgrade |
Side-by-side upgrade | |
Upgrade to a new LTS version |
|
|
Upgrade from any supported version |
1 |
2 |
High-fidelity data migration |
|
3 |
No downtime during upgrade |
|
|
Instant rollback |
|
|
1 You can upgrade from any Automation Suite version, but an intermediate upgrade between your initial and targeted versions might be needed. For details, see In-place upgrade paths.
2 You can upgrade from any Automation Suite version, except for 2021.10. For details, see Side-by-side upgrade paths.
3 For details, see Data migration and responsibilities.
The following matrix shows the available in-place upgrade paths for Automation Suite versions:
- a direct in-place upgrade path between major versions is available;
- an intermediate in-place upgrade between your initial and targeted major versions is needed.
We strongly advise upgrading to the most recent minor version of Automation Suite. This allows you to take advantage of the latest enhancements and guarantees the seamless operation of all internal components.
Initial version |
Targeted version | ||||
---|---|---|---|---|---|
2022.4.x |
2022.10.x |
2023.4.x |
2023.10.x |
2024.10.x | |
2021.10.x |
|
|
|
|
|
2022.4.x |
|
|
|
Requires 2022.4.7 minimum with Ceph on raw devices, and completion of Cilium migration before initiating the upgrade.
|
Requires 2022.4.7 minimum with Ceph on raw devices, and completion of Cilium migration before initiating the upgrade.
|
2022.10.x |
N/A |
|
|
|
|
2023.4.x |
N/A |
N/A |
|
|
|
2023.10.x |
N/A |
N/A |
N/A |
|
|
2024.10.x | N/A | N/A | N/A | N/A |
|
-
In some cases, upgrading Automation Suite requires transitioning through an intermediate version or skiping some versions entirely to maintain the smooth functioning of the internal components. Not following the upgrade guidelines in the previous table may lead to an internal component downgrade or an unsuccessful internal component upgrade, thereby causing the Automation Suite upgrade to fail.
-
If you plan to upgrade from Automation Suite 2022.10 or earlier, and Process Mining is enabled, you must migrate process apps to the new process graph layout before starting the upgrade.
-
If you use Active Directory (AD) and are planning on upgrading to 2023.4.0, we highly recommend that you skip straight to the 2023.4.3 version, as 2023.4.0, 2023.4.1 and 2023.4.2 are impacted by an AD issue.
-
Only upgrades to Automation Suite 2023.10 and later leverage the simplified upgrade process.
The following matrix shows the available side-by-side upgrade paths for Automation Suite versions:
- a direct side-by-side upgrade path between versions is available;
- a side-by-side upgrade between your initial and targeted versions is not possible.
We strongly advise upgrading to the most recent minor version of Automation Suite. This allows you to take advantage of the latest enhancements and guarantees the seamless operation of all internal components.
Initial version |
Targeted version | ||||
---|---|---|---|---|---|
2021.10.x |
2022.4.x |
2022.10.x |
2023.4.x |
2023.10.x | |
2021.10.x |
|
|
|
|
|
2022.4.x |
N/A |
|
|
|
|
2022.10.x |
N/A |
N/A |
|
|
|
2023.4.x |
N/A |
N/A |
N/A |
|
|
2023.10.x |
N/A |
N/A |
N/A |
N/A |
|
If you can bring an additional environment to perform the upgrade, we recommend choosing the side-by-side upgrade path as it provides a safer upgrade approach and instant rollback.
If you cannot bring an additional environment to perform the upgrade, you can opt for the in-place upgrade. Make sure to follow the upgrade validation best practices.
We recommend preparing two similar Automation Suite environments, regardless of whether you want to use the in-place or side-by-side upgrade:
-
Automation Suite multi-node cluster for dev or QA
Note: The dev/QA environment does not need to be online all the time if not used for anything else than upgrade validation. -
Automation Suite multi-node cluster for production
It is strongly recommended to create a backup of the cluster and the SQL database before upgrading Automation Suite. This is to ensure you can restore the cluster if something goes wrong during the upgrade operation.
Cluster data is backed up on the NFS server. Make sure you have configured the NFS server before proceeding.
global.userInputs.identity.krb5KeytabSecret
to global.kerberosAuthConfig.userKeytab
if you simultaneously meet the following requirements:
-
You configured the Active Directory integration using username and password;
-
You have Windows authentication enabled;
-
You do not use SQL integrated authentication.
To validate the automations that you built, create separate organizations or tenants directly in your Automation Suite production environment, as it is the most cost-effective solution. For more best practices, see Orchestrator - Automation Best Practices.
To validate your automations in different environments and versions, leverage your second Automation Suite cluster after installing the new Automation Suite cluster but before switching the traffic to the new cluster in production.
- Requirements
- Upgrade process
- In-place upgrade process
- Side-by-side upgrade
- Upgrade mechanism and capabilities
- In-place upgrade paths
- Side-by-side upgrade paths
- Upgrade best practices
- Upgrade validation best practices
- Environments
- Backup
- Authentication
- Automation validation best practices
- Version validation
- Licensing