- Automation Suite products
- Cross-product dependencies
- Cross-deployment feature comparison
- Security and compliance
- Certificates overview
- Q&A: Deployment templates
- Manual: Preparing the installation
- Step 1: Configuring the OCI-compliant registry for offline installations
- Step 2: Configuring the external objectstore
- Step 3: Configuring Microsoft SQL Server
- Step 4: Configuring the load balancer
- Step 5: Configuring the DNS
- Step 6: Configuring the disks
- Step 7: Configuring the node ports
- Step 8: Applying miscellaneous settings
- Step 10: Validating and installing the required RPM packages
- Step 11: Generating cluster_config.json
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- External OCI-compliant registry configuration
- Disaster recovery: Active/Passive 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
- Enabling Redis High Availability Add-On for the cluster
- 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 13: Configuring the temporary Docker registry for offline installations
- Step 14: Validating the prerequisites for the installation
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating objectstore from persistent volume to raw disks
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone Orchestrator database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the Orchestrator connection strings
- Step 6: Migrating standalone Orchestrator
- Step 7: 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
- Using the Orchestrator Configurator Tool
- Configuring Orchestrator parameters
- Orchestrator appSettings
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring credential stores
- Configuring encryption key per tenant
- 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
- 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
- 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
- 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
- Running the diagnostics tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
Step 11: Generating cluster_config.json
cluster_config.json file defines the parameters, settings, and preferences applied to the UiPath products deployed via Automation Suite. You
can either create
cluster_config.json manually or use the interactive installer, which asks several mandatory questions and generates the file for you. You can
always edit the generated file to update the configuration.
cluster_config.json file, navigate to the installer folder and run the following command:
The aforementioned command starts the interactive flow, which asks you a series of questions required for the Automation Suite configuration.
To generate the configuration file, take the following steps:
- Accept the license agreement to start configuring Automation Suite.
- In Main Menu, select your deployment mode. Your options are:
Single-node deployment – Recommended for demo and evaluation purposes;
Multi-node deployment – Recommended for production use.
- In Deployment configuration, select your environment type. Your options are:
Online – Requires internet access;
Air-gapped – Also known as offline; does not require internet access.
- Choose your product selection. Your options are:
- Complete (All products)
- Select products
For details on the product selection options, see Hardware and software requirements.
- If you chose Select products in the previous step, indicate the products you want to install. Your options are:
- Action Center
- AI Center
- Automation Hub
- Automation Ops
- Automation Suite Robots
- Data Service
- Document Understanding
- Process Mining
- Task Mining
- Test Manager
Some Automation Suite products have additional dependencies on each other. When selecting the products you want to install, make sure you consider Cross-products dependencies. Trying to install a product without its dependencies would result in an error.
In addition to that, some Automation Suite products require a dedicated agent node. Before continuing, make sure you meet the hardware requirements.
- To install AI Center, you must take the following additional steps:
Note: In offline installations, you do not need to specify the metering API key. To complete the AI Center installation, follow the step from the Completing AI Center installation section.
- Specify whether AI Center requires an external Orchestrator.
- If AI Center does not require an external Orchestrator, continue to Step 7.
- If AI Center requires an external Orchestrator, continue to Step 6.b.
- Copy the Orchestrator certificate to the virtual machine. For more information on this, check the Copy the Orchestrator certificate page.
- Specify the Orchestrator URL for AI Center. Example:
- Specify the Identity URL for AI Center. Example:
- Specify the path to the Orchestrator certificate file. Example:
- Specify the path to Identity certificate file. Example:
- Specify whether AI Center requires an external Orchestrator.
- Confirm your product selection to determine the minimum hardware and software requirements.
- Enter the Automation Suite FQDN.
- Specify whether you would like to bring your own objectstore for the selected products. It is strongly recommended to use an external objectstore. If you select No, you opt for the default object store. If you select Yes, choose one of the following options:
- Azure Storage Account – Indicate if you want to use managed identity-based with your Azure storage account, provide the following details corresponding
to your choice, then specify if you want the containers to be automatically provisioned for all the selected products:
- If Yes, provide the Azure storage account name and endpoint suffix, and your client ID;
- If No, provide the Azure storage account name and endpoint suffix, and your Azure account key;
- AWS S3 – Provide the prefix and suffix for the bucket names, the AWS region where buckets are hosted, the access key and the secret key for the S3 account, and specify if you want the buckets to be automatically provisioned for all the selected products.
- Other S3 Compatible storage – Specify the prefix and suffix for the bucket names, the S3 server FQDN, the S3 port, the access key and the secret key for the S3 account, and specify if you want the buckets to be automatically provisioned for all the selected products.
Many S3 objectstores require the CORS set to all the traffic from the Automation Suite cluster. You must configure the CORS policy at the objectstore level to allow the FQDN of the cluster.
- Azure Storage Account – Indicate if you want to use managed identity-based with your Azure storage account, provide the following details corresponding to your choice, then specify if you want the containers to be automatically provisioned for all the selected products:
- Specify whether you want to bring your own OCI-compatible external Docker registry.
If you select No, you opt for the default internal Docker registry.
If you select Yes, you must provide the following details on the registry you want to use: registry URL with port, username, and password.
- Specify whether you want to use Kerberos Authentication for SQL connections.
- Enter the SQL Server FQDN. Follow the prompt to enter the connection port, username, and password.Note:
Process Mining requires a second SQL Server. If you install Process Mining, make sure to provide the warehouse SQL Server URL, database name, connection prompt, username, and password.
For details on the hardware requirements the second SQL Server must meet, see SQL requirements for Process Mining.
- Specify whether you want the installer to automatically create the necessary databases.
- Provide the CA certificates for any external server software that requires secure TLS communication, otherwise the installation
will fail. If you did not enable the TLS communication, you can configure the certificates post-installation.Note:The installer accepts only Base64-encoded DER certificates in
PEMformat. If the external servers have different CAs, you can concatenate all the public certificates in a single file.
- After defining the configuration parameters, the installer autogenerates the configuration. You can edit the configuration
parameters directly in the terminal.Note:You can now directly edit the
cluster_config.jsonfor advanced configuration settings in the
For a Disaster recovery - Active/Passive deployment, you must now take the following steps:
Install and configure the primary cluster. For details, see Advanced installation experience.
Install and configure the secondary cluster. For details, see Disaster recovery - Installing the secondary cluster.
Resume the installation by following the instructions on this page.
cluster_config.json file is generated at the
/opt/UiPathAutomationSuite/cluster_config.json location. Note that all our installation instructions assume that you store
cluster_config.json in that folder.
cluster_config.json file must be available on all the machines. After generating the configuration file on the first machine, you must copy it
to the other machines instead of regenerating it. Regenerating the configuration file may result in discrepancies that could
cause the installation to fail.
node_dns with the values relevant to the target machine.
scp /opt/UiPathAutomationSuite/cluster_config.json <username>@<node_dns>:/opt/UiPathAutomationSuitescp /opt/UiPathAutomationSuite/cluster_config.json <username>@<node_dns>:/opt/UiPathAutomationSuite
/opt/UiPathAutomationSuite folder, you can transfer them to your home directory, and then move them to the desired location.