Database Backup

The backup of the database server stores the information of the following entities:

• hardware

• license

• tasks executed

• device count

• users

The API Server stores the backup of the database server. However, you can also configure a remote SFTP server to store them.

Cronjob (job scheduler) manages the backup on both the servers by updating the data every day at midnight (UTC).

Create a Database Backup

1. Log into the API server as cmdr-admin.

2. Enter the following command to create a backup:

   db-backup

The database backup is stored in the DC_BACKUP_<date_of_the_backup_taken>.tar.gz format. For example: DC_BACKUP_20191212.tar.gz

If you take more than one backup in a single day, the latest backup overrides the previous backup.

Restore a Database Backup

1. Log into the API server as cmdr-admin.

2. Go to the arangodbbackup directory using:

   cd /opt/commander/bigstore/directorconsole/arangodbbackup

3. Restore a backup using:

   db-restore <date_of_the_backup_taken>

   Here, <date_of_the_backup_taken> must be in YYYYMMDD format. For example: db-restore 20191201

4. Enter the database backup number you want to restore.

   • Every time you execute db-restore, the Director Console UI restarts.

   • You can also restore the backups taken from the Director Console UI in the API by entering the required backup number.

   

Configure SFTP in Director Console API

Configuring Secure File Transfer Protocol (SFTP) allows you to store your backups in a remote SFTP server. This gives you access to the backup files even after the API server deletes them.

Once you install Director Console using the install-dc command, you can configure SFTP next. You can also configure SFTP any time after installing Director Console using the following command in Director Console API as cmdr-admin:

sftp-configure

1. Enter the SFTP server IP Address.

2. Enter the User Name and the Password for the SFTP server.

3. Click Submit.

4. Click OK.

   Configuring SFTP in the API server updates the SFTP configuration in the Director Console UI, and vice-versa.