- Overview
- Requirements
- Installation
- Prerequisite checks
- Downloading the installation packages
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster migration
- uipathctl cluster migration export
- uipathctl cluster migration import
- uipathctl cluster migration run
- uipathctl cluster upgrade
- uipathctl config
- uipathctl config add-host-admin
- uipathctl config additional-ca-certificates
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config argocd
- uipathctl config argocd ca-certificates
- uipathctl config argocd ca-certificates get
- uipathctl config argocd ca-certificates update
- uipathctl config argocd generate-dex-config
- uipathctl config argocd generate-rbac
- uipathctl config argocd registry
- uipathctl config argocd registry get
- uipathctl config argocd registry update
- uipathctl config enable-basic-auth
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config saml-certificates get
- uipathctl config saml-certificates rotate
- uipathctl config saml-certificates update
- uipathctl config tls-certificates
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl config token-signing-certificates
- uipathctl config token-signing-certificates get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- uipathctl health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test
- uipathctl manifest
- uipathctl manifest apply
- uipathctl manifest diff
- uipathctl manifest get
- uipathctl manifest get-revision
- uipathctl manifest list-applications
- uipathctl manifest list-revisions
- uipathctl manifest render
- uipathctl prereq
- uipathctl prereq create
- uipathctl prereq run
- uipathctl resource
- uipathctl resource report
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- uipathctl version
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite on EKS/AKS
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone product database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the migrated product connection strings
- Step 6: Migrating standalone Orchestrator
- Step 7: Migrating standalone Insights
- Step 8: Deleting the default tenant
- B) Single tenant migration
- Migrating from Automation Suite on Linux to Automation Suite on EKS/AKS
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
Installing Automation Suite on EKS/AKS
This page walks you through the high-level installation instructions for Automation Suite on AKS and EKS.
Before you begin, consider the following:
-
Kubernetes, AWS, and Azure cloud resources management knowledge is required to deploy and manage Automation Suite on AKS/EKS. If you encounter issues installing and configuring Automation Suite on AKS/EKS, contact UiPath® Professional Services.
-
Before choosing your deployment profile, see Deployment scenarios.
-
The installation process generates self-signed certificates on your behalf. You should replace them with certificates signed by a trusted Certificate Authority (CA) as soon as installation completes. For instructions, see Managing the certificates.
-
Automation Suite on AKS/EKS does not currently support Federal Information Processing Standard 140-2 (FIPS 140-2). If you require FIPS 140-2 for Automation Suite, you can deploy Automation Suite on FIPS 140-2-enabled RHEL machines. For details, see Security and compliance.
Before installing Automation Suite, you must configure the cloud resources in your environment. This includes:
- AKS or EKS cluster
- Offline only: External OCI-compliant registry
- Object Storage - Azure Blob or Amazon S3
- Block Storage
- File Storage
- Database
- Caching
- Networking (e.g., VNETs / VPC, DNS, subnets, NSGs / security groups, NAT gateway, elastic IP and internet gateway)
- Certificates
- Networking Policies
For instructions on prerequisites, see Requirements.
no_proxy
settings while configuring the proxy. For instructions on how to configure your proxy, see Configuring the proxy.
In offline installations, you need a registry compliant with OCI (Open Container Initiative) to store the container images and deployment Helm charts.
There are two ways to upload the Automation Suite artifacts to the external OCI-compliant registry:
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 hosted on Azure Kubernetes
Service (AKS) and Amazon Elastic Kubernetes Service (EKS).
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 documentation.
| |
| Required. Needed to perform prerequisite checks and installation steps. | |
| Optional. Ensure that kubectl matches the version of your cluster
|
input.json
file to provide the required inputs for the uipathctl
installer and perform operations such as configuring the SQL connection strings and the UiPath® services you would like to
enable.
input.json
template files for AKS and EKS. For instructions on how to configure input.json
, see Configuring input.json.
Optionally, you can bring your own components that are part of the Automation Suite stack. For details on the components, see Automation Suite on EKS/AKS stack. For details on how to configure the component you bring, see Bring your own components.
If you perform an offline installation, make sure to configure your external OCI-compliant registry.
To install Automation Suite on EKS/AKS in offline mode, you must take the following additional steps:
-
Explicitly set the value of the
install_type
parameter tooffline
in theinput.json
file;
uipathctl
requires access to the KubeAPI Server to perform cluster-level operations such as deployment, resource creation, etc. To
access the KubeAPI server, uipathctl
uses the kubeconfig
file, which contains the admin-level credentials needed to access the cluster. This file must be present in the ~/.kube/config
folder (default location) of your local (management) machine.
kubeconfig
file in the default location, you can alternatively provide it with help of the --kubeconfig
flag during every execution of uipathctl
.
Prerequisite checks ensure that the needed cloud infrastructure is provisioned appropriately and is accessible by the client machine before starting the installation of Automation Suite.
The installer can automatically generate the following configurations on your behalf:
-
The SQL databases required for the installation on the SQL server based if the
sql.create_db
key is set in yourinput.json
file. -
The object storage buckets required in your cloud provider if the
external_object_storage.create_bucket
key is set in the configuration file.
To allow the installer to generate these configurations, run the following command:
uipathctl prereq create input.json --versions versions.json
uipathctl prereq create input.json --versions versions.json
uipathctl prereq create
command does not create the required SQL databases for Process Mining. You must manually create them by following the instructions
in Bring your own database.
input.json
, run the following command:
uipathctl prereq run input.json --versions versions.json
uipathctl prereq run input.json --versions versions.json
uipathctl prereq
. By default, the command checks all the prerequisites. However, it also allows you to run strictly the checks that are relevant
to you:
-
If you want to exclude components from the execution, use the
--excluded
flag. For example, if you do not want to check the database connection strings, runuipathctl prereq --excluded SQL
. The command runs all the prerequisite checks except for the SQL-related one. -
If you want to include only certain components in the execution, use the
--included
flag. For example, if you only want to check the DNS and objectstore, runuipathctl prereq --included DNS,OBJECTSTORAGE
.
You can find the names of the components you can include or exclude from the prerequisite checks here. In the example, the first word on each outdented line represents the component name. For example: SQL, OBJECTSTORE, DNS, etc.
For an output result example, see Output example: prerequisite check.
To see which deployment scenarios are available for Automation Suite on AKS/EKS, see Deployment scenarios.
- After successfully validating the prerequisites,
you can proceed to install Automation Suite by running the following
command:For an output example, see Output example: Automation Suite installation.
uipathctl manifest apply input.json --versions versions.json
uipathctl manifest apply input.json --versions versions.json - To rerun the installation, use the same command as in step 1, with all the arguments and flags.
- To validate that your installation is successful, and services are healthy, run the following command:
uipathctl health check
uipathctl health check
If you run into issues during installation, see Troubleshooting.
- Step 1: Provisioning the infrastructure prerequisites
- Optional: Configuring the proxy
- Step 2: Configuring the external OCI-compliant registry
- Step 3: Downloading the software on your client machine
- Step 4: Configuring input.json
- Step 5: Accessing your cluster with uipathctl
- Step 6: Checking the infrastructure prerequisites
- Step 7: Installing Automation Suite