automation-suite

false

Automation Suite on Linux installation guide

Last updated Nov 13, 2025

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 cluster_config.json.

Make the following changes to your cluster_config.json before enabling a scheduled backup or taking an on-demand backup.

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.

cluster_config.json example

For NFS server backup, use the following cluster_config.json sample:

{
 //... cluster_config.json
  "snapshot": {
    "enabled": true,
    "nfs": {
      "server": "nfs_server_endpoint",
      "location": "nfs_server_mountpoint"
    }
  }
}{
 //... cluster_config.json
  "snapshot": {
    "enabled": true,
    "nfs": {
      "server": "nfs_server_endpoint",
      "location": "nfs_server_mountpoint"
    }
  }
}

cluster_config.json parameters

Key	Value
`server`	The FQDN or the IP address of the snapshot storage location (such as `mynfs.mycompany.com` or `192.23.222.81`).
`location`	NFS Server path, which is the mount path created according to the instructions in Step 2: Configuring the mount path. Make sure that it has sufficient permissions and that the directory structure already exists. Note: Make sure that the NFS server is reachable from all nodes. As part of the next step, uipathctl mounts this path automatically. You do not need to mount this path manually. Important: When using Amazon EFS as NFS-compatible storage, you must set the `location` value to the root directory (`/`) of the EFS mount. Using subdirectories (such as `/asbackup`) is not supported and will cause the mount operation to fail.

Key

Value

server

The FQDN or the IP address of the snapshot storage location (such as mynfs.mycompany.com or 192.23.222.81).

location

NFS Server path, which is the mount path created according to the instructions in Step 2: Configuring the mount path. Make sure that it has sufficient permissions and that the directory structure already exists.

Note:

Make sure that the NFS server is reachable from all nodes.
As part of the next step, uipathctl mounts this path automatically. You do not need to mount this path manually.

Important:

When using Amazon EFS as NFS-compatible storage, you must set the location value to the root directory (/) of the EFS mount.

Using subdirectories (such as /asbackup) is not supported and will cause the mount operation to fail.

For external objectstore backup, use the following cluster_config.json samples:

{
//... cluster_config.json
"snapshot": {
    "enabled": true,
    "external_object_storage": {
      "bucket_name": "<s3_bucket_used_for_backup>",
      "storage_type": "s3",
      "region": "<s3_bucket_region>"
    }
  }
}{
//... cluster_config.json
"snapshot": {
    "enabled": true,
    "external_object_storage": {
      "bucket_name": "<s3_bucket_used_for_backup>",
      "storage_type": "s3",
      "region": "<s3_bucket_region>"
    }
  }
}

cluster_config.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.

{
//... cluster_config.json
"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>"
 }
}{
//... cluster_config.json
"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>"
 }
}

cluster_config.jsonparameters

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.
`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.

For local disk backup, use the following cluster_config.json sample:

{
 //... cluster_config.json
  "snapshot": {
    "enabled": true,
    "local_disk": {
      "path": "/backup"
    }
  }
}{
 //... cluster_config.json
  "snapshot": {
    "enabled": true,
    "local_disk": {
      "path": "/backup"
    }
  }
}

cluster_config.json parameters

Key	Value
`path`	Local directory for storing snapshots.

Applying the backup store configuration

After making the changes to the cluster_config.json, as described in the previous section, run the following command to apply the configuration:

For NFS server and local disk configurations:

./bin/uipathctl manifest apply cluster_config.json --only velero,rke2-backup-hook --versions versions/helm-charts.json
./bin/uipathctl manifest apply cluster_config.json --only velero,rke2-backup-hook --versions versions/helm-charts.json

For external objecstore configuration:

./bin/uipathctl manifest apply cluster_config.json --only velero --versions versions/helm-charts.json./bin/uipathctl manifest apply cluster_config.json --only velero --versions versions/helm-charts.json

On this page

Providing the backup store configuration
cluster_config.json example
Applying the backup store configuration

Was this page helpful?

PREVIOUSSetting up the external NFS server

NEXTBacking up the cluster

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy