- Overview
- Requirements
- Installation
- Q&A: Deployment templates
- Release notes
- Azure deployment architecture
- Step 1: Preparing the Azure deployment
- Step 2: Deploying Automation Suite to Azure
- Step 3: Post-deployment steps
- Completing an upgrade
- 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
- B) 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 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
- 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
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite Support Bundle Tool
- Exploring Logs
Step 2: Deploying Automation Suite to Azure
Once you have the Azure environment set up, navigate to this link to install Automation Suite in your Azure environment.
The following table provides an overview of the parameters used in the deployment:
Parameter name |
Description |
---|---|
|
The Azure subscription. |
|
The Azure Resource Group, under the subscription. |
|
The name of the resource group where the cluster is deployed. |
|
The default region of the Resource Group. |
|
A valid Azure Region where the infrastructure is deployed. Make sure that the region has enough cores for the instance types used. You can use the
[resourceGroup().location] if this is the same as the Resource Group’s region.
|
|
The version of Automation Suite. Example:
21.10.2 |
|
Choose whether Automation Suite should be installed after the infrastructure is provisioned. |
|
By setting the parameter as true, you agree to the applicable license agreement. |
|
The prefix used for the load balancer subdomain. If you use a custom domain you will only be able to access the cluster through the custom domain, not directly using the load balancer's domain (eg. <prefix>.<region>.cloudapp.azure.com). |
|
Parameter indicating whether the Virtual Network used for the deployment should be created or if it already exists. |
|
Resource group where the existing Virtual Network you want to use is deployed. Parameter used only if the
Virtual Network New Or Existing parameter is set to existing .
|
|
Name of the existing Virtual Network used for deployment. Parameter used only if the
Virtual Network New Or Existing parameter is set to existing .
|
|
Name of an existing subnet inside the previously mentioned Virtual Network. The subnet must satisfy these requirements. Parameter used only if the
Virtual Network New Or Existing parameter is set to existing .
|
|
Deploy a Bastion Host on the Virtual Network. Parameter used only if Virtual Network New Or Existing is set to new. |
|
Set to
true if you want to use your own custom domain. The needs post-install configuration.
|
|
This is the domain you want to use for the cluster. Post-installation, create two CNAME/A records that will point to the public load balancer. See DNS configuration. |
|
Set to
true if you want to use your own custom certificates for your own domain. Make sure to use this together with the Enable Custom Domain parameter set to true .
|
|
This is a
base64 encoded string.
Encode the contents of the
.crt server certificate to a base64 string. The server certificate should have the following properties.
|
|
This is a
base64 encoded string.
Encode the contents of the
.key server certificate key, to a base64 string. This is the private key from the Custom Server Certificate parameter.
|
|
This is a
base64 encoded string.
Create a
.crt file containing all public certificates (.crt ) from all of the CA certificates in the Server Certificate chain (excluding the server certificate).
Create a
base64 string from the contents of this file.
|
|
Optional: The link to the Automation Suite installation package. Changing this parameter will overwrite the
Automation Suite version parameter above and install the version specified in this URL.
Keep set to
None if not used.
|
|
This is a valid
json string that will be merged in the cluster_config.json file that is being built by the template. Will overwrite existing settings.
See advanced installation experience for details. |
|
The number of VMs created to work as the servers for the cluster. Should be an odd number. |
|
The instance type for the server nodes. Example:
Standard_D16s_v3 |
|
Server node hostname/computer name prefix. For details on the appended sequence, see Azure documentation. |
|
Enable to use ultra disks for
etcd (server nodes). Should only be disabled if the region you are deploying to does not have zones support.
|
|
The number of VMs created to serve as the agent nodes for the cluster. If 0, an empty agent scale set is still created. |
|
The instance type for the agent nodes. Example:
Standard_D16s_v3 |
|
Agent node hostname/computer name prefix. For details on the appended sequence, see Azure documentation. |
|
The number of VMs with GPU created to be the agents for the cluster. Designed for ML workloads. If 0, no GPU scale set is created. |
|
The type of instances with GPU to be provisioned and to be the agents for the cluster. Example:
Standard_NC12s_v2 |
|
GPU node hostname/computer name prefix. For details on the appended sequence, see Azure documentation. |
|
Optional: Instance type of the task mining node. This will only be used if you enable the Task Mining service. Example:
Standard_B20ms |
|
Task Mining node hostname/computer name. |
|
The number of dedicated Automation Suite Robots nodes. If 0, the scale set is still created. |
|
The instance type for the dedicated Automation Suite Robots nodes. Example:
Standard_D16s_v3 |
|
Automation Suite Robots node hostname/computer name prefix. For details on the appended sequence, see Azure documentation. |
|
Parameter indicating whether the SQL Server used for the deployment should be created or it already exists. For SQL server requirements, see our documentation . |
|
FQDN or IP associated with the SQL Server. This is only used if the
SQLNewOrExisting parameter is set to existing .
|
|
SQL Server user login. If the
SQL new or existing parameter is set to existing , this is the user for the existing SQL server. Otherwise, this username will be set on the SQL server created. For details
on the required permissions, see our documentation for permissions.
|
|
SQL Server user password. If the
SQL new or existing parameter is set to existing , this is the user password for the existing SQL server. Otherwise, this password is set on the created SQL server.
|
|
SQL Server port. If the
SQLNewOrExisting parameter is set to existing , this port is used.
|
|
FQDN or IP associated with the Warehouse SQL Server. This is only used if the
SQLNewOrExisting parameter is set to existing , and you want to install Process Mining.
|
|
Warehouse SQL Server user login. This is only used if you want to install Process Mining. If the
SQLNewOrExisting parameter is set to existing , this is the user for the existing SQL server. Otherwise this username is set on the created SQL Server. For details on permissions,
see Configuring Microsoft SQL server.
|
|
Warehouse SQL Server user password. This is only used if you want to install Process Mining. If the
SQLNewOrExisting parameter is set to existing , this is the user password for the existing SQL server. Otherwise this password is set on the created SQL server.
|
|
Warehouse SQL Server port. This is only used if you want to install Process Mining. If the
SQLNewOrExisting parameter is set to existing , this port is used.
|
|
The admin username to be set on all nodes. This is also used as the host tenant admin. |
|
The password for the node admin user. This is also used as the host tenant admin password. |
|
The admin username to be used in the virtual machine instances. |
|
The admin password to be used in the virtual machine instances. |
|
Set to
true if you want to deploy the external NFS file share. Also, the backup will be enabled at cluster level if the Run Automation Suite Install parameter is set to true .
|
|
Choose if the specific service is installed in the cluster. |
|
Flag which determines whether AI Center connects to an external Orchestrator. Only works if
AiCenterInstallFlag is set to 'true'. You need to specify how AI Center connects to the Orchestrator in the following parameters.
|
|
The URL for Orchestrator to which AI Center connects. Fill this in only if you want to install AI Center and connect it to an external Orchestrator and Identity Service. |
|
The URL for the Identity Service to which AI Center connects. Fill this in only if you want to install AI Center and connect it to an external Orchestrator and Identity Service. |
|
The Certificate in Base64 for the Orchestrator to which AI Center connects. Fill this in only if you want to install AI Center and connect it to an external Orchestrator and Identity Service. |
|
The Certificate in Base64 for the Identity Service to which AI Center connects. Fill this in only if you want to install AI Center and connect it to an external Orchestrator and Identity Service. |
|
Optional: Tags per resource. Can be empty or have the following format: |