- 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
Accessing Automation Suite
Before running any kubectl commands, make sure you have downloaded and installed kubectl on your client machine. This allows you to run commands for retrieving passwords and configuration details for the cluster.
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 certificates.
If you try to access the cluster with a web browser, and the certificates are not from a trusted CA, then you will see a warning in the browser. You can rectify this by importing and trusting the cluster SSL certificate on the client computer running the browser.
To manage certificates, take the following steps:
The general-use Automation Suite user interface serves as a portal for both organization administrators and organization users. It is a common organization-level resource from where everyone can access all of your Automation Suite areas: administration pages, platform-level pages, product-specific pages, and user-specific pages.
To access Automation Suite, take the following steps:
The host portal is for system administrators to configure the Automation Suite instance. The settings that you configure from this portal are inherited by all your organizations, and some can be overwritten at the organization level.
To access host administration, take the following steps:
To access the ArgoCD account using a username and password, take the following steps:
Automation Suite uses Prometheus, Grafana, and Alert Manager to provide cluster management tools out of the box. This helps you manage the cluster and access monitoring and troubleshooting.
For details on how to use monitoring tools in Automation Suite, see Using the monitoring stack.
You can access the Automation Suite monitoring tools individually using the following URLs:
Application |
Tool |
URL |
Example |
---|---|---|---|
Metrics |
Prometheus |
|
|
Dashboard |
Grafana |
|
|
Alert Management |
Alert Manager |
|
|
To access Prometheus and Alert Manager, the username is admin.
To retrieve the password for Prometheus and Alert Manager, use the following command:
kubectl get secret -n uipath dex-static-credential -o jsonpath='{.data.password}' | base64 -d
kubectl get secret -n uipath dex-static-credential -o jsonpath='{.data.password}' | base64 -d
To access Grafana dashboard, the username is admin.
To retrieve the password for Grafana, use the following command:
kubectl get secret -n monitoring grafana-creds -o jsonpath='{.data.admin-password}' | base64 -d
kubectl get secret -n monitoring grafana-creds -o jsonpath='{.data.admin-password}' | base64 -d
You can access the database connection strings for each service as follows:
kubectl -n uipath get secret aicenter-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret orchestrator-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-hub-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-ops-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret insights-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret platform-service-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret test-manager-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret aicenter-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret orchestrator-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-hub-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret automation-ops-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret insights-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret platform-service-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode
kubectl -n uipath get secret test-manager-secrets -o jsonpath='{.data.sqlConnectionString}' | base64 --decode