{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Applies to","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Enterprise ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-cross_mark","text":":cross_mark:","shortName":":cross_mark:"}},{"text":" Kyvos Cloud (SaaS on AWS) ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-cross_mark","text":":cross_mark:","shortName":":cross_mark:"}},{"text":" Kyvos AWS Marketplace","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-cross_mark","text":":cross_mark:","shortName":":cross_mark:"}},{"text":" Kyvos Azure Marketplace ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-cross_mark","text":":cross_mark:","shortName":":cross_mark:"}},{"text":" Kyvos GCP Marketplace ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-cross_mark","text":":cross_mark:","shortName":":cross_mark:"}},{"text":" Kyvos Single Node Installation (Kyvos SNI) ","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"This section provides information on managing a periodic backup of bundled Postgres repositories for Kyvos Manager and Kyvos. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#374151"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Kyvos Manager bundled repository ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Kyvos bundled repository ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Kyvos Manager bundled repository ","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"To manage the periodic backup of the Kyvos Manager database, use the ","type":"text"},{"text":"Kyvos.json","type":"text","marks":[{"type":"strong"}]},{"text":" configuration file. This file is located in the ","type":"text"},{"text":"kyvosmanagerdata/server/repo/metadata.Kyvos/","type":"text","marks":[{"type":"strong"}]},{"text":" folder.","type":"text"}]},{"type":"panel","attrs":{"panelIconId":"atlassian-note","panelIcon":":note:","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To apply changes made in the configuration file, you must restart Kyvos Manager. ","type":"text"}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Kyvos Manager periodic backup configurations","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"\"dbBackupPreferences\": {\n \t\"kyvosmanager\": {\n \t \t\"enable\": true,\n \t \t\"hours\": [0, 6, 12, 18]\n \t }\n }","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1204.0,"localId":"af196886-ceb9-40ff-8041-840cac3311fa"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"Key ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[497.0]},"content":[{"type":"paragraph","content":[{"text":"Description ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"Possible values ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[243.0]},"content":[{"type":"paragraph","content":[{"text":"Default values ","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"enable","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[497.0]},"content":[{"type":"paragraph","content":[{"text":"It is used to specify whether the Kyvos Manager database should be backed up periodically or not.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"true or false","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"True: The Kyvos Manager database will be backed up periodically. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"False: The Kyvos Manager database will not be backed up periodically.","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[243.0]},"content":[{"type":"paragraph","content":[{"text":"true ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"hours","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[497.0]},"content":[{"type":"paragraph","content":[{"text":"It is used to specify at what hour of the day should the Kyvos Manager database backup be attempted.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Multiple values from the range of 0 to 23 are allowed. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Any invalid values outside this range will be ignored. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An attempt will be made at the 0th minute of the configured hour.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"Any number (whole numbers only) between 0 to 23 upper and lower bounds included i.e. [0-23]","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[243.0]},"content":[{"type":"paragraph","content":[{"text":"[0, 6, 12, 18]","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"You can verify the following Kyvos Manager database periodic backup logs in ","type":"text"},{"text":"kyvosmanager. logs ","type":"text","marks":[{"type":"strong"}]},{"text":"file.","type":"text"}]},{"type":"codeBlock","content":[{"text":"Kyvos Manager database periodic backup started at \n database dump creation started at \n database dump creation ended at \nTotal time taken for database dump creation (Difference between started time and end time in format HH:MM:SS)\nKyvos Manager database periodic backup ended at \nTotal time taken for Kyvos Manager database periodic backup (Difference between started time and end time in format HH:MM:SS)\nKyvos Manager database periodic backup perform successfully/failed","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Kyvosbundledrepo"},"legacyAnchorId":{"value":"PeriodicbackupofbundledRepositories-Kyvosbundledrepo"}},"macroMetadata":{"macroId":{"value":"a370b9bf-c8d3-4183-9bb3-3228b5d4e6f2"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"b4a65a8d-41b2-49b2-9122-20ecef70ec30"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Kyvos bundled repository","type":"text"}]},{"type":"paragraph","content":[{"text":"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. ","type":"text"},{"text":"For any further assistance, please contact Kyvos Support.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#161719"}}]}]},{"type":"paragraph","content":[{"text":"Sample cronjob entry format to enable Kyvos Postgres periodic backup ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#161719"}}]}]},{"type":"panel","attrs":{"panelIconId":"atlassian-note","panelIcon":":note:","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"For backup after each 6-hour, do the following: ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"0 */6 * * * /bin/kyvos-pg-backup.sh","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"For backup after each 4 hours, do the following: ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"0 */4 * * * /bin/kyvos-pg-backup.sh","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"For backup at a specific hour, for example, at 11:00 AM, do the following: ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"0 11 * * * /bin/kyvos-pg-backup.sh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"paragraph","content":[{"text":"Sample cronjob entry format to disable Kyvos Postgres periodic backup ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#161719"}}]}]},{"type":"panel","attrs":{"panelIconId":"atlassian-note","panelIcon":":note:","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To disable ","type":"text"},{"text":"Kyvos Postgres periodic backup, a","type":"text","marks":[{"type":"textColor","attrs":{"color":"#161719"}}]},{"text":"dd (","type":"text"},{"text":"#","type":"text","marks":[{"type":"strong"}]},{"text":") at the first column before the entry line. ","type":"text"}]},{"type":"paragraph","content":[{"text":"#0 */6 * * * /bin/","type":"text","marks":[{"type":"strong"}]},{"text":"kyvos","type":"text","marks":[{"type":"underline"},{"type":"strong"}]},{"text":"-","type":"text","marks":[{"type":"strong"}]},{"text":"pg","type":"text","marks":[{"type":"underline"},{"type":"strong"}]},{"text":"-backup.sh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelIconId":"atlassian-note","panelIcon":":note:","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To check the existing configured value, enter the command ","type":"text"},{"text":"crontab -l","type":"text","marks":[{"type":"strong"}]},{"text":" in the terminal of the Kyvos cluster node that has a Postgres role.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"You can verify the following Kyvos database periodic backup logs in the ","type":"text"},{"text":"backup.out","type":"text","marks":[{"type":"strong"}]},{"text":" file located at ","type":"text"},{"text":"/postgres/data/pg_log/","type":"text","marks":[{"type":"strong"}]},{"text":" for the logs of ","type":"text"},{"text":"kyvos-pg-backup.sh","type":"text","marks":[{"type":"strong"}]},{"text":" script. E","type":"text"},{"text":"nsure that this is checked specifically on the cluster node that has the Postgres role assigned to it.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#161719"}}]}]},{"type":"codeBlock","content":[{"text":"===START===\nBackups script started at \nKyvos database dump creation started at \nKyvos database dump creation ended at \nTotal time taken for backup = 00:00:01 (HH:MM:SS)\n \nBackups script ended at \nTotal time taken for script execution = 00:00:01 (HH:MM:SS)\n===END===","type":"text"}]}],"version":1}