automation-suite
2024.10
true
- 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
- Cluster_config.json Sample
- General configuration
- Profile configuration
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- ArgoCD 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
- AI Center-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 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
- 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
- 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 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 schedule Ceph backup and restore data
- 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
- 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
- Data loss when reinstalling or upgrading Insights following Automation Suite upgrade
- Unable to access Automation Hub following upgrade to Automation Suite 2024.10.0
- Single-node upgrade fails at the fabric stage
- 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
- Upgrade fails due to overridden Insights PVC sizes
- 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
- Partial failure to restore backup in Automation Suite 2024.10.0
- 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
- Pods stuck in Init:0/X
- Missing Ceph-rook metrics from monitoring dashboards
- 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
- Automation Suite certificate is not trusted from the server where CData Sync is running
- Task Mining troubleshooting
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
Completing an upgrade

Automation Suite on Linux Installation Guide
Last updated Feb 3, 2025
Completing an upgrade
After performing an Automation Suite cluster upgrade, some changes are needed to ensure a
new node joins the cluster correctly through scale-out operations. To automate the
changes, we recommend using the
upgrade_wrapper.py
script.
Make sure you meet the following requirements:
- Python 3.8 or newer must be installed on the machine on which you execute the script. For details, see Python documentation.
- Python packages are required for the script. You can install these packages using the following pip command. For details,
see pip documentation.
pip install wget requests boto3
pip install wget requests boto3 boto3
clients must be able to authenticate to AWS because deployment changes occur through them. You can provide credentials as environment variables or through a default profile using a shared credential file. The user must have the permission to perform the actions described in the Script behavior section.-
Ensure your RHEL version for the Auto Scaling Group (Server, Agent, etc.) is updated and matches the version you are upgrading to.
- Make sure to review the
cluster_config.json
file and change any boolean values marked as string ("true"
/"false"
) to actual boolean values (true
/false
). For example:- to enable zone resilience, use
"zone_resilience": true
. - to allow the installer to create the databases, use
"sql.create_db": true
.
- to enable zone resilience, use
- If you upgrade from Automation Suite 2022.10 to Automation Suite 2023.4 or newer, and Orchestrator is enabled on both the
old and new versions, you must set the
orchestrator.block_classic_executions
flag totrue
in thecluster_config.json
file. Using the flag shows that you agree with blocking classic folders executions. Not using the flag causes the upgrade operation to fail. This parameter is not required in new installations. - If you upgrade to Automation Suite 2023.10 or later, and Insights is enabled on both the old and new environments, you must
set the
insights.external_object_storage.bucket_name
flag to the same bucket used forplatform
in thecluster_config.json
file. Not using the flag causes the upgrade operation to fail. This parameter is not required in new installations. - If you upgrade to Automation Suite 2023.10 or newer, make sure to fill in the following fields in the
cluster_config.json
ifsql.create_db
is set totrue
:sql.server_url = "<db_endpoint>" sql.port = "1433" sql.username = <SQL Username> sql.password = <SQL password>
sql.server_url = "<db_endpoint>" sql.port = "1433" sql.username = <SQL Username> sql.password = <SQL password>
When running the
upgrade_wrapper.py
script, take into consideration the fact that it performs the following operations:
- Downloads in the current folder the dependencies needed;
- Extracts information from the Automation Suite deployment stack;
-
Creates a new stack containing:
- A new Launch Template for each Auto Scaling Group present in the initial deployment with the changes needed for the new version installation flow;
-
An IAM policy attached to the IAM role used by the Automation Suite nodes that allows the
DescribeStackResource
operation on the current stack;Note: The policy is deployed only if a custom IAM role was not provided at deployment time. Otherwise you should grant thecloudformation:DescribeStackResource
permission on the newly deployed stack to the IAM role used by the Automation Suite nodes.
- Updates the Auto Scaling Group to use the Launch Templates created in the new stack;
- Updates the SSM parameter containing the installer URL (optional, depending on the initial deployment template version);
-
Overrides the old installer used in the initial deployment with the one used for upgrade on all nodes through an SSM Run Command. This is needed to preserve the functionality of the SSM documents already existent in the initial deployment;
Note: The AMI update SSM document might no longer work after the Launch template update. The IAM role used by the SSM documents should be updated with theec2:CreateLaunchTemplateVersion
permission, andec2:RunInstances
permissions on the newly created Launch Templates. - Cleans up the downloaded files.