Automation Suite
2022.4
false
Banner background image
Automation Suite Installation Guide
Last updated Apr 24, 2024

Upgrading Automation Suite

Important:

Upgrading Automation Suite enables maintenance mode on the cluster, which causes downtime for the entire upgrade duration.

If your Automation Suite cluster was ever on 2021.10.3 or 2021.10.4, you must take additional steps to downgrade the Ceph objectstore version before upgrading to a newer Automation Suite version. For instructions, see Downgrading Ceph from 16.2.6 to 15.2.9.

Requirements

  • Make sure you meet the hardware and software requirements for new Automation Suite version.
  • Download the required installer and bundle files:

    Installation type

    Files to download

    Online

    • sf-installer.zipMandatory. See sf-installer.zip for download instructions.

    Offline

    • sf-installer.zipMandatory. See sf-installer.zip for download instructions.
    • sf-infra.tar.gzMandatory. See sf-infra.tar.gz for download instructions.
    • sf.tar.gzMandatory. See sf.tar.gz for download instructions.
    Important:

    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 NFS server. Make sure you have configured NFS server before proceeding further.

Overview

The following illustration shows the steps you need to take for a successful upgrade operation.

docs image

For a complete upgrade operation, follow these steps:

  1. Configure a backup before upgrading the cluster to a new version, if possible.
  2. Enable maintenance mode on the cluster, by bringing down the cluster network, to avoid any writes during upgrade. This step ensures the upgrade is consistent.
  3. Upgrade Kubernetes and other infrastructure components on all the cluster nodes.
  4. For offline installations, hydrate Private Docker Registry with the new container images.
  5. Upgrade the fabric and shared components on the cluster.
  6. Upgrade the services (UiPath products).
  7. Bring back the cluster by disabling the maintenance mode on the cluster.

Automation Suite upgrade paths

The following matrix shows the available upgrade paths for Automation Suite versions:

available - a direct in-place upgrade path between major versions is available;

warning - an intermediate in-place upgrade between your initial and targeted major versions is needed.

Note:

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

available

available

You must upgrade to 2022.4.7-2022.4.10, and then to 2022.4.11 or later.

available

You must upgrade to 2022.10.0-2022.10.9 first, and then to 2022.10.10 or later.

warning

You must upgrade to 2022.10.0-2022.10.9 first, and then to 2023.4.x.

warning

You must upgrade to 2022.10.0-2022.10.9 first, and then to 2023.10.x.

2022.4.x

N/A

available

available

If your current version is 2022.4.0-2022.4.6, you must upgrade to 2022.10.0-2022.10.9 first, and then to 2022.10.10 or later.

If your current version is 2022.4.7 or later, you must upgrade to 2022.10.10 or later.

warning

If your current version is 2022.4.0-2022.4.10. you must upgrade to 2022.10.0-2022.10.9 first, and then to 2023.4.x.

If your current version is 2022.4.11, you must upgrade to 2022.10.10 first, and then to 2023.4.5.

available

Requires 2022.4.7 minimum with Ceph on raw devices, and completion of Cilium migration before initiating the upgrade.

If your current version is 2022.4.7-2022.4.10, you can upgrade to 2023.10.x.

If your current version is 2022.4.11, you must upgrade to 2023.10.2 or later.

2022.10.x

N/A

N/A

available

available

If your current version is 2022.10.0-2022.10.9, you can upgrade to 2023.4.x.

If your current version is 2022.10.10 or later, you must upgrade to 2023.4.5 or later.

available

If your current version is 2022.10.0-2022.10.9, you can upgrade to 2023.10.x.

If your current version is 2022.10.10 or later, you must upgrade 2023.10.2 or later.

2023.4.x

N/A

N/A

N/A

available

available

If your current version is 2023.4.0-2023.4.4, you can upgrade to 2023.10.x.

If your current version is 2023.4.5 or later, you must upgrade to 2023.10.2 or later.

2023.10.x

N/A

N/A

N/A

N/A

available

Note:
  • 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.

  • Requirements
  • Overview
  • Automation Suite upgrade paths

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.