From 0478e2406ca03b8388d2150439d5370d20a72437 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Tue, 29 Nov 2022 10:09:15 -0500 Subject: [PATCH] Add alarm severity legend Generically describe alarm severities and requirements at top of each alarm series. Signed-off-by: Ron Stone Change-Id: Id90d147ad4a3f4833c4d224761674ab66ef9f842 --- .../shared/_includes/alarm-severities.rest | 32 +++++++++++++++++++ templates/alarms_template.rst | 2 ++ 2 files changed, 34 insertions(+) create mode 100644 doc/source/shared/_includes/alarm-severities.rest diff --git a/doc/source/shared/_includes/alarm-severities.rest b/doc/source/shared/_includes/alarm-severities.rest new file mode 100644 index 000000000..be20aa9b8 --- /dev/null +++ b/doc/source/shared/_includes/alarm-severities.rest @@ -0,0 +1,32 @@ + +.. rubric:: Alarm Severities + +One or more of the following severity levels is associated with each alarm. + +``Critical`` + Indicates that a platform service affecting condition has occurred and + immediate corrective action is required. (A mandatory platform service + has become totally out of service and its capability must be restored.) + +``Major`` + Indicates that a platform service affecting condition has developed and + urgent corrective action is required. (A mandatory platform service has + developed a severe degradation and its full capability must be restored.) + + \- or \- + + An optional platform service has become totally out of service and its + capability should be restored. + +``Minor`` + Indicates that a platform non-service affecting fault condition has developed + and corrective action should be taken in order to prevent a more serious fault. + (The fault condition is not currently impacting / degrading the capability of + the platform service.) + +``Warning`` + Indicates the detection of a potential or impending service affecting fault. + Action should be taken to further diagnose and correct the problem in order + to prevent it from becoming a more serious service affecting fault. + +----- diff --git a/templates/alarms_template.rst b/templates/alarms_template.rst index de26fd686..0e9363506 100644 --- a/templates/alarms_template.rst +++ b/templates/alarms_template.rst @@ -6,6 +6,8 @@ head_format=" Series Alarm Messages +.. include:: /shared/_includes/alarm-severities.rest + " record_format="