- 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 upgrade
- uipathctl config
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config additional-ca-certificates get
- uipathctl config tls-certificates get
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config additional-ca-certificates update
- uipathctl config tls-certificates update
- uipathctl health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test
- uipathctl identity
- uipathctl identity add-host-admin
- uipathctl identity enable-basic-auth
- uipathctl identity get-saml-certificate
- uipathctl identity get-token-signing-certificate
- uipathctl identity rotate-saml-certificates
- uipathctl identity rotate-token-signing-certificates
- uipathctl identity update-saml-certificate
- uipathctl identity update-token-signing-certificate
- uipathctl manifest
- uipathctl manifest apply
- uipathctl manifest diff
- uipathctl manifest get
- uipathctl manifest list-applications
- 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 sso
- uipathctl sso generate-connector
- uipathctl sso generate-overlays
- uipathctl sso generate-rbac
- uipathctl version
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite on EKS/AKS
- Migration options
- 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 Insights
- Step 7: Deleting the default tenant
- B) Single tenant migration
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Troubleshooting
Prerequisite checks
input.json
before starting the Automation Suite installation.
uipathctl prereq
command. By default, this command verifies all the prerequisites. If you want to exclude components from the execution, use
the --excluded
flag.
The checks in the following table are run on each node:
Check |
Description |
---|---|
SQL Connection |
Validates that Automation Suite can successfully connect to SQL server for UiPath products and shared services (such as Identity,
Portal, Org Mamagement, etc.) using the SQL connection strings provided in
input.json . This is mandatory for a successful installation.
|
SQL DB roles |
Validates the necessary roles and permissions required by UiPath products. This is mandatory for a successful installation. |
SQL DB compatibility |
Validates SQL DB compatibility requirements. |
FQDN resolution |
Validates that the FQDN and the sub-domains are successfully resolvable. |
Object Storage API |
Validates that Object store APIs are accessible based on access information provided in
input.json . This is mandatory for a successful installation of UiPath Services.
|
Cache / Redis |
Validates the connection to Cloud Redis or ElastiCache. This is mandatory for a successful installation. |
Capacity |
Validates you have minimum worker nodes' CPU and RAM capacity based on products enabled in
input.json .
|
Storage Class |
Validates the storage classes for File Storage are configured as required for Automation Suite Robots. |
Optional Components |
Validates that your cluster has components that you chose to exclude from the Automation Suite installation. |
Ingress |
Validates that the cluster ingress is configured correctly and the FQDN URL requests can reach UiPath products. |
Network Policies |
Checks if network policies configured in Automation Suite are compatible with the cluster. |
Registry |
Validates that Automation Suite can access the UiPath docker registry. This is mandatory for a successful installation. |
Cluster Connectivity |
Validates whether the cluster communication is configured properly:
|