- 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
- Upgrading Automation Suite
- Migrating standalone products to Automation Suite
- Step 1: Restoring the standalone product database
- Step 2: Updating the schema of the restored product database
- Step 3: Moving the Identity organization data from standalone to Automation Suite
- Step 4: Backing up the platform database in Automation Suite
- Step 5: Merging organizations in Automation Suite
- Step 6: Updating the migrated product connection strings
- Step 7: Migrating standalone Orchestrator
- Step 8: Migrating standalone Insights
- Step 9: Migrating standalone Test Manager
- Step 10: Deleting the default tenant
- Performing a single tenant migration
- Migrating between Automation Suite clusters
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library creation
- Troubleshooting
Automation Suite on OpenShift installation guide
Running uipathctl
uipathctl is a UiPath® command-line tool that allows you to perform various operations in Automation Suite on EKS/AKS, Automation Suite on OpenShift, and Automation Suite on Linux.
You can use uipathctl to check prerequisites in your environment, install Automation Suite, as well as configure and manage it from a single unified CLI.
You can install uipathctl on the Linux, macOS, and Windows platforms.
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.
For more information, including a complete list of uipathctl operations, see the uipathctl Reference Guide.
Running uipathctl on Linux
To run uipathctl on Linux, take the following steps:
-
Download the version of the
uipathctlbinary that you are interested in. For instructions, see Downloading the installation packages. -
Uncompress
uipathctland add it to your PATH:tar xzvf uipathctl-linux-amd64.tar.gz chmod +x uipathctl export PATH=$PATH:$(pwd)tar xzvf uipathctl-linux-amd64.tar.gz chmod +x uipathctl export PATH=$PATH:$(pwd) -
Verify if
uipathctlworks:uipathctl versionuipathctl versionThe command prints some version information, as shown in the following example:
Version: 2024.10.0 ...Version: 2024.10.0 ...
Running uipathctl on Windows
To run uipathctl on Windows, take the following steps:
-
Download the version of the
uipathctlbinary that you are interested in. For instructions, see . -
Uncompress
uipathctland add it to your PATH:tar xzvf uipathctl-windows-amd64.tar.gztar xzvf uipathctl-windows-amd64.tar.gzAppend or prepend the
uipathctlbinary folder to yourPATHenvironment variable. -
Verify it is working:
uipathctl versionuipathctl versionThe command prints some version information, as shown in the following example:
Version: 2024.10.0 ...Version: 2024.10.0 ...
Running uipathctl on MacOS
To run uipathctl on MacOS, take the following steps:
-
Download the version of the
uipathctlbinary that you are interested in. For instructions, see . -
Uncompress
uipathctland add it to your PATH:tar xzvf uipathctl-darwin-amd64.tar.gz chmod +x uipathctl export PATH=$PATH:$(pwd)tar xzvf uipathctl-darwin-amd64.tar.gz chmod +x uipathctl export PATH=$PATH:$(pwd) -
Verify if
uipathctlworks:uipathctl versionuipathctl versionThe command prints some version information, as shown in the following example:
Version: 2024.10.0 ...Version: 2024.10.0 ...
Telemetry
By default, telemetry is sent from uipathctl to UiPath® at each command execution. This helps us improve our products and user experience.
To opt out of telemetry, set the UIPATHCTL_TELEMETRY_OPTOUT environment variable to 1:
export UIPATHCTL_TELEMETRY_OPTOUT=1
export UIPATHCTL_TELEMETRY_OPTOUT=1