- Overview
- Requirements
- Pre-installation
- Installation
- Post-installation
- Migration and upgrade
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
Automation Suite on EKS/AKS Installation Guide
Downloading the installation packages
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. | |
| Optional. Ensure that kubectl 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.
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.
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.
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.gz
wget -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.gz
wget -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.gz
wget -O ~/uipathctl-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathctl-2024.10.1-darwin-amd64.tar.gz
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.gz
wget -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.gz
wget -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.gz
wget -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.
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.json
wget -O ~/versions.json https://download.uipath.com/automation-suite/2024.10.1/versions.json
kubectl
matches the version of your cluster.
kubectl
, see Kubernetes documentation.
as-cmk.tar.gz
contains the container images and deployment manifests of UiPath® Shared Capabilities and UiPath® Product.
as-cmk.tar.gz
. If you choose
the online installation profile, Kubernetes will pull all the container images and
deployment manifests directly from the container registry hosted in UiPath® servers.
as-cmk.tar.gz
is required during installation and upgrade.
For the checksum file, click here.
-
Linux:
To downloadas-cmk.tar.gz
on 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.gz
wget -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.gz
https://download.uipath.com/automation-suite/2024.10.0/as-cmk-2024.10.0.tar.gz
For the checksum file, click here.
-
Linux:
To downloadas-cmk.tar.gz
on 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.gz
wget -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.sh
on a Linux machine, run the following command:wget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.1/mirror-registry.sh
wget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.1/mirror-registry.sh -
Windows:
To downloadmirror-registry.sh
on a Windows machine, click here.
https://download.uipath.com/automation-suite/2024.10.0/mirror-registry.sh
https://download.uipath.com/automation-suite/2024.10.0/mirror-registry.sh
-
Linux:
To downloadmirror-registry.sh
on a Linux machine, run the following command:wget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.0/mirror-registry.sh
wget -O ~/mirror-registry.sh https://download.uipath.com/automation-suite/2024.10.0/mirror-registry.sh -
Windows:
To downloadmirror-registry.sh
on 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.sh
on a Linux machine, run the following command:wget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.1/hydrate-registry.sh
wget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.1/hydrate-registry.sh -
Windows:
To downloadhydrate-registry.sh
on a Windows machine, click here.
-
Linux:
To downloadhydrate-registry.sh
on a Linux machine, run the following command:wget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.0/hydrate-registry.sh
wget -O ~/hydrate-registry.sh https://download.uipath.com/automation-suite/2024.10.0/hydrate-registry.sh -
Windows:
To downloadhydrate-registry.sh
on 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 downloadair-images.txt
on a Linux machine, run the following command:wget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.1/air-images.txt
wget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.1/air-images.txt - Windows:
https://download.uipath.com/automation-suite/2024.10.0/air-images.txt
https://download.uipath.com/automation-suite/2024.10.0/air-images.txt
-
Linux
To downloadair-images.txt
on a Linux machine, run the following command:wget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.0/air-images.txt
wget -O ~/as-images.txt https://download.uipath.com/automation-suite/2024.10.0/air-images.txt - Windows:
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.txt
on 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.txt
wget -O ~/as-helm-charts.txt https://download.uipath.com/automation-suite/2024.10.1/embedded-helm-charts.txt -
Windows:
To downloadembedded-helm-charts.txt
on 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.txt
https://download.uipath.com/automation-suite/2024.10.0/embedded-helm-charts.txt
-
Linux:
To downloadembedded-helm-charts.txt
on 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.txt
wget -O ~/as-helm-charts.txt https://download.uipath.com/automation-suite/2024.10.0/embedded-helm-charts.txt -
Windows:
To downloadembedded-helm-charts.txt
on 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.
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.gz
wget -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.gz
wget -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.gz
wget -O uipathtools-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.1/uipathtools-2024.10.1-darwin-amd64.tar.gz
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.gz
wget -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.gz
wget -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.gz
wget -O uipathtools-darwin-amd64.tar.gz https://download.uipath.com/uipathctl/2024.10.0/uipathtools-2024.10.0-darwin-amd64.tar.gz