- Overview
- Requirements
- Deployment templates
- Q&A: Deployment templates
- Release notes
- GCP deployment architecture
- Step 1: Preparing the GCP deployment
- Step 2: Deploying Automation Suite to GCP
- Step 3: Post-deployment steps
- Manual: Preparing the installation
- Manual: Preparing the installation
- Step 2: Configuring the OCI-compliant registry for offline installations
- Step 3: Configuring the external objectstore
- Step 4: Configuring High Availability Add-on
- Step 5: Configuring SQL databases
- Step 6: Configuring the load balancer
- Step 7: Configuring the DNS
- Step 8: Configuring the disks
- Step 9: Configuring kernel and OS level settings
- Step 10: Configuring the node ports
- Step 11: Applying miscellaneous settings
- Step 12: Validating and installing the required RPM packages
- Step 13: Generating cluster_config.json
- Cluster_config.json Sample
- General configuration
- Profile configuration
- Certificate configuration
- Database configuration
- External Objectstore configuration
- Pre-signed URL configuration
- ArgoCD configuration
- Kerberos authentication 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
- AI Center-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
- 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
- Running uipathctl
- Manual: Performing the installation
- Post-installation
- Cluster administration
- Managing products
- Getting Started with the Cluster Administration portal
- Migrating Redis from in-cluster to external High Availability Add-on
- Migrating data between objectstores
- Migrating in-cluster objectstore to external objectstore
- Migrating from in-cluster registry to an external OCI-compliant registry
- 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
- Scaling a single-node (evaluation) deployment to a multi-node (HA) deployment
- Monitoring and alerting
- Migration and upgrade
- Migrating standalone products to Automation Suite
- Step 1: Restoring the standalone product database
- Step 2: Updating the schema of the restored product database
- Step 3: Moving the Identity organization data from standalone to Automation Suite
- Step 4: Backing up the platform database in Automation Suite
- Step 5: Merging organizations in Automation Suite
- Step 6: Updating the migrated product connection strings
- Step 7: Migrating standalone Orchestrator
- Step 8: Migrating standalone Insights
- Step 9: Migrating standalone Test Manager
- Step 10: Deleting the default tenant
- Performing a single tenant migration
- Migrating between Automation Suite clusters
- 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
- 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 bucket
- 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 TX checksum offloading
- How to manually set the ArgoCD log level to Info
- How to expand AI Center storage
- How to generate the encoded pull_secret_value for external registries
- How to address weak ciphers in TLS 1.2
- How to check the TLS version
- How to reduce permissions for an NFS backup directory
- How to work with certificates
- How to schedule Ceph backup and restore data
- How to clean up unused Docker images from registry pods
- How to collect DU usage data with in-cluster objectstore (Ceph)
- How to install RKE2 SELinux on air-gapped environments
- How to clean up old differential backups on an NFS server
- 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
- SQL connection string validation error
- 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
- Support bundle log collection failure
- Temporary registry installation fails on RHEL 8.9
- Frequent restart issue in uipath namespace deployments during offline installations
- DNS settings not honored by CoreDNS
- Unable to install temporary registry
- Data loss when reinstalling or upgrading Insights following Automation Suite upgrade
- Unable to access Automation Hub following upgrade to Automation Suite 2024.10.0
- Upgrade failure during posthook import
- Single-node upgrade fails at the fabric stage
- 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 or later
- Upgrade fails in offline environments
- SQL validation fails during upgrade
- snapshot-controller-crds pod in CrashLoopBackOff state after upgrade
- Upgrade fails due to overridden Insights PVC sizes
- Failure to upgrade to Automation Suite 2024.10.1
- Upgrade fails due to Velero migration issue
- Upgrade stuck on rook-ceph application deletion
- 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
- Robot cannot connect to an Automation Suite Orchestrator instance
- Partial failure to restore backup in Automation Suite 2024.10.0
- Failure to get the sandbox image
- Pods not showing in ArgoCD UI
- Accessing FQDN returns RBAC access denied error
- Redis probe failure
- RKE2 server fails to start
- Secret not found in UiPath namespace
- ArgoCD goes into progressing state after first installation
- Pods stuck in Init:0/X
- Missing Ceph-rook metrics from monitoring dashboards
- Mismatch in reported errors during diagnostic health checks
- No healthy upstream issue
- Log streaming does not work in proxy setups
- Failure to add agent nodes in offline environments
- Node becomes unresponsive (OOM) during large Document Understanding bundle upload
- Backup operations fail with PartiallyFailed status
- Running High Availability with Process Mining
- Process Mining ingestion failed when logged in using Kerberos
- After Disaster Recovery Dapr is not working properly for Process Mining
- Unable to connect to AutomationSuite_ProcessMining_Warehouse database using a pyodbc format connection string
- Airflow installation fails with sqlalchemy.exc.ArgumentError: Could not parse rfc1738 URL from string ''
- How to add an IP table rule to use SQL Server port 1433
- Automation Suite certificate is not trusted from the server where CData Sync is running
- Running the diagnostics tool
- Using the Automation Suite support bundle
- Exploring Logs
- Exploring summarized telemetry

Automation Suite on Linux installation guide
Step 2: Deploying Automation Suite to GCP
Make sure to go through Step 1: Preparing the GCP deployment before proceeding.
Configuring the deployment
Once you prepare the GCP environment, you can directly deploy the infrastructure.
Take the following steps:
- Download the templates from here and unzip them.
- (Optional) Move the SSH keys generated at Step 1 in the templates folder.
- The unzipped templates include a
terraform.tfvarsfile with the parameters. Edit them according to your deployment.
Deployment parameters
| Name | Description | Parameter type | Example |
|---|---|---|---|
project_id | Project in which the resources will be deployed. | string | my-gcp-project |
region | Region where the resources will be deployed. | string | europe-west1 |
zone | Default zone where zonal resources are deployed. The zone should belong to the region you chose. | string | europe-west1-c |
installer_version | Automation Suite installer version. | string | 2021.10.3 |
installer_url | Automation Suite installer URL. It overwrites the installer_version parameter and installs the version from the package. | string | https://download.uipath.com/automation-suite/installer.zip |
perform_installation | Automatically install Automation Suite on the provided infrastructure. | bool | true |
lb_fqdn | Fully qualified domain name (FQDN) for Automation Suite. | string | my-fqdn.net |
ssh_user | Username used to log in VMs via SSH. | string | user |
ssh_pub_key_path | Path to the SSH public key used to access VMs. | string | gcp_key.pub |
ssh_private_key_path | Path to the SSH private key used to access VMs. | string | gcp_key |
server_instance_type | Instance type of server machines. | string | n2-standard-32 |
agent_instance_type | Instance type of agents machines. | string | n2-standard-16 |
gpu_instance_type | (Optional) Parameter used only if the number of GPU agents is at least 1. Instance type of GPU agent machines. | string | n1-standard-16 |
gpu_type | (Optional) Parameter used only if the number of GPU agents is at least 1. GPU type for the GPU nodes. | string | nvidia-tesla-t4 |
server_count | Number of server VMs, must be odd | number | 3 |
agent_count | Number of agent VMs. | number | 1 |
gpu_agent_count | Number of GPU agent VMs | number | 1 |
vm_custom_image | (Optional) Name of the custom image you want to use for the VM's. Leave empty to default to latest RHEL 8 GCP image. | string | my-rhel8-image |
install_orchestrator | Install Orchestrator. | bool | true |
install_aicenter | Install AI Center. | bool | true |
install_documentunderstanding | Install Document Understanding. | bool | true |
install_insights | Install Insights. | bool | true |
install_data_service | Install Data Service | bool | true |
install_test_manager | Install Test Manager. | bool | true |
install_automation_ops | Install Automation Ops. | bool | true |
install_automation_hub | Install Automation Hub. | bool | true |
install_apps | Install Apps. | bool | true |
install_action_center | Install Action Center. | bool | true |
install_task_mining | Install Task Mining. | bool | true |
install_as_robots | Install Automation Suite Robots. | bool | true |
asrobots_agent_count | Instance type of ASobots dedicated agents. | number | 1 |
asrobots_agent_instance_type | Number of dedicate ASRobots VMs. | string | n2-standard-16 |
install_process_mining | Install Process Mining. | bool | true |
accept_license_agreement | By setting the parameter as true, you agree to the applicable license agreement. | bool | true |
Advanced configuration
If you want to add any new configuration that is exposed via cluster_config.json, follow these steps:
-
Use your favorite text editor to edit the
./scripts/inputs_schemafile from the unzipped package. -
Change or add the
jsonfile as required.Note:Keep in mind that Terraform will replace
${var}variables defined in themetadata.tfwith their respective values when altering theinputs_schemafile.
Completing the deployment
Once you set the parameters, take the following steps:
-
Open a terminal and authenticate to GCP using the following command.
gcloud auth application-default logingcloud auth application-default login -
In the terminal, go to the folder where you unzipped the templates and run the following commands:
terraform init terraform applyterraform init terraform apply -
Type
Yeswhen asked for approval. The deployment will then run. It usually takes between 1 to 1.5 hours to complete.