Backup Restoration Guide

The Bueno Edge Gateway automatically generates a backup and uploads it to the Bueno Cloud on a monthly basis. In the event of an unrecoverable issue with an existing installation, it may be necessary to restore the BEG to a previously working version. There are two scenarios to consider when restoring from a backup file.

note

The restoration method is only available via the API at this point in time. Replace BUENO_API_HOST with your respective API domain in the commands below.

Restoring on the existing BEG device

If the BEG device is still accessible and you want to restore to a previous backup version:

On your Bueno Web App, navigate to Deployments > Devices and copy the ID of your Gateway Device.
Identify the backup file you wish to restore via a GET request endpoint:
```
https://BUENO_API_HOST/v2/gateways/{yourGatewayId}/backup
```
Copy the ID of the backup file you wish to restore and download the file via the following GET request endpoint:
```
https://BUENO_API_HOST/v2/gateways/{yourGatewayId}/backup/{yourBackupFileId}
```

Spin down the existing service.

sudo docker compose -f /opt/bueno/odyssey/docker-compose.yaml down

Located in your Installer folder is a script named "restore-backup.sh". If the script does not exist, re-download the installer. Navigate to the directory and execute the following:
```
sudo bash restore-backup.sh
```
You will be prompted to confirm your restoration.
Type in the file path of your backup file.

Start the service.

sudo docker compose -f /opt/bueno/odyssey/docker-compose.yaml up -d

Restoring on a new BEG device

If you are replacing the BEG device or the device is no longer accessible and you want to restore to a previous backup version:

Run the Installer from start to finish. However, the BEG must have a unique name.
Referencing the existing BEG ID, follow the same steps as outlined in the existing BEG device scenario.
The new BEG will have a different Gateway ID and not be configured for the existing integration. Navigate to Deployments > Integration.
Select the associated Organisation, search for your existing Integration, select Settings and copy the ID located on the top right of the page.

Get your integration configuration via the following GET request endpoint:

https://BUENO_API_HOST/v2/integrations/{integrationId}

An example output should look as follows:

{
  "id": "Integration Id",
  "name": "Your Integration Name",
  "organisationId": "Organisation Id",
  "timezone": "Australia/Sydney"
}

Update your integration configuration via the following PUT request endpoint with the updated payload:

https://BUENO_API_HOST/v2/integrations

Add a "gatewayId" field to the payload with your new Gateway ID:

{
  "id": "Integration Id",
  "name": "Your Integration Name",
  "organisationId": "Organisation Id",
  "gatewayId": "Your New Gateway ID",
  "timezone": "Australia/Sydney"
}

Restart the service.

sudo docker compose -f /opt/bueno/odyssey/docker-compose.yaml restart

Verify that your new gateway has access to the integration on the main Gateway Status page.

Restoring on the existing BEG device​

Restoring on a new BEG device​

Restoring on the existing BEG device

Restoring on a new BEG device