- Overview
- Requirements
- Installation
- 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
- Downloading the installation packages
- Install-uipath.sh Parameters
- Enabling Redis High Availability Add-On for the cluster
- Document Understanding configuration file
- Adding a dedicated agent node with GPU support
- Connecting Task Mining application
- Adding a dedicated agent Node for Task Mining
- Adding a Dedicated Agent Node for Automation Suite Robots
- Post-installation
- Cluster administration
- Monitoring and alerting
- Migration and upgrade
- Migration options
- 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 Insights
- Step 7: Deleting the default tenant
- Performing a single tenant migration
- 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 automatically clean up Longhorn snapshots
- How to disable TX checksum offloading
- How to address weak ciphers in TLS 1.2
- 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
- Unable to launch Automation Hub and Apps with proxy setup
- Failure to upload or download data in objectstore
- PVC resize does not heal Ceph
- Failure to resize PVC
- Failure to resize objectstore PVC
- Rook Ceph or Looker pod stuck in Init state
- StatefulSet volume attachment error
- Failure to create persistent volumes
- Storage reclamation patch
- Backup failed due to TooManySnapshots error
- All Longhorn replicas are faulted
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- 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
- 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
- Unexpected inconsistency; run fsck manually
- MongoDB pods in CrashLoopBackOff or pending PVC provisioning after deletion
- MongoDB Pod Fails to Upgrade From 4.4.4-ent to 5.0.7-ent
- Unhealthy services after cluster restore or rollback
- Pods stuck in Init:0/X
- Prometheus in CrashloopBackoff state with out-of-memory (OOM) error
- Missing Ceph-rook metrics from monitoring dashboards
- Pods cannot communicate with FQDN in a proxy environment
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
You can currently use the GCP deployment template only with Automation Suite 2024.10. We therefore recommend referring to the Automation Suite 2024.10 documentation.
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.