automation-suite
2024.10
true
- Overview
- Requirements
- Pre-installation
- Preparing the installation
- Installing and configuring the service mesh
- Downloading the installation packages
- Configuring the OCI-compliant registry
- Granting installation permissions
- Installing and configuring the GitOps tool
- Deploying Redis through OperatorHub
- Applying miscellaneous configurations
- Running uipathctl
- Installation
- Post-installation
- Migration and upgrade
- Cluster administration
- Product-specific configuration
- Troubleshooting
Automation Suite on OpenShift Installation Guide
Last updated Jan 27, 2025
Downloading the installation packages
You must install the following software on your management machine. Management machine refers to the machine you use to operate
your cluster and that can access your cluster via the
kubeconfig file. Your management machine can run Linux, Windows, or MacOS.
The following tools are required to successfully run the prerequisite checks, installation, and post-installation steps on your cluster via the client machine.
|
Tool |
Description |
Download |
|---|---|---|
|
|
Required.
uipathctl is a UiPath® command-line tool that allows you to run commands against Automation Suite Kubernetes.
You can use
uipathctl to check prerequisites in your environment, install Automation Suite, configure and manage it from a single unified CLI.
For more information, including a complete list of uipathctl operations, see the uipathctl Reference Guide.
|
|
|
| Required. Needed to perform prerequisite checks and installation steps. | |
oc | Optional. Ensure that oc matches the version of your cluster.
| |
|
|
as-cmk.tar.gz contains the container images and deployment manifests of UiPath® shared capabilities and UiPath® products.
| Download as-cmk.tar.gz |
|
|
mirror-registry.sh is required to configure an external Docker registry.
| Download mirror-registry.sh |
|
|
hydrate-registry.sh is required for configuring your external OCI-compliant registry for offline installations.
| Download hydrate-registry.sh |
|
|
as-images.txt contains the name and version of the container images that you must pull and upload into the external Docker registry.
| Download as-images.txt |
|
|
as-helm-charts.txt contain the details for the UiPath® application helm chart that you must pull and upload to an external Docker registry hosted
on your environment.
| Download as-helm-charts.txt |
|
|
uipathtools is a CLI tool that contains a subset of uipathctl capabilities specific to health commands.
| Download uipathtools |
This page provides a list of download links for all the artifacts you may need to install or configure Automation Suite. Make sure to select the version of the artifacts you target.
Required.
uipathctl is a UiPath® command-line tool that allows you to run
commands against Automation Suite. You can use uipathctl to check
prerequisites in your environment, install Automation Suite, configure and manage it
from a single unified CLI.
Note:
Currently,
uipathctl is only compatible with the x86 architecture.
You cannot run uipathctl on machines based on the ARM architecture,
such as Macs with Apple Silicon (M series) CPUs.
To download
uipathctl for Automation Suite 2024.10.1, run one of the
following commands, depending on your OS:
-
Linux:
wget -O ~/uipathctl-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathctl-2024.10.1-linux-amd64.tar.gzwget -O ~/uipathctl-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathctl-2024.10.1-linux-amd64.tar.gz -
Windows:
wget -O ~/uipathctl-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathctl-2024.10.1-windows-amd64.tar.gzwget -O ~/uipathctl-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathctl-2024.10.1-windows-amd64.tar.gz -
MacOS:
wget -O ~/uipathctl-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathctl-2024.10.1-darwin-amd64.tar.gzwget -O ~/uipathctl-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathctl-2024.10.1-darwin-amd64.tar.gz
To download
uipathctl for Automation Suite 2024.10.0, run one of the
following commands, depending on your OS:
-
Linux:
wget -O ~/uipathctl-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathctl-2024.10.0-linux-amd64.tar.gzwget -O ~/uipathctl-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathctl-2024.10.0-linux-amd64.tar.gz -
Windows:
wget -O ~/uipathctl-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathctl-2024.10.0-windows-amd64.tar.gzwget -O ~/uipathctl-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathctl-2024.10.0-windows-amd64.tar.gz -
MacOS:
wget -O ~/uipathctl-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathctl-2024.10.0-darwin-amd64.tar.gzwget -O ~/uipathctl-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathctl-2024.10.0-darwin-amd64.tar.gz
Required. Needed to perform prerequisite checks and installation steps.
To download
versions.json for Automation Suite 2024.10.1, run the
following command:
wget -O ~/versions.json https://download.uipath.com/automation-suite/2024.10.1/versions.jsonwget -O ~/versions.json https://download.uipath.com/automation-suite/2024.10.1/versions.jsonOptional. Make sure that
oc matches the version of your cluster.
To download
oc, see the OpenShift documentation.
as-cmk.tar.gz contains the container images and deployment manifests of UiPath® Shared Capabilities and UiPath® Product.
as-cmk.tar.gzFor the checksum file, click here.
-
Linux:
To downloadas-cmk.tar.gzon a Linux machine, run the following command:wget -O ~/as-cmk.tar.gz https://download.uipath.com/automation-suite/2024.10.1/as-cmk-2024.10.1.tar.gzwget -O ~/as-cmk.tar.gz https://download.uipath.com/automation-suite/2024.10.1/as-cmk-2024.10.1.tar.gz -
Windows:
https://download.uipath.com/automation-suite/2024.10.0/as-cmk-2024.10.0.tar.gzhttps://download.uipath.com/automation-suite/2024.10.0/as-cmk-2024.10.0.tar.gzFor the checksum file, click here.
-
Linux:
To downloadas-cmk.tar.gzon a Linux machine, run the following command:wget -O ~/as-cmk.tar.gz https://download.uipath.com/automation-suite/2024.10.0/as-cmk-2024.10.0.tar.gzwget -O ~/as-cmk.tar.gz https://download.uipath.com/automation-suite/2024.10.0/as-cmk-2024.10.0.tar.gz -
Windows:
mirror-registry.sh is required to configure an external Docker registry.
-
Linux:
To downloadmirror-registry.shon a Linux machine, run the following command:wget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.1/mirror-registry.shwget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.1/mirror-registry.sh -
Windows:
To downloadmirror-registry.shon a Windows machine, click here.
https://download.uipath.com/automation-suite/2024.10.0/mirror-registry.shhttps://download.uipath.com/automation-suite/2024.10.0/mirror-registry.sh-
Linux:
To downloadmirror-registry.shon a Linux machine, run the following command:wget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.0/mirror-registry.shwget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.0/mirror-registry.sh -
Windows:
To downloadmirror-registry.shon a Windows machine, click here.
hydrate-registry.sh is required for configuring your external OCI-compliant registry for offline installations in the Automation Suite.
-
Linux:
To downloadhydrate-registry.shon a Linux machine, run the following command:wget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.1/hydrate-registry.shwget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.1/hydrate-registry.sh -
Windows:
To downloadhydrate-registry.shon a Windows machine, click here.
-
Linux:
To downloadhydrate-registry.shon a Linux machine, run the following command:wget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.0/hydrate-registry.shwget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.0/hydrate-registry.sh -
Windows:
To downloadhydrate-registry.shon a Windows machine, click here.
as-images.txt contains the name and version of the container images that must be
pulled and uploaded into the external Docker registry.
-
Linux
To downloadopenshift-images.txton a Linux machine, run the following command:wget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.1/openshift-images.txtwget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.1/openshift-images.txt - Windows:
To download
openshift-images.txton a Windows machine, click here and rename the file toas-images.txt.
https://download.uipath.com/automation-suite/2024.10.0/openshift-images.txthttps://download.uipath.com/automation-suite/2024.10.0/openshift-images.txt-
Linux
To downloadopenshift-images.txton a Linux machine, run the following command:wget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.0/openshift-images.txtwget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.0/openshift-images.txt - Windows:
To download
openshift-images.txton a Windows machine, click here and rename the file toas-images.txt.
as-helm-charts.txt contain the details for the UiPath® application helm chart
that must be pulled and uploaded to an external Docker registry hosted on your
environment.
-
Linux:
To downloadembedded-helm-charts.txton a Linux machine, run the following command:wget -O ~/as-helm-charts.txt https://download.uipath.com/automation-suite/2024.10.1/embedded-helm-charts.txtwget -O ~/as-helm-charts.txt https://download.uipath.com/automation-suite/2024.10.1/embedded-helm-charts.txt -
Windows:
To downloadembedded-helm-charts.txton a Windows machine, click here and rename the file toas-helm-charts.txt.
https://download.uipath.com/automation-suite/2024.10.0/embedded-helm-charts.txthttps://download.uipath.com/automation-suite/2024.10.0/embedded-helm-charts.txt-
Linux:
To downloadembedded-helm-charts.txton a Linux machine, run the following command:wget -O ~/as-helm-charts.txt https://download.uipath.com/automation-suite/2024.10.0/embedded-helm-charts.txtwget -O ~/as-helm-charts.txt https://download.uipath.com/automation-suite/2024.10.0/embedded-helm-charts.txt -
Windows:
To downloadembedded-helm-charts.txton a Windows machine, click here and rename the file toas-helm-charts.txt.
uipathtools is a CLI tool that contains a subset of uipathctl
capabilities specific to health commands. The tool is backward compatible and works with
any supported Automation Suite version. We recommend using uipathtools
as the first step if you face any issue.
To download
uipathtools, run one of the following commands, depending on
your OS:
-
Linux
wget -O uipathtools-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathtools-2024.10.1-linux-amd64.tar.gzwget -O uipathtools-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathtools-2024.10.1-linux-amd64.tar.gz -
Windows
wget -O uipathtools-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathtools-2024.10.1-windows-amd64.tar.gzwget -O uipathtools-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathtools-2024.10.1-windows-amd64.tar.gz -
MacOS
wget -O uipathtools-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathtools-2024.10.1-darwin-amd64.tar.gzwget -O uipathtools-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathtools-2024.10.1-darwin-amd64.tar.gz
To download
uipathtools, run one of the following commands, depending on
your OS:
-
Linux
wget -O uipathtools-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathtools-2024.10.0-linux-amd64.tar.gzwget -O uipathtools-linux-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathtools-2024.10.0-linux-amd64.tar.gz -
Windows
wget -O uipathtools-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathtools-2024.10.0-windows-amd64.tar.gzwget -O uipathtools-windows-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathtools-2024.10.0-windows-amd64.tar.gz -
MacOS
wget -O uipathtools-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathtools-2024.10.0-darwin-amd64.tar.gzwget -O uipathtools-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathtools-2024.10.0-darwin-amd64.tar.gz
