diff --git a/doc/source/backup/kubernetes/backing-up-starlingx-system-data.rst b/doc/source/backup/kubernetes/backing-up-starlingx-system-data.rst index 28183651b..3888227ee 100644 --- a/doc/source/backup/kubernetes/backing-up-starlingx-system-data.rst +++ b/doc/source/backup/kubernetes/backing-up-starlingx-system-data.rst @@ -198,6 +198,16 @@ Recommended Backup and Retention Policies backups can be performed locally or remotely, and the archive must be stored off the system. +- Backups are not allowed till the system is healthy (this excludes non-management + affecting alarms). However, a new parameter ``-e ignore_health=true`` can be + added in the ansible playbook to ignore system health and force the backup + to proceed. + + .. warning:: + + Using the ``-e ignore_health=true`` option should be avoided unless + it is required. Restoring an unhealthy backup will result in system issues. + - All backups are done during off-peak hours (i.e. maintenance window). - Weekly backups should be performed under normal steady state conditions to