From 3b430eb6042cb7f010d3e420d47c8000328dda6b Mon Sep 17 00:00:00 2001
From: Joshua Kraitberg <joshua.kraitberg@windriver.com>
Date: Tue, 21 Mar 2023 09:23:43 -0400
Subject: [PATCH] Add alarm for Restore in progress

Currently, there is no alarm for Restore in progress.
Because of this, the system is shown as healthy,
before restore has been completed.

This new alarm will prevent the system from being healthy
until restore has properly been completed.

TEST PLAN
PASS: On any available system, the following commands can
be triggered at anytime:
* Run "system restore-start" to trigger alarm
* Run "system restore-complete" to clear alarm

Story: 2010117
Task: 47689
Signed-off-by: Joshua Kraitberg <joshua.kraitberg@windriver.com>
Change-Id: I292b5c8083c08b68ac757fe5a650989178eb819f
---
 fm-api/source/fm_api/constants.py |  1 +
 fm-doc/fm_doc/events.yaml         | 16 ++++++++++++++++
 2 files changed, 17 insertions(+)

diff --git a/fm-api/source/fm_api/constants.py b/fm-api/source/fm_api/constants.py
index 9e120824..a036c57b 100755
--- a/fm-api/source/fm_api/constants.py
+++ b/fm-api/source/fm_api/constants.py
@@ -83,6 +83,7 @@ FM_ALARM_ID_CEPH_CACHE_TIER_CONFIG_OUT_OF_DATE = ALARM_GROUP_SYSCONFIG + ".002"
 
 # Backup/Restore Alarm id
 FM_ALARM_ID_BACKUP_IN_PROGRESS = ALARM_GROUP_BACKUP_RESTORE + ".001"
+FM_ALARM_ID_RESTORE_IN_PROGRESS = ALARM_GROUP_BACKUP_RESTORE + ".002"
 
 # Backup/Restore Log id
 FM_LOG_ID_RESTORE_COMPLETE = ALARM_GROUP_BACKUP_RESTORE + ".101"
diff --git a/fm-doc/fm_doc/events.yaml b/fm-doc/fm_doc/events.yaml
index 72c9fdbf..c6bed6f7 100755
--- a/fm-doc/fm_doc/events.yaml
+++ b/fm-doc/fm_doc/events.yaml
@@ -892,6 +892,22 @@
     Degrade_Affecting_Severity: none
     Context: starlingx
 
+210.002:
+    Type: Alarm
+    Description: System Restore in progress.
+    Entity_Instance_ID: host=controller
+    Severity: minor
+    Proposed_Repair_Action: Run 'system restore-complete' to complete restore if running restore manually.
+    Maintenance_Action:
+    Inhibit_Alarms:
+    Alarm_Type: operational-violation
+    Probable_Cause: unspecified-reason
+    Service_Affecting: False
+    Suppression: False
+    Management_Affecting_Severity: warning
+    Degrade_Affecting_Severity: none
+    Context: starlingx
+
 
 #---------------------------------------------------------------------------
 #   SYSTEM CONFIGURATION