Automation Suite on OpenShift installation guide

• Kubernetes infrastructure where Automation Suite is deployed (OpenShift)
• Components that you choose to bring as part of Automation Suite (e.g., Gatekeeper, FluentD, etc.)

• UiPath® services (e.g., Orchestrator)
• Components deployed as part of Automation Suite (e.g., ArgoCD)

Upgrading UiPath® services and components​

Preparation​

1. Check the compatibility matrix to determine the supported versions for each available upgrade scenario. If you brought your own components, make sure the versions of your components are compatible with the version you plan to upgrade to. For details, see Compatibility matrix.
2. Download versions.json and uipathctl for the version you want to upgrade to, on your management machine. For download instructions, see Downloading the installation packages.
3. Generate the latest input.json file as follows:
   • Option A: To get the latest revision of your input.json file, run the following command:
     assignment

     uipathctl manifest get-revision
     uipathctl manifest get-revision
     

   • Option B: To list all the past input.json files and determine the one you want to choose, run the following command:
     assignment

     uipathctl manifest list-revisions
     uipathctl manifest list-revisions
     

4. If you are using an offline setup with an external OCI-compliant registry, you must hydrate the registry with container images and Helm charts before upgrade. For details, refer to Hydrating the registry with the offline bundle.
5. If Process Mining is installed, and you want to use latest version of Airflow which needs PostgreSQL, you must add or update the sqlalchemy connection string template applicable for PostgreSQL in the cluster_config.json file before the upgrade: postgresql_connection_string_template_sqlalchemy_pyodbc.
   assignment

   postgresql+psycopg2://<user>:<password>@<postgresql host>:<postgresql port>/<airflow db name>
   postgresql+psycopg2://<user>:<password>@<postgresql host>:<postgresql port>/<airflow db name>
   

   Note:

   This only applies to Process Mining on Automation Suite 2024.10.3 or higher.

Execution​

1. Confirm that your cluster is healthy:
   assignment

   uipathctl health check --namespace <uipath> --versions versions.json
   uipathctl health check --namespace <uipath> --versions versions.json
   

2. Put the cluster in maintenance mode to guarantee a consistent backup:
   assignment

   uipathctl cluster maintenance enable
   uipathctl cluster maintenance enable
   

   Important:

   This operation causes downtime, and your business automation is suspended while maintenance mode is enabled.

3. Verify that the cluster is in maintenance mode:
   assignment

   uipathctl cluster maintenance is-enabled
   uipathctl cluster maintenance is-enabled
   

4. Back up the cluster and the SQL database, then check that the backup completed successfully.
   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. This is applicable before upgrading your Kubernetes infrastructure as well. Make sure to copy the value of 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
5. Disable the maintenance mode:
   assignment

   uipathctl cluster maintenance disable
   uipathctl cluster maintenance disable
   

   Note:

   You must disable maintenance mode before upgrade. The Automation Suite upgrade process does not support having maintenance mode enabled.

6. Perform the upgrade of UiPath® services and components:
   assignment

   uipathctl cluster upgrade input.json --versions versions.json
   uipathctl cluster upgrade input.json --versions versions.json
   

   Important:

   This operation causes downtime, and your business automation is suspended during the upgrade process. It is important that you perform the upgrade only during your maintenance window.

7. Check that the cluster is healthy after the upgrade:
   assignment

   uipathctl health check --namespace <uipath> --versions versions.json
   uipathctl health check --namespace <uipath> --versions versions.json
   

   Note:

   If you upgraded to Automation Suite 2024.10.3 or higher, you can uninstall Dapr and Cert Manager if you have not enabled Task Mining. For more details, refer to the Uninstall Dapr and Uninstall Cert Manager sections.

Upgrading Kubernetes infrastructure​