Step 13: Generating cluster_config.json

Generating cluster_config.json on the first machine

The 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.

Running the interactive installer to generate cluster_config.json

To generate the cluster_config.json file, navigate to the installer folder and run the following command:

cd /opt/UiPathAutomationSuite/<version>/installer

./installUiPathAS.sh

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:

1. Accept the license agreement to start configuring Automation Suite.
2. 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.

   
3. 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.

4. Choose your product selection. Your options are:
   • Complete (All products)
   • Select products

   For details on the product selection options, see Hardware and software requirements.

5. If you chose Select products in the previous step, indicate the products you want to install. Your options are:
   • Action Center
   • AI Center
   • Apps
   • Automation Hub
   • Automation Ops
   • Automation Suite Robots
   • Data Service
   • Document Understanding
   • Insights
   • Orchestrator
   • Process Mining
   • Task Mining
   • Test Manager

   Note:

   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.

   If you opt for an Active/Passive or Active/Active setup, make sure the products you enable are supported. For details, see Disaster recovery - Active/Passive and Active/Active.

6. To install AI Center, you must take the following additional steps:
   1. 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.
   2. Copy the Orchestrator certificate to the virtual machine. For more information on this, check the Copy the Orchestrator certificate page.
   3. Specify the Orchestrator URL for AI Center. Example: https://orchestrator.example.com.
   4. Specify the Identity URL for AI Center. Example: https://orchestrator.example.com/identity.
   5. Specify the path to the Orchestrator certificate file. Example: /opt/UiPathAutomationSuite/UiPath_Installer/orch.cer.
   6. Specify the path to Identity certificate file. Example: /opt/UiPathAutomationSuite/UiPath_Installer/identity.cer.
   7. In online installations, specify the metering API key.
      Note: metering_api_key is the Document Understanding API key from the AI Center cloud account.
7. Confirm your product selection to determine the minimum hardware and software requirements.
8. Enter the Automation Suite FQDN.
9. 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.

   Note:

   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.

10. 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.

11. Specify whether you want to bring your own external High Availability Add-on (HAA).

    • If you select No, you opt for the default in-cluster HAA.

    • If you select Yes (default configuration), you opt for HAA installed on external machines, and must provide the following details on your external HAA: FQDN, password, port, and TLS configuration.

12. Specify whether you want to use Kerberos Authentication for SQL connections.
13. 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.

14. Specify whether you want the installer to automatically create the necessary databases.
15. 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 PEM format. If the external servers have different CAs, you can concatenate all the public certificates in a single file.
16. 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.json for advanced configuration settings in the UiPathAutomationSuite folder.

    For a Disaster recovery - Active/Passive deployment, you must now take the following steps:

    1. Install and configure the primary cluster. For details, see Advanced installation experience.

    2. Install and configure the secondary cluster. For details, see Disaster recovery - Installing the secondary cluster.

    3. Resume the installation by following the instructions on this page.

Note: At the end of theconfiguration process, the 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.

Copying cluster_config.json to all the other machines

To install Automation Suite, the 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.

To copy the configuration file from the first machine to the other machines, run the following command. Make sure to replace username and node_dns with the values relevant to the target machine.

scp /opt/UiPathAutomationSuite/cluster_config.json <username>@<node_dns>:/opt/UiPathAutomationSuite

If you do not have direct access to copy the files to the /opt/UiPathAutomationSuite folder, you can transfer them to your home directory, and then move them to the desired location.