- Overview
- Requirements
- Installation
- Post-installation
- Cluster administration
- Managing products
- Managing the cluster in ArgoCD
- Setting up the external NFS server
- Automated: Enabling the Backup on the Cluster
- Automated: Disabling the Backup on the Cluster
- Automated, Online: Restoring the Cluster
- Automated, Offline: Restoring the Cluster
- Manual: Enabling the Backup on the Cluster
- Manual: Disabling the Backup on the Cluster
- Manual, Online: Restoring the Cluster
- Manual, Offline: Restoring the Cluster
- Additional configuration
- Migrating objectstore from persistent volume to raw disks
- Monitoring and alerting
- Migration and upgrade
- Migration options
- 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 Insights
- Step 7: Deleting the default tenant
- B) Single tenant migration
- 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 automatically clean up Longhorn snapshots
- How to disable TX checksum offloading
- 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
- Automation Suite not working after OS upgrade
- Automation Suite Requires Backlog_wait_time to Be Set 1
- Volume unable to mount due to not being ready for workloads
- RKE2 fails during installation and upgrade
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- Failure to Resize Objectstore PVC
- Rook Ceph or Looker pod stuck in Init state
- StatefulSet volume attachment error
- Failure to create persistent volumes
- Storage reclamation patch
- Backup failed due to TooManySnapshots error
- All Longhorn replicas are faulted
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- Cannot Log in 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 With Error: An Invalid Status Code Was Supplied (Client's Credentials Have Been Revoked).
- Alarm Received for Failed Kerberos-tgt-update Job
- SSPI Provider: Server Not Found in Kerberos Database
- Login Failed for User <ADDOMAIN><aduser>. Reason: The Account Is Disabled.
- ArgoCD login failed
- 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
- After the Initial Install, ArgoCD App Went Into Progressing State
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unexpected Inconsistency; Run Fsck Manually
- Degraded MongoDB or Business Applications After Cluster Restore
- Missing Self-heal-operator and Sf-k8-utils Repo
- Unhealthy Services After Cluster Restore or Rollback
- RabbitMQ pod stuck in CrashLoopBackOff
- Prometheus in CrashloopBackoff state with out-of-memory (OOM) error
- Missing Ceph-rook metrics from monitoring dashboards
- Pods cannot communicate with FQDN in a proxy environment
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
Automated: Offline upgrade
Ansible is used to automate the upgrade of the entire Automation Suite cluster, by performing some operations on one machine in the cluster.
In the following illustration, the Server 1 node (or Ansible host node) uses Ansible to orchestrate the upgrade of entire Automation Suite cluster.
uipathctl.sh
script. For details, see Using uipathctl.sh.
/opt/UiPathAutomationSuite
folder on all the nodes. If you do not have enough space, you can either increase the capacity of this folder or remove all
the previous installer files except for cluster_config.json
. You can always download the previous installer again.
df -h /opt/UiPathAutomationSuite
.
To prepare for the upgrade, take the following steps:
If any errors or issues occur during or following the upgrade, you can rollback to the previous version, provided that you previously configured a backup.
For instructions, see Rollback on error.
To configure the backup, take the following steps:
Once the backup is created, continue with the following steps.
Putting the cluster in maintenance mode will shut down the ingress controller and all the UiPath services, blocking all the incoming traffic to the Automation Suite cluster.
To upgrade the Automation Suite cluster, take the following steps:
Basic parameters
Parameter |
Value |
---|---|
|
Possible values:
online and offline .
Since this page provides instructions for an offline environment, choose the
offline value.
|
|
Possible values are:
all , infra , fabric , and services .
Denotes each stage of the installation and upgrade process.
Important: You must upload and hydrate the Docker registry at the same time as upgrading Kubernetes and the infrastructure components.
To execute the two steps simultaneously, run
--steps bundles infra .
Do not run
--steps bundles alone as it will damage the cluster.
If an error occurs during the upgrade, you can use these checkpoints to resume the upgrade operation instead of retrying from start. |
|
Path to the
sf.tar.gz offline bundle, containing the fabric and services container images. It is recommended to store it in `/uipath/{version
|
|
Path to the
sf-infra.tar.gz offline bundle, containing Kubernetes and infrastructure bundles.
|
|
cluster_config.json file, which defines the parameters, settings, and preferences applied to the UiPath services deployed via Automation Suite.
|
Advanced parameters
Parameter |
Value |
---|---|
|
Specify the username to be used for SSH connections to all the nodes. Defaults to the current user. If you use a different
username for all the nodes, then instead of using this parameter, set the username for all the nodes in
inventory.ini and pass it to the script.
Example: While running the script, you are logged in as the
myadminuser username. However, if you want to use the testadmin username to connect via SSH, you must provide testadmin to this parameter.
|
|
Specify an existing Ansible inventory file. If not specified, one will be generated automatically from the existing cluster with the basic configuration. In certain scenarios where you want to have more granular control, you may want to provide your own inventory file. One such example would be if you want to use a different SSH username or SSH key for all the nodes in cluster. For details, see Generating the Ansible inventory.ini file. |
./uipathctl.sh upgrade --install-type offline --steps {fabric | services}
.
Once the upgrade is done, maintenance mode will be disabled automatically.
After performing the upgrade, you can take the following additional steps:
-
To verify if Automation Suite is healthy, run:
kubectl get applications -n argocd
kubectl get applications -n argocd -
If you experience issues with image vulnerabilities or storage consumption after performing an upgrade, delete the images from the old installer. For details, see the Troubleshooting section.
Before starting to upgrade the cluster, the upgrade script automatically creates a backup of the cluster and then temporarily disables it. You may want to enable the backup manually once the upgrade is done.
To enable the backup, run the following command from any server node:
# replace {version} with the version you are upgrading to
cd /opt/UiPathAutomationSuite/{version}/installer
./configureUiPathAS.sh resume-scheduled-backups
# replace {version} with the version you are upgrading to
cd /opt/UiPathAutomationSuite/{version}/installer
./configureUiPathAS.sh resume-scheduled-backups