VMmanager: Administrator guide
Documentation
/
VMmanager: Administrator guide
/
Backups
/
Creating platform backups

Creating platform backups

You can create a backup copy of VMmanager that contains all the settings of the platform. The backup copy is saved in .tar archive format and contains the following files:

  • config.json — platform configuration file;
  • docker-compose.yaml — Docker configuration file;
  • vm_dump.sql — platform database dump file.

Copy names have the format YYYY_MM_DD__HH_MM.tar.gz.

Comments
Note
The backup copy does not contain virtual machine or cluster node statistics.

You configure scheduled creation of platform backups and exporting them to an external storage. A physical or virtual server with access via SSH or FTP can be used as a storage. In addition, the five latest backups of the platform are saved on the server with VMmanager in the /opt/ispsystem/vm/backup/ directory.

Backup creation and restoring from backup are performed by the vm platform installation service. If VMmanager is not installed or damaged on the server to be recovered, the service will install the platform and then restore data from the backup.

After restoring from a backup, activate the platform license. For Infrastructure version, activation has to be performed within seven days after the restore. After this period expires, the platform will be blocked.

Creating backups

In the console

  1. Connect to VMmanager server via SSH and enter the command:

    vm backup
  2. Enter the password for the backup archive or press Enter to create an archive without a password.

The copy will be saved to /opt/ispsystem/vm/backup/.

In the platform interface

Configure the platform backup creation schedule to create copies automatically. Enter   → Database backup → Add schedule:

  1. Select when to Make copies:
    • Daily;
    • Weekly → select the day;
    • Monthly → enter the date from 1 to 28 → Apply;
    • enter the time in the cron scheduler format. For example, 15 10 * * 0 — create backups on Sundays at 10:15 UTC or 00 12 1,16 * * — create backups on the 1st and 16th of the month at 12:00 UTC.
  2. Enter the UTC time at which platform will start backup creation.
  3. Specify the schedule Name. By default, platform creates a schedule with the name corresponding to the schedule settings. For example, "Daily at 0:00 through SSH".
  4. Specify the discretionary Note to the schedule.
  5. Select the storage for backups:
    • external storage with connection through SSH;

    • external storage with connection through FTP;

      Note
      Platform will not be able to save a backup if the FTP server has an invalid SSL certificate.

    • Locally — the backup will be created at the server with platform.

      Note
      We recommend saving backups to an external storage, because in case of problems with the platform server, the backup files may be damaged.

  6. If you use an external storage, specify its settings:

    1. IP address or domain name;
    2. Port;
    3. Login;
    4. Password or press I want to use public SSH-key to configure an SSH key connection;
    5. Storage path — the directory on the server to which platform will save backups.
  7. Press Add.

Example of schedule settings


You can manage the created schedules through the   menu in Settings → Database backup. Possible actions with schedule:

  • Run the schedule — start backup creation process immediately;
  • Edit — change the schedule; 
    If you change the schedule, you need to re-enter the password to the FTP or SSH server.
  • Enable/Disable;
  • Note — add note;
  • Delete.

Also in this section you can download the last five backups.

 


Database backup section


Recovery from a backup

If VMmanager is not installed on the server

  1. Generate a new token in your client area eu.ispsystem.com.
  2. Connect to the server via SSH.
  3. Update the operating system to the latest stable version.
  4. If tar archiver or curl utility are not installed on the system, install them.

  5. Download the installer:

    curl -O https://download.ispsystem.com/6/installer/vm/vm

  6. Make the installer file executable:

    chmod +x vm

     

  7. Create the directory /opt/ispsystem/license/: 

    mkdir -p /opt/ispsystem/license

  8. Start the recovery:

    ./vm restore -b=<backup_file>
    Comments to the command
  9. If necessary, enter the backup archive password.
  10. If the server's domain name has changed: 
    1. Specify the new domain name in the DomainName parameter of the /opt/ispsystem/vm/config.json file.
    2. Restart the platform:
      vm stop && vm start

  11. Activate the license:

    1. In VMmanager interface, go to → System information.

    2. In the License key field enter the value of the license token.
    3. Click the Activate button.

If VMmanager is installed on the server

  1. Generate a new token in your client area eu.ispsystem.com.
  2. Connect to the server via SSH.
  3. Update the operating system to the latest stable version.
  4. If the tar archiver is not installed on the system, install it.

  5. Start the recovery:

    vm restore -b=<backup_file>
    Comments to the command
  6. If necessary, enter the backup archive password.

  7. Go to the directory with the license files: 

    cd /opt/ispsystem/license

  8. Delete all files from the directory except machine_id: 

    rm -v !("machine_id")
  9. If the server's domain name has changed: 
    1. Specify the new domain name in the DomainName parameter of the /opt/ispsystem/vm/config.json file.
    2. Restart the platform:
      vm stop && vm start

  10. Activate the license:

    1. In VMmanager interface, go to → System information.

    2. In the License key field enter the value of the license token.
    3. Click the Activate button.