- Overview
- Requirements
- Recommended: Deployment templates
- Manual: Preparing the installation
- Manual: Preparing the installation
- Step 1: Configuring the OCI-compliant registry for offline installations
- Step 2: Configuring the external objectstore
- Step 3: Configuring High Availability Add-on
- Step 4: Configuring Microsoft SQL Server
- Step 5: Configuring the load balancer
- Step 6: Configuring the DNS
- Step 7: Configuring kernel and OS level settings
- Step 8: Configuring the disks
- Step 9: Configuring the node ports
- Step 10: Applying miscellaneous settings
- Step 12: Validating and installing the required RPM packages
- Step 13: Generating cluster_config.json
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- External OCI-compliant registry configuration
- Disaster recovery: Active/Passive and Active/Active configurations
- High Availability Add-on configuration
- Orchestrator-specific configuration
- Insights-specific configuration
- Process Mining-specific configuration
- Document Understanding-specific configuration
- Automation Suite Robots-specific configuration
- Monitoring configuration
- Optional: Configuring the proxy server
- Optional: Enabling resilience to zonal failures in a multi-node HA-ready production cluster
- Optional: Passing custom resolv.conf
- Optional: Increasing fault tolerance
- install-uipath.sh parameters
- Adding a dedicated agent node with GPU support
- Adding a dedicated agent Node for Task Mining
- Connecting Task Mining application
- Adding a Dedicated Agent Node for Automation Suite Robots
- Step 15: Configuring the temporary Docker registry for offline installations
- Step 16: Validating the prerequisites for the installation
- Manual: Performing the installation
- Post-installation
- Cluster administration
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating objectstore from persistent volume to raw disks
- Migrating from in-cluster to external High Availability Add-on
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Switching to the secondary cluster manually in an Active/Passive setup
- Disaster Recovery: Performing post-installation operations
- Converting an existing installation to multi-site setup
- Guidelines on upgrading an Active/Passive or Active/Active deployment
- Guidelines on backing up and restoring an Active/Passive or Active/Active deployment
- Redirecting traffic for the unsupported services to the primary cluster
- Monitoring and alerting
- Migration and upgrade
- 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
- Upgrading Automation Suite
- Downloading the installation packages and getting all the files on the first server node
- Retrieving the latest applied configuration from the cluster
- Updating the cluster configuration
- Configuring the OCI-compliant registry for offline installations
- Migrating to an external OCI-compliant registry
- Executing the upgrade
- Performing post-upgrade operations
- Product-specific configuration
- Best practices and maintenance
- Troubleshooting
- How to troubleshoot services during installation
- How to uninstall the cluster
- How to clean up offline artifacts to improve disk space
- How to clear Redis data
- How to enable Istio logging
- How to manually clean up logs
- How to clean up old logs stored in the sf-logs bundle
- How to disable streaming logs for AI Center
- How to debug failed Automation Suite installations
- How to delete images from the old installer after upgrade
- How to disable NIC checksum offloading
- How to upgrade from Automation Suite 2022.10.10 and 2022.4.11 to 2023.10.2
- How to manually set the ArgoCD log level to Info
- Unable to run an offline installation on RHEL 8.4 OS
- Error in downloading the bundle
- Offline installation fails because of missing binary
- Certificate issue in offline installation
- First installation fails during Longhorn setup
- SQL connection string validation error
- Prerequisite check for selinux iscsid module fails
- Azure disk not marked as SSD
- Failure after certificate update
- Antivirus causes installation issues
- Automation Suite not working after OS upgrade
- Automation Suite requires backlog_wait_time to be set to 0
- Volume unable to mount due to not being ready for workloads
- Cluster unhealthy after automated upgrade from 2021.10
- Upgrade fails due to unhealthy Ceph
- RKE2 not getting started due to space issue
- Volume unable to mount and remains in attach/detach loop state
- Upgrade fails due to classic objects in the Orchestrator database
- Ceph cluster found in a degraded state after side-by-side upgrade
- Unhealthy Insights component causes the migration to fail
- Service upgrade fails for Apps
- In-place upgrade timeouts
- Docker registry migration stuck in PVC deletion stage
- AI Center provisioning failure after upgrading to 2023.10
- Upgrade fails in offline environments
- Setting a timeout interval for the management portals
- Authentication not working after migration
- Kinit: Cannot find KDC for realm <AD Domain> while getting initial credentials
- Kinit: Keytab contains no suitable keys for *** while getting initial credentials
- GSSAPI operation failed due to invalid status code
- Alarm received for failed Kerberos-tgt-update job
- SSPI provider: Server not found in Kerberos database
- Login failed for AD user due to disabled account
- ArgoCD login failed
- Update the underlying directory connections
- Failure to get the sandbox image
- Pods not showing in ArgoCD UI
- Redis probe failure
- RKE2 server fails to start
- Secret not found in UiPath namespace
- ArgoCD goes into progressing state after first installation
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- Unhealthy services after cluster restore or rollback
- Pods stuck in Init:0/X
- Missing Ceph-rook metrics from monitoring dashboards
- Running the diagnostics tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
install-uipath.sh parameters
install-uipath.sh
manual installer allows you to customize the installation experience without running the interactive installer (installUiPathAS.sh
).
While the manual installer is suitable for advanced scenario, the deployment templates and the interactive installer are still the recommended options.
install-uipath.sh
installer is available in as-installer.zip
. For download instructions, see Downloading installation packages.
.json
file.
input.json
refers to the cluster_config.json
that defines the parameters, settings, and preferences applied to the UiPath® services deployed via Automation Suite. You
need to update this file to change the defaults and use any advanced configuration for your cluster. For details, refer to
Manual: Advanced installation experience.
-k
. Determines the type of node to be joined to an existing cluster. Allowed values: <server|agent>
.
–install-all
will be implied.
Specify the path to the offline bundle. Indicates that the installation method is tarball.
--offline-bundle
or --optional-offline-bundle
. Specify the parent directory for the temporary offline installation folder. Defaults to /tmp
.
Used with the tarball installation method, performs the installation of all prerequisites.
Skips the installation of prerequisites during the online installation method. By default, prerequisites are installed.
/etc/rancher/rke2/rke2.yaml
.
Install Cilium CNI (Container Network Interface) to replace the default Canal. Only used during upgrade. You cannot use it with any installation flag.
Skip prerequisite checks during installation. Note that you cannot skip RPM package validation.
Specify the targeted machines for installation. Provide comma-separated IP addresses or hostnames of all the machines.
input.json
file with the current cluster configuration.
- Install the Kubernetes cluster components on the VM where it is executed, using the online installation method.
install-uipath.sh -i ./input.json -o ./output.json -k --accept-license-agreement
install-uipath.sh -i ./input.json -o ./output.json -k --accept-license-agreement - Install the Kubernetes components on the VM where it is executed, and join it to the existing cluster as a server, using the
online installation method.
install-uipath.sh -i ./input.json -o ./output.json -k -j server --accept-license-agreement
install-uipath.sh -i ./input.json -o ./output.json -k -j server --accept-license-agreement - Perform the complete installation on the current VM, using the online installation method. Includes the Kubernetes cluster
components, the Fabric, and the UiPath® services.
install-uipath.sh -i ./input.json -o ./output.json -a --accept-license-agreement
install-uipath.sh -i ./input.json -o ./output.json -a --accept-license-agreement - Perform the complete installation on the current VM, using the online installation method. This time, skip the prerequisites
installation.
install-uipath.sh -i ./input.json -o ./output.json -a --skip-packages-install --accept-license-agreement
install-uipath.sh -i ./input.json -o ./output.json -a --skip-packages-install --accept-license-agreement - Perform the Kubernetes cluster installation, using the tarball installation method. Also, join the node to the existing cluster
and install all the offline prerequisites.
install-uipath.sh -i ./input.json -o ./output.json -k -j agent --offline-bundle "/tmp/as-infra.tar.gz" --accept-license-agreement --install-offline-prereqs
install-uipath.sh -i ./input.json -o ./output.json -k -j agent --offline-bundle "/tmp/as-infra.tar.gz" --accept-license-agreement --install-offline-prereqs - Install the fabric and services components using the offline installation method, without a temporary folder provided.
install-uipath.sh -i ./input.json -o ./output.json -f -s --offline-bundle "/tmp/as-infra.tar.gz" --accept-license-agreement
install-uipath.sh -i ./input.json -o ./output.json -f -s --offline-bundle "/tmp/as-infra.tar.gz" --accept-license-agreement - Execute the installer for an offline installation, but without loading the artifacts.
install-uipath.sh -i ./input.json -o ./output.json -s --accept-license-agreement
install-uipath.sh -i ./input.json -o ./output.json -s --accept-license-agreement - Execute the installer skipping the prerequisites check
install-uipath.sh -i ./input.json -o ./output.json -k --accept-license-agreement --skip-pre-reqs
install-uipath.sh -i ./input.json -o ./output.json -k --accept-license-agreement --skip-pre-reqs
- Required parameters
--input -i <string>
--output -o <string>
- Optional parameters
--install-kubernetes -k
--join-node -j <server|agent>
--install-fabric -f
--install-services -s
--install-all -a
--offline-bundle <string>
--offline-tmp-folder <string>
--optional-offline-bundle <string>
--pre-reqs -p
--install-offline-prereqs
--skip-packages-install
--upgrade -u
--kubeconfig <string>
--backup -b
--restore -r
--restore-volume
--disable-backup
-d
-h
--accept-license-agreement
-c
--skip-pre-reqs
--one-time-manual-backup
-m|--machines <comma separated machine's IP>
--compare-config
--skip-compare-config
- Examples