Periodic backup of bundled Repositories
- Sarabjeet Kaur
Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace
Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)
This section provides information on managing a periodic backup of bundled Postgres repositories for Kyvos Manager and Kyvos.
Kyvos Manager bundled repository
Kyvos bundled repository
Kyvos Manager bundled repository
To manage the periodic backup of the Kyvos Manager database, use the Kyvos.json configuration file. This file is located in the kyvosmanagerdata/server/repo/metadata.Kyvos/ folder.
Note
To apply changes made in the configuration file, you must restart Kyvos Manager.
Kyvos Manager periodic backup configurations
"dbBackupPreferences": {
"kyvosmanager": {
"enable": true,
"hours": [0, 6, 12, 18]
}
}Key | Description | Possible values | Default values |
|---|---|---|---|
enable | It is used to specify whether the Kyvos Manager database should be backed up periodically or not. | true or false
| true |
hours | It is used to specify at what hour of the day should the Kyvos Manager database backup be attempted.
| Any number (whole numbers only) between 0 to 23 upper and lower bounds included i.e. [0-23] | [0, 6, 12, 18] |
You can verify the following Kyvos Manager database periodic backup logs in kyvosmanager. logs file.
Kyvos Manager database periodic backup started at <Time Stamp>
<KM_DB_NAME> database dump creation started at <Time Stamp>
<KM_DB_NAME> database dump creation ended at <Time Stamp>
Total time taken for <KM_DB_NAME> database dump creation (Difference between started time and end time in format HH:MM:SS)
Kyvos Manager database periodic backup ended at <Time Stamp>
Total time taken for Kyvos Manager database periodic backup (Difference between started time and end time in format HH:MM:SS)
Kyvos Manager database periodic backup perform successfully/failedKyvos bundled repository
To enable the Kyvos bundled Postgres periodic backup, you must change the cron job entry for the backup interval in the cron job of Kyvos bundled Postgres periodic backup. Similarly, to disable the Kyvos bundled Postgres periodic backup, comment out the cronjob entry. For any further assistance, please contact Kyvos Support.
Sample cronjob entry format to enable Kyvos Postgres periodic backup
Note
For backup after each 6-hour, do the following:
0 */6 * * * <PG_HOME_DIR>/bin/kyvos-pg-backup.sh
For backup after each 4 hours, do the following:
0 */4 * * * <PG_HOME_DIR>/bin/kyvos-pg-backup.sh
For backup at a specific hour, for example, at 11:00 AM, do the following:
0 11 * * * <PG_HOME_DIR>/bin/kyvos-pg-backup.sh
Sample cronjob entry format to disable Kyvos Postgres periodic backup
Note
To disable Kyvos Postgres periodic backup, add (#) at the first column before the entry line.
#0 */6 * * * <PG_HOME_DIR>/bin/kyvos-pg-backup.sh
Note
To check the existing configured value, enter the command crontab -l in the terminal of the Kyvos cluster node that has a Postgres role.
You can verify the following Kyvos database periodic backup logs in the backup.out file located at <KYVOS_INSTALL_PATH>/postgres/data/pg_log/ for the logs of kyvos-pg-backup.sh script. Ensure that this is checked specifically on the cluster node that has the Postgres role assigned to it.
===START===
Backups script started at <Date and Time Stamp>
Kyvos database dump creation started at <Date and Time Stamp>
Kyvos database dump creation ended at <Date and Time Stamp>
Total time taken for backup = 00:00:01 (HH:MM:SS)
Backups script ended at <Date and time>
Total time taken for script execution = 00:00:01 (HH:MM:SS)
===END===Related content
Copyright Kyvos, Inc. All rights reserved.