- Overview
- Requirements
- Pre-installation
- Preparing the installation
- Downloading the installation packages
- Configuring the OCI-compliant registry
- Granting installation permissions with cluster roles
- Granting installation permissions without cluster roles
- Installing and configuring the service mesh
- Installing and configuring the GitOps tool
- Installing the External Secrets Operator
- Deploying Redis through OperatorHub
- Applying miscellaneous configurations
- Running uipathctl
- Installation
- Post-installation
- Migration and upgrade
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library installation
- AI Trust Layer
- Troubleshooting
- 500 errors and rate limiting on S3 requests in ODF
- External Secrets troubleshooting
- Configuring CSI driver tolerations for ODF 4.20
- Temporal as a Service troubleshooting
- AI Center and Document Understanding pods fail to start with TLS certificate verification enabled
- Studio Desktop cannot load Integration Service connectors and activities
- TLS certificate validation errors
- Manual ArgoCD NetworkPolicy mitigation (GHSA-47m3-95c7-g2g8)
- Configuring resource requests and limits for uipathctl-created workloads
Generating the configuration file using a wizard
Generate input.json configuration file using interactive wizard for Automation Suite installation.
You can generate the input.json configuration file either manually or using the Automation Suite Installer Wizard. While the wizard offers a more user-friendly approach, it currently does not accommodate all possible configuration scenarios.
In some specific instances, manual creation of the configuration file might be required. For details, refer to Configuring input.json.
To generate input.json using the Automation Suite Installer Wizard, take the following steps:
-
Launch the wizard on port 80 on the local host by running the following command:
- On Linux/macOS:
./uipathctl config generate./uipathctl config generate - On Windows:
uipathctl.exe config generateuipathctl.exe config generate
To launch the wizard on a different port and host, run the following command:
- On Linux/macOS:
./uipathctl config generate --port <your port> --host <your IP address>./uipathctl config generate --port <your port> --host <your IP address> - On Windows:
uipathctl.exe config generate --port <your port> --host <your IP address>uipathctl.exe config generate --port <your port> --host <your IP address>
- On Linux/macOS:
-
In a browser of your choice, launch the wizard by accessing the following URL:
http://localhost:80.If you chose a different host and port, make sure to replace
localhostand80with the IP address and port where you want to launch the wizard. -
Accept the license agreement.
-
Indicate the platform where you want to host Automation Suite. You can choose from the following options:
- Automation Suite on AKS
- Automation Suite on EKS
- Automation Suite on OpenShift
Note:
The instructions in this guide are applicable if you choose this option.
- Automation Suite on Linux
-
Specify your deployment mode. You can choose from the following options:
- Online - Choose this option to install Automation Suite in an online environment. This deployment mode requires internet access during installation and runtime.
- Offline - Choose this option to install Automation in an offline environment. This deployment mode requires an OCI-compliant container registry.
For details, refer to Deployment scenarios.
-
Indicate your deployment type. You can choose from the following options:
- Highly Available - Choose this option if you want to install Automation Suite in multi-node HA-ready mode.
-
Provide additional details on your initial configuration. Depending on your previous selection, you may have to provide details such as the Automation Suite FQDN, admin username and password, storage class, namespace, ArgoCD project, and ArgoCD application namespace.
-
Indicate the Automation Suite products you want to enable.
For details, refer to Automation Suite products.
-
Provide the details on your SQL database configuration, such as the following:
- Whether you want to bring your own database or you want the Automation Suite installer to create it for you
- Whether you want to use Kerberos authentication
- The Redis cache details
For details, refer to SQL database.
-
Specify the storage configuration details, such as storage type or bucket details.
For details, refer to Storage.
-
If you opted for an offline installation, provide the details of your OCI-compliant registry.
For details, refer to Configuring the OCI-compliant registry.
-
Provide your certificates details.
For details, refer to Certificates.
-
Specify the products for which you want to perform advanced configuration such as overwrite platform-level configurations with service-level configurations such as connections strings, objectstore setup, etc.
-
Download the
input.jsonconfiguration file.
Any feature that is not available during the input.json configuration using the Automation Suite Installer Wizard, can be manually included after downloading the configuration file.