Backup & Restore

Backup Feature

How to Schedule a Backup

  1. Open the Settings menu.

  2. Navigate to the Backup section.

  3. Click on the + button.

  4. Then complete & save the form, here is an example:

There are two different types of backup available :

Type
Definition

Full Backup

Backup everything every time

Incremental Backup

Backup only the difference since the last backup

triangle-exclamation

Different scheduling options are available :

Option
Definition
Comments

Timezone

The schedule can be defined based on a different timezone

Defined by default, it will be current system timezone

Recurrence

Once

Defined by default , there is no recurrence selected

Every

Minute - Day - Month - Year

Expands

Expand the scope of the recurrence

Count Option

Number of backup

circle-info

If your server fails, reinstall the Nodeum software and restore your backup to resume data management activities.

Backup Feature - Manual Execution

How to execute a backup manually?

To initiate a manual backup or restore, execute the following shell script command:

/opt/nodeum/tools/backup_restore.sh

Parameter 1: f for full backup or i for incremental backup. Parameter 2: The path where the backup will be saved or where a restore operation will occur.

If an incremental backup is requested without an existing full backup, a full backup will be performed instead. Each incremental backup adds to the existing full backup, ensuring the backup remains restorable.

Example:

The nohup command and the & operator can be used to run a backup script as a background process. The output of the executed command is saved in the file nohup.out.

circle-info

The full backup overwrites the previous full backup, while the incremental backup adds only new or changed data to the folder.

Components Software

The Backup includes all of these components :

Components
Description

All databases

This includes SQL and NoSQL information: file catalog, metadata, task execution history.

S3 - Swift API Keys

Authentication Key Credentials of S3 and Swift storage provider.

Data enrichment API Keys

Authentication Key Credentials of Machine Learning provider.

Tasks execution log reports

History of each files processed per task.

Licence Key

Nodeum Encrypted License Key

Restore

How to execute a restore manually ?

To restore a backup, execute the following command line.

param1 : r for restore

param2 : source path where the backup is located

Example:

The "nohup" command and "&" symbol allow running a backup script in the background. The output of the executed command is saved in a file named "nohup.out".

Important Note

Temporary Folder Usage: By default, the script utilizes a temporary folder located at /tmp/bckp/ on the main file system for storing backups before they are moved to their final destination. You can specify a different folder as the third argument to customize this location.

Example: In this scenario, the backup will be stored in the /nas/backupnodeum/ directory, and the system will use /tmp/ as a temporary cache.

Backup Configuration

In this example, the backup will be stored in the directory /nas/backupnodeum/. The system will use /mnt/CACHE/tempbck as a temporary cache during the backup process.

Troubleshooting Backup Process Not Starting

If your backup process does not start and the console shows a message indicating that a backup_restore.sh script is already running, follow these steps:

  1. Check for Running Processes:

    • Use the command ps -aef to determine if another process is currently executing.

  2. Check for Lock File:

    • It is possible that a lock file named nodeum_bkp_lock exists, stored in the /tmp directory, even if the temporary folder location has been modified.

Verify these two aspects to resolve the issue.

Last updated

Was this helpful?