automation-suite
2021.10
false
Automation Suite installation guide
- 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
- Post-installation
- Cluster administration
- Monitoring and alerting
- Migration and upgrade
- 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 disable TLS 1.0 and 1.1
- 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 debug failed Automation Suite installations
- How to disable TX checksum offloading
- 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
- Failure After Certificate Update
- Automation Suite Requires Backlog_wait_time to Be Set 1
- Cannot Log in After Migration
- Setting a timeout interval for the management portals
- Update the underlying directory connections
- 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 With Error: An Invalid Status Code Was Supplied (Client's Credentials Have Been Revoked).
- Login Failed for User <ADDOMAIN><aduser>. Reason: The Account Is Disabled.
- Alarm Received for Failed Kerberos-tgt-update Job
- SSPI Provider: Server Not Found in Kerberos Database
- 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
- Missing Self-heal-operator and Sf-k8-utils Repo
- Degraded MongoDB or Business Applications After Cluster Restore
- Unhealthy Services After Cluster Restore or Rollback
- Using the Automation Suite Diagnostics Tool
- Using the Automation Suite support bundle
- Exploring Logs
Step 2: Deploying Automation Suite to Azure
This page offers an overview of the parameters you need to use when 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 |
|---|---|
| Subscription | The Azure subscription. |
| Resource Group | The Azure Resource Group, under the subscription. |
| Region | The default region of the Resource Group. |
| Location | 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. |
| Automation Suite version | The version of Automation Suite. Example: 21.10.2 |
| Run Automation Suite Install | Choose whether Automation Suite should be installed after the infrastructure is provisioned. |
| Accept License Agreement | By setting the parameter as true, you agree to the applicable license agreement. |
| DNS Load Balancer | 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). |
| Virtual Network New Or Existing | Parameter indicating whether the Virtual Network used for the deployment should be created or if it already exists. |
| Existing Virtual Network Resource Group | 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. |
| Existing Virtual Network Name | Name of the existing Virtual Network used for deployment. Parameter used only if the Virtual Network New Or Existing parameter is set to existing. |
| Existing Subnet Name | 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 Bastion Host | Deploy a Bastion Host on the Virtual Network. Parameter used only if Virtual Network New Or Existing is set to new. |
| Enable Custom Domain | Please set to true if you want to use your own custom domain. The needs post-install configuration. |
| Custom domain | 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. |
| Enable Custom Certificates | 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. |
| Custom Server Certificate | 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. |
| Custom Server Cert Key | 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. |
| Custom Server Cert Authority Bundle | 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. |
| Automation Suite Installer URL | 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. |
| Automation Suite Advanced Config | 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. |
| Server Node Count | The number of VMs created to work as the servers for the cluster. Should be an odd number. |
| Server Node Instance Type | The instance type for the server nodes. Example: Standard_D16s_v3 |
| Enable Ultra Disks | 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. |
| Agent Node Count | The number of VMs created to serve as the agent nodes for the cluster. If 0, an empty agent scale set is still created. |
| Agent Node Instance Type | The instance type for the agent nodes. Example: Standard_D16s_v3 |
| Gpu Node Count | 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. |
| Gpu Node Instance Type | The type of instances with GPU to be provisioned and to be the agents for the cluster. Example: Standard_NC12s_v2 |
| SQL new or existing | Parameter indicating whether the SQL Server used for the deployment should be created or it's already existing. Please see here for SQL server requirements. |
| SQL Server FQDN or IP | FQDN or IP associated with the SQL Server. This is only used if the SQLNewOrExisting parameter is set to existing. |
| SQL Admin Username | SQL Server user login. If the SQLNewOrExisting 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 Admin Password | SQL Server user password. If the SQLNewOrExisting parameter is set to existing, this is the user password for the existing SQL server. Otherwise, this password will be set on the created SQL server. |
| UiPath Admin Username | The admin username to be set on all nodes. This is also used as the host tenant admin. |
| UiPath Admin Password | The password for the node admin user. This is also used as the host tenant admin password. |
| Vm Admin Username | The admin username to be used in the virtual machine instances. |
| Vm Admin Password | The admin password to be used in the virtual machine instances. |
| Services Install flags (multiple) | Choose if the specific service is installed in the cluster. |
| Tags by resource | [OPTIONAL] Tags per resource. Can be empty or have the following format: { "Microsoft.Web/serverFarms": { "<TagName>": "<TagValue>" }, "Microsoft.Insights/components": { "<TagName>": "<TagValue>" } } |