automation-suite
2024.10
false
- Overview
- Requirements
- Pre-installation
- Installation
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite
- 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
- Migrating from Automation Suite on EKS/AKS to Automation Suite on OpenShift
- 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 creation
- Troubleshooting
- The backup setup does not work due to a failure to connect to Azure Government
- Pods in the uipath namespace stuck when enabling custom node taints
- Unable to launch Automation Hub and Apps with proxy setup
- Robot cannot connect to an Automation Suite Orchestrator instance
- Log streaming does not work in proxy setups
- Velero backup fails with FailedValidation error
- Accessing FQDN returns RBAC: access denied error
Automation Suite on EKS/AKS installation guide
Last updated Mar 31, 2026
Configuring the backup store
Providing the backup store configuration
To back up and restore your cluster, you must provide the location of the cluster snapshots to the Automation Suite cluster via input.json.
Make the following changes to your input.json before enabling a scheduled backup or taking an on-demand backup. Follow either the EKS or AKS configuration described in the following sections, as applicable.
You can provide this information during the installation of the Automation Suite cluster or later, as a post-installation operation, while enabling or taking the backup of the cluster.
EKS
input.json sample
"snapshot": {
"enabled": true,
"external_object_storage": {
"bucket_name": "<s3_bucket_used_for_backup>",
"storage_type": "s3",
"region": "<s3_bucket_region>"
}
}
"snapshot": {
"enabled": true,
"external_object_storage": {
"bucket_name": "<s3_bucket_used_for_backup>",
"storage_type": "s3",
"region": "<s3_bucket_region>"
}
}
input.json parameters
| Key | Value |
|---|---|
bucket_name | The name of the S3 bucket for storing the snapshot |
arn | ARN for connecting with the S3. If the node has the necessary permissions to connect to the backup objectstore, then the ARN is not needed. Otherwise, make sure to create an IAM role with the necessary permissions and add the ARN. |
region | The region where the S3 is present. |
AKS
input.json sample
"snapshot" : {
"external_object_storage": {
"client_secret": "<azure_service_principal_client_secret>",
"resource_group": "<azure_resource_group_with_storage_account>",
"auth_mode": "ServicePrincipal",
"account_name": "<azure_storage_account_name>",
"account_key": "<azure_storage_account_key>"
"bucket_name": "<azure_container_name>",
"client_id": "<azure_service_principal_id>",
"subscription_id": "<azure_subscription_id>",
"cloud_name": "AzurePublicCloud",
},
"aks_infra_resource_group":"<azure_infra_resource_group>"
}
"snapshot" : {
"external_object_storage": {
"client_secret": "<azure_service_principal_client_secret>",
"resource_group": "<azure_resource_group_with_storage_account>",
"auth_mode": "ServicePrincipal",
"account_name": "<azure_storage_account_name>",
"account_key": "<azure_storage_account_key>"
"bucket_name": "<azure_container_name>",
"client_id": "<azure_service_principal_id>",
"subscription_id": "<azure_subscription_id>",
"cloud_name": "AzurePublicCloud",
},
"aks_infra_resource_group":"<azure_infra_resource_group>"
}
input.json parameters
| Key | Value |
|---|---|
bucket_name | Name of the container in Azure Storage Account for storing the snapshot |
resource_group | Resource group in which the target Azure Storage Account for storing snapshot is present. |
auth_mode | Must be set to ServicePrincipal |
client_id | Client ID for service principal authentication |
client_secret | Client Secret for the service principal-based authentication |
account_name | Name of the Azure Storage Account where the snapshot is backed up |
account_key | Access key for Azure Storage Account where snapshot needs to be backed up. This parameter is optional and is supported starting with Automation Suite 2024.10.5. |
cloud_name | Default value AzurePublicCloud Change to one of the followin,g as applicable: AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud |
subscription_id | Subscription ID where the Azure Storage Account for storing backup is stored. |
aks_infra_resource_group | Resource group where the machines and other resources for the AKS cluster are created. This is usually made and managed by Azure and starts with MC_ While other values can remain the same during backup and restore, this value will be changed during restoration. This must be the new Resource Group where the Kubernetes resources of the new AKS cluster are provisioned. |
Note:
To create a service principal for authentication in azure, see Microsoft documentation.
Applying the backup store configuration
After making the changes to the input.json, as described in the previous section, run the following command to apply the configuration:
./uipathctl manifest apply input.json --only velero --versions versions.json
./uipathctl manifest apply input.json --only velero --versions versions.json