From a66b06ffbed91793743ca1a9174649e2e7e4b30d Mon Sep 17 00:00:00 2001
From: junfeng-li <junfeng.li@windriver.com>
Date: Mon, 18 Mar 2024 15:31:26 +0000
Subject: [PATCH] Create deploy state out of sync alarm

This new alarm is raised when the controllers deploy
state is out of sync during the deployment.

Test Plan:

PASS: alarm raised when the deploy state is out of sync
PASS: alarm cleared when the deploy state is in sync

Task: 123456
Story: 2010676
Change-Id: Ibdcc54f02c9e156b2b78313b527cd273a62425f1
Signed-off-by: junfeng-li <junfeng.li@windriver.com>
---
 fm-api/source/fm_api/constants.py |  3 +++
 fm-doc/fm_doc/events.yaml         | 16 ++++++++++++++++
 2 files changed, 19 insertions(+)

diff --git a/fm-api/source/fm_api/constants.py b/fm-api/source/fm_api/constants.py
index 54370124..fe74e845 100755
--- a/fm-api/source/fm_api/constants.py
+++ b/fm-api/source/fm_api/constants.py
@@ -365,6 +365,8 @@ FM_LOG_ID_SW_UPGRADE_AUTO_APPLY_ABORT_REJECTED = ALARM_GROUP_SW_MGMT + ".219"
 FM_LOG_ID_SW_UPGRADE_AUTO_APPLY_ABORT_FAILED = ALARM_GROUP_SW_MGMT + ".220"
 FM_LOG_ID_SW_UPGRADE_AUTO_APPLY_ABORTED = ALARM_GROUP_SW_MGMT + ".221"
 
+FM_ALARM_ID_SW_UPGRADE_DEPLOY_STATE_OUT_OF_SYNC = ALARM_GROUP_SW_MGMT + ".231"
+
 FM_ALARM_ID_FW_UPDATE_AUTO_APPLY_INPROGRESS = ALARM_GROUP_SW_MGMT + ".301"
 FM_ALARM_ID_FW_UPDATE_AUTO_APPLY_ABORTING = ALARM_GROUP_SW_MGMT + ".302"
 FM_ALARM_ID_FW_UPDATE_AUTO_APPLY_FAILED = ALARM_GROUP_SW_MGMT + ".303"
@@ -449,6 +451,7 @@ FM_ALARM_TYPE_7 = 'operational-violation'
 FM_ALARM_TYPE_8 = 'physical-violation'
 FM_ALARM_TYPE_9 = 'security-service-or-mechanism-violation'
 FM_ALARM_TYPE_10 = 'time-domain-violation'
+FM_ALARM_TYPE_11 = 'deployment in progress'
 
 FM_ALARM_SEVERITY_CLEAR = 'clear'
 FM_ALARM_SEVERITY_WARNING = 'warning'
diff --git a/fm-doc/fm_doc/events.yaml b/fm-doc/fm_doc/events.yaml
index 57b5d513..b08ba21f 100755
--- a/fm-doc/fm_doc/events.yaml
+++ b/fm-doc/fm_doc/events.yaml
@@ -3944,6 +3944,22 @@
     Service_Affecting: False
     Context: starlingx
 
+900.231:
+    Type: Alarm
+    Description: Software deploy state out of sync
+    Entity_Instance_ID: orchestration=sw-upgrade
+    Severity: major
+    Proposed_Repair_Action: 
+    Maintenance_Action: Wait for the deployment on the active controller to complete. If problem persists contact next level of support
+    Inhibit_Alarms:
+    Alarm_Type: equipment
+    Probable_Cause: unspecified-reason
+    Service_Affecting: True
+    Suppression: False
+    Management_Affecting_Severity: warning
+    Degrade_Affecting_Severity: none
+    Context: starlingx
+
 900.301:
     Type: Alarm
     Description: Firmware Update auto-apply in progress