Automation Suite on AKS Backup Store Fails to Configure with Error: "cannot update component velero: cannot execute helm installer"

Why does my the Automation Suite backup store fail to configure with the error "cannot update component velero: cannot execute helm installer: pod test-installer/install-velero-9vw9m terminated with exit code 1: (Error)"?

Issue Description:

When configuring the Automation Suite backup store on an Azure Kubernetes Service (AKS) cluster, you may encounter the following error after running the uipathctl command to apply the manifest:

cannot update component velero: cannot execute helm installer: pod uipath-installer/install-velero-9vw9m terminated with exit code 1: (Error)

This error occurs due to a misconfiguration in the 'snapshot' object of the 'input.json' configuration file.


Resolution:

To resolve this issue, follow these steps:

  1. Identify the Issue in the Configuration
    • Within the 'input.json' file, find the section that pertains to the snapshot settings ('snapshot'). Incorrect configurations in this section are often the cause of the error.
    • Correct the Snapshot Object Configuration: Ensure that all required fields within the snapshot object are correctly populated. Common fields include provider, bucket, prefix, and region. Please reference the documentation here for a full reference
    • Double-check the values for accuracy, particularly ensuring that the snapshot configuration aligns with the actual resources and permissions in your Azure environment.
      • NOTE: the field "enabled": true, must be present
  2. Update the Configuration:
    • After making the necessary corrections in the 'input.json', save the changes.
      • #Example working configuration for AKS
          "snapshot" : {
            "enabled": true,
            "external_object_storage": {
              "client_secret": "2uA8Q~oxT_qHayc9OaNiVSuoAJ9GrPe5ImLZUaq", 
              "resource_group": "asaksdevtest-rg", 
              "auth_mode": "ServicePrincipal", 
              "account_name": "asaksdevtest-sa", 
              "bucket_name": "uipath-backup-as",
              "subscription_id": "8c5214b0-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
              "storage_type": "azure",
              "client_id": "41666b23-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
              "cloud_name": "AzurePublicCloud"
            },
    • Re-run the uipathctl tool again
      • ./uipathctl  manifest apply input.json --only velero --versions versions.json
  3. Verify the Installation:
    • Once the installation or update completes successfully, verify that Velero is properly installed and configured by checking the status of Velero pods:
      • kubectl get pods -n velero
  4. Test the Backup:
    • Perform a test backup and check its status to ensure that the configuration changes have resolved the issue and Velero backup is operating as expected.
      • uipathctl snapshot backup create test-backup
      • uipathctl snapshot list