From 5e0f635c6bbaaf8d7434f2ede51a93b9006b85ef Mon Sep 17 00:00:00 2001
From: Heitor Matsui <heitorvieira.matsui@windriver.com>
Date: Tue, 23 Apr 2024 09:35:57 -0300
Subject: [PATCH] Define software deploy host alarms

This commit defines two new alarms to be used by USM during
the "deploy host" step, one for the success case and one for
the failure.

Test Plan
PASS: run "deploy host" successfully and verify the success alarm
      with "fm alarm-list"
PASS: run "deploy host" with failure and verify the failure alarm
      with "fm alarm-list"

Story: 2010676
Task: 49935

Change-Id: I9d02b1df5733180f489d1378e0b7c5d8c8e3d1b9
Signed-off-by: Heitor Matsui <heitorvieira.matsui@windriver.com>
---
 fm-api/source/fm_api/constants.py |  4 ++++
 fm-doc/fm_doc/events.yaml         | 32 +++++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+)

diff --git a/fm-api/source/fm_api/constants.py b/fm-api/source/fm_api/constants.py
index 3b37c39f..0d4dbdab 100755
--- a/fm-api/source/fm_api/constants.py
+++ b/fm-api/source/fm_api/constants.py
@@ -318,6 +318,10 @@ FM_ALARM_ID_SYSTEM_CONFIG_UPDATE_IN_PROGRESS = ALARM_GROUP_SW_MGMT + ".010"
 # System Config Update abort alarm id
 FM_ALARM_ID_SYSTEM_CONFIG_UPDATE_ABORTED = ALARM_GROUP_SW_MGMT + ".011"
 
+# USM alarm ids
+FM_ALARM_ID_USM_DEPLOY_HOST_SUCCESS_RR = ALARM_GROUP_SW_MGMT + ".020"
+FM_ALARM_ID_USM_DEPLOY_HOST_FAILURE = ALARM_GROUP_SW_MGMT + ".021"
+
 # Security log id
 FM_LOG_ID_INVALID_PASSWORD = ALARM_GROUP_SECURITY + ".001"
 FM_LOG_ID_USER_LOCKOUT = ALARM_GROUP_SECURITY + ".002"
diff --git a/fm-doc/fm_doc/events.yaml b/fm-doc/fm_doc/events.yaml
index 80a4a6d8..e81bdc2b 100755
--- a/fm-doc/fm_doc/events.yaml
+++ b/fm-doc/fm_doc/events.yaml
@@ -3661,6 +3661,38 @@
     Degrade_Affecting_Severity: none
     Context: starlingx
 
+900.020:
+    Type: Alarm
+    Description: Deploy host completed with success
+    Entity_Instance_ID: host=<hostname>
+    Severity: major
+    Proposed_Repair_Action: Unlock host
+    Maintenance_Action:
+    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.021:
+    Type: Alarm
+    Description: Deploy host failed
+    Entity_Instance_ID: host=<hostname>
+    Severity: major
+    Proposed_Repair_Action: Check the logs for errors, fix the issues manually and retry
+    Maintenance_Action:
+    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.101:
     Type: Alarm
     Description: Software patch auto-apply in progress