Backup/Restore

Instructions to backup and restore K2 On-Premises Portal data on your infrastructure.

Backup

The backups are taken regularly every night and are stored at the configured locations based on the deployment location.

  • Local VM deployment: Backups are moved to the backup target location configured in the topology_config.ini file.

  • AWS deployment: Backups are moved to the AWS S3 bucket configured in the topology_config.ini file.

Restore

This procedure outlines the process for restoring the backup in a new on-premises cluster.

Restore with selected backup file:

  • Download/Copy the backup file from the S3 bucket/backup directory and place it in the [installation-location]/k2cloud/backup-and-restore-utilities/ directory.

  • Navigate to the backup-and-restore-utilities directory using the following command.

    cd [installation-location]/k2cloud/backup-and-restore-utilities/
  • Trigger the restore script with the backup file name, using the following command.

    sudo bash restore_on_premises_data.sh [compressed-backup-file-name] 2>&1 | tee -a k2onprem_restore_output.txt
  • Verify the restore by logging into your K2 UI account and reviewing your historical data.

Restore with the latest backup file:

  • Prerequisites:

    • Local VM deployment: The configured backup location must be accessible and should contain the latest backup file.

    • AWS deployment: The configured AWS S3 bucket must be accessible from the EC2 instance and should contain the latest backup file.

  • Navigate to the backup-and-restore-utilities directory using the following command.

    cd [installation-location]/k2cloud/backup-and-restore-utilities/
  • Trigger the restore script, using the following command.

    sudo bash restore_on_premises_data.sh 2>&1 | tee -a k2onprem_restore_output.txt
    • Verify the restore by logging into your K2 UI account and reviewing your historical data.

Last updated

Was this helpful?