Directory reorganization for FM

This update brings FM in line with directory and index structure of other content.

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: If730098dc3eb119defa89647b04ac9f7c8717992
This commit is contained in:
Stone 2021-03-25 09:03:42 -04:00
parent 8ff2e4acee
commit e60b972a04
47 changed files with 205 additions and 167 deletions

View File

@ -11,161 +11,28 @@ Fault Management
StarlingX Kubernetes StarlingX Kubernetes
-------------------- --------------------
.. toctree:: An admin user can view |prod-long| fault management alarms and logs in order
:maxdepth: 1 to monitor and respond to fault conditions.
fault-management-overview You can access active and historical alarms, and customer logs using the CLI,
GUI, REST APIs and |SNMP|.
*****************
The global banner
*****************
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
the-global-alarm-banner kubernetes/index
*********************
Viewing active alarms
*********************
.. toctree::
:maxdepth: 1
viewing-active-alarms-using-horizon
viewing-active-alarms-using-the-cli
viewing-alarm-details-using-the-cli
*********************
Viewing the event log
*********************
.. toctree::
:maxdepth: 1
viewing-the-event-log-using-horizon
viewing-the-event-log-using-the-cli
*****************
Deleting an alarm
*****************
.. toctree::
:maxdepth: 1
deleting-an-alarm-using-the-cli
*****************
Event suppression
*****************
.. toctree::
:maxdepth: 1
events-suppression-overview
suppressing-and-unsuppressing-events
viewing-suppressed-alarms-using-the-cli
suppressing-an-alarm-using-the-cli
unsuppressing-an-alarm-using-the-cli
*****************************
CLI commands and paged output
*****************************
.. toctree::
:maxdepth: 1
cli-commands-and-paged-output
****
SNMP
****
.. toctree::
:maxdepth: 1
snmp-overview
enabling-snmp-support
traps
snmp-active-alarm-table
snmp-event-table
setting-snmp-identifying-information
uninstalling-snmp
**********************************
Distributed Cloud alarm management
**********************************
.. toctree::
:maxdepth: 1
alarms-management-for-distributed-cloud
cli-commands-for-dc-alarms-management
******************************
Troubleshooting log collection
******************************
.. toctree::
:maxdepth: 1
troubleshooting-log-collection
**************
Alarm messages
**************
.. toctree::
:maxdepth: 1
100-series-alarm-messages
200-series-alarm-messages
300-series-alarm-messages
400-series-alarm-messages
500-series-alarm-messages
750-series-alarm-messages
800-series-alarm-messages
900-series-alarm-messages
************
Log messages
************
.. toctree::
:maxdepth: 1
200-series-maintenance-customer-log-messages
400-series-customer-log-messages
900-series-orchestration-customer-log-messages
------------------- -------------------
StarlingX OpenStack StarlingX OpenStack
------------------- -------------------
.. toctree:: |prod-os| is a containerized application running on top of |prod|.
:maxdepth: 1
openstack-fault-management-overview This section provides the list of OpenStack related Alarms and Customer Logs
that are monitored and reported for the |prod-os| application through the
************************ |prod| fault management interfaces.
OpenStack alarm messages
************************
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
openstack-alarm-messages-300s openstack/index
openstack-alarm-messages-400s
openstack-alarm-messages-700s
openstack-alarm-messages-800s
*******************************
OpenStack customer log messages
*******************************
.. toctree::
:maxdepth: 1
openstack-customer-log-messages-270s-virtual-machines
openstack-customer-log-messages-401s-services
openstack-customer-log-messages-700s-virtual-machines

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall different degrees of severity. Use the reported alarms to monitor the overall
health of the system. health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _100-series-alarm-messages-table-zrd-tg5-v5: .. _100-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall different degrees of severity. Use the reported alarms to monitor the overall
health of the system. health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _200-series-alarm-messages-table-zrd-tg5-v5: .. _200-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the different degrees of severity. Use the reported alarms to monitor the
overall health of the system. overall health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _300-series-alarm-messages-table-zrd-tg5-v5: .. _300-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall different degrees of severity. Use the reported alarms to monitor the overall
health of the system. health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _400-series-alarm-messages-table-zrd-tg5-v5: .. _400-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall different degrees of severity. Use the reported alarms to monitor the overall
health of the system. health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _500-series-alarm-messages-table-zrd-tg5-v5: .. _500-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall different degrees of severity. Use the reported alarms to monitor the overall
health of the system. health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _750-series-alarm-messages-table-zrd-tg5-v5: .. _750-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall different degrees of severity. Use the reported alarms to monitor the overall
health of the system. health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _800-series-alarm-messages-table-zrd-tg5-v5: .. _800-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -10,7 +10,7 @@ The system inventory and maintenance service reports system changes with
different degrees of severity. Use the reported alarms to monitor the overall different degrees of severity. Use the reported alarms to monitor the overall
health of the system. health of the system.
.. include:: ../_includes/x00-series-alarm-messages.rest .. include:: ../../_includes/x00-series-alarm-messages.rest
.. _900-series-alarm-messages-table-zrd-tg5-v5: .. _900-series-alarm-messages-table-zrd-tg5-v5:

View File

@ -28,6 +28,6 @@ You can sort events by clicking the **Event ID**, **Description**, and
**Status** column headers. You can also use these as filtering criteria **Status** column headers. You can also use these as filtering criteria
from the **Search** field. from the **Search** field.
.. figure:: figures/uty1463514747661.png .. figure:: ../figures/uty1463514747661.png
:scale: 70 % :scale: 70 %
:alt: Event Suppression :alt: Event Suppression

View File

@ -15,7 +15,7 @@ alarms and :ref:`Customer Log Messages
for the list of customer logs reported by |prod|. for the list of customer logs reported by |prod|.
You can access active and historical alarms, and customer logs using the CLI, You can access active and historical alarms, and customer logs using the CLI,
GUI, REST APIs and :abbr:`SNMP (Simple Network Management Protocol)`. GUI, REST APIs and |SNMP|.
To use the CLI, see To use the CLI, see
:ref:`Viewing Active Alarms Using the CLI :ref:`Viewing Active Alarms Using the CLI

View File

@ -0,0 +1,135 @@
.. Fault Management file, created by
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
========
Contents
========
.. toctree::
:maxdepth: 1
fault-management-overview
*****************
The global banner
*****************
.. toctree::
:maxdepth: 1
the-global-alarm-banner
*********************
Viewing active alarms
*********************
.. toctree::
:maxdepth: 1
viewing-active-alarms-using-horizon
viewing-active-alarms-using-the-cli
viewing-alarm-details-using-the-cli
*********************
Viewing the event log
*********************
.. toctree::
:maxdepth: 1
viewing-the-event-log-using-horizon
viewing-the-event-log-using-the-cli
*****************
Deleting an alarm
*****************
.. toctree::
:maxdepth: 1
deleting-an-alarm-using-the-cli
*****************
Event suppression
*****************
.. toctree::
:maxdepth: 1
events-suppression-overview
suppressing-and-unsuppressing-events
viewing-suppressed-alarms-using-the-cli
suppressing-an-alarm-using-the-cli
unsuppressing-an-alarm-using-the-cli
*****************************
CLI commands and paged output
*****************************
.. toctree::
:maxdepth: 1
cli-commands-and-paged-output
****
SNMP
****
.. toctree::
:maxdepth: 1
snmp-overview
enabling-snmp-support
traps
snmp-active-alarm-table
snmp-event-table
setting-snmp-identifying-information
uninstalling-snmp
**********************************
Distributed Cloud alarm management
**********************************
.. toctree::
:maxdepth: 1
alarms-management-for-distributed-cloud
cli-commands-for-dc-alarms-management
******************************
Troubleshooting log collection
******************************
.. toctree::
:maxdepth: 1
troubleshooting-log-collection
**************
Alarm messages
**************
.. toctree::
:maxdepth: 1
100-series-alarm-messages
200-series-alarm-messages
300-series-alarm-messages
400-series-alarm-messages
500-series-alarm-messages
750-series-alarm-messages
800-series-alarm-messages
900-series-alarm-messages
************
Log messages
************
.. toctree::
:maxdepth: 1
200-series-maintenance-customer-log-messages
400-series-customer-log-messages
900-series-orchestration-customer-log-messages

View File

@ -34,4 +34,4 @@ You can set events to a suppressed state and toggle them back to unsuppressed.
replaced by **Unsuppress Event**, providing a way to toggle the event back replaced by **Unsuppress Event**, providing a way to toggle the event back
to unsuppressed. to unsuppressed.
.. image:: figures/nlc1463584178366.png .. image:: ../figures/nlc1463584178366.png

View File

@ -14,7 +14,7 @@ that is always visible, regardless of what page you are on in the GUI. The
banner provides a color-coded snapshot of current active alarm counts for each banner provides a color-coded snapshot of current active alarm counts for each
alarm severity. alarm severity.
.. image:: figures/xyj1558447807645.png .. image:: ../figures/xyj1558447807645.png
.. note:: .. note::
Suppressed alarms are not shown. For more about suppressed alarms, see Suppressed alarms are not shown. For more about suppressed alarms, see

View File

@ -96,4 +96,4 @@ Collect Tool Caveats and Usage
.. only:: partner .. only:: partner
.. include:: ../_includes/troubleshooting-log-collection.rest .. include:: ../../_includes/troubleshooting-log-collection.rest

View File

@ -45,7 +45,7 @@ buffer, with older entries discarded as needed to release logging space.
The **Suppression Status** column is only shown in the table when The **Suppression Status** column is only shown in the table when
**Show Suppressed** filter button is selected. **Show Suppressed** filter button is selected.
.. image:: figures/psa1567524091300.png .. image:: ../figures/psa1567524091300.png
You can sort the entries by clicking on the column titles. For example, to You can sort the entries by clicking on the column titles. For example, to
sort the view of the entries by severity, click **Severity**; the entries sort the view of the entries by severity, click **Severity**; the entries

View File

@ -0,0 +1,36 @@
.. Fault Management file, created by
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
========
Contents
========
.. toctree::
:maxdepth: 1
openstack-fault-management-overview
************************
OpenStack alarm messages
************************
.. toctree::
:maxdepth: 1
openstack-alarm-messages-300s
openstack-alarm-messages-400s
openstack-alarm-messages-700s
openstack-alarm-messages-800s
*******************************
OpenStack customer log messages
*******************************
.. toctree::
:maxdepth: 1
openstack-customer-log-messages-270s-virtual-machines
openstack-customer-log-messages-401s-services
openstack-customer-log-messages-700s-virtual-machines

View File

@ -6,7 +6,7 @@
Alarm Messages - 300s Alarm Messages - 300s
===================== =====================
.. include:: ../_includes/openstack-alarm-messages-xxxs.rest .. include:: ../../_includes/openstack-alarm-messages-xxxs.rest
.. _alarm-messages-300s-table-zrd-tg5-v5: .. _alarm-messages-300s-table-zrd-tg5-v5:

View File

@ -6,7 +6,7 @@
Alarm Messages - 400s Alarm Messages - 400s
===================== =====================
.. include:: ../_includes/openstack-alarm-messages-xxxs.rest .. include:: ../../_includes/openstack-alarm-messages-xxxs.rest
.. list-table:: .. list-table::
:widths: 6 15 :widths: 6 15

View File

@ -6,7 +6,7 @@
Alarm Messages - 700s Alarm Messages - 700s
===================== =====================
.. include:: ../_includes/openstack-alarm-messages-xxxs.rest .. include:: ../../_includes/openstack-alarm-messages-xxxs.rest
.. _alarm-messages-700s-table-zrd-tg5-v5: .. _alarm-messages-700s-table-zrd-tg5-v5:

View File

@ -6,7 +6,7 @@
Alarm Messages - 800s Alarm Messages - 800s
===================== =====================
.. include:: ../_includes/openstack-alarm-messages-xxxs.rest .. include:: ../../_includes/openstack-alarm-messages-xxxs.rest
.. _alarm-messages-800s-table-zrd-tg5-v5: .. _alarm-messages-800s-table-zrd-tg5-v5:

View File

@ -6,7 +6,7 @@
Customer Log Messages 270s - Virtual Machines Customer Log Messages 270s - Virtual Machines
============================================= =============================================
.. include:: ../_includes/openstack-customer-log-messages-xxxs.rest .. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest
.. _customer-log-messages-270s-virtual-machines-table-zgf-jvw-v5: .. _customer-log-messages-270s-virtual-machines-table-zgf-jvw-v5:

View File

@ -6,7 +6,7 @@
Customer Log Messages 401s - Services Customer Log Messages 401s - Services
===================================== =====================================
.. include:: ../_includes/openstack-customer-log-messages-xxxs.rest .. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest
.. _customer-log-messages-401s-services-table-zgf-jvw-v5: .. _customer-log-messages-401s-services-table-zgf-jvw-v5:

View File

@ -6,7 +6,7 @@
Customer Log Messages 700s - Virtual Machines Customer Log Messages 700s - Virtual Machines
============================================= =============================================
.. include:: ../_includes/openstack-customer-log-messages-xxxs.rest .. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest
.. _customer-log-messages-700s-virtual-machines-table-zgf-jvw-v5: .. _customer-log-messages-700s-virtual-machines-table-zgf-jvw-v5:

View File

@ -21,4 +21,4 @@ Management Protocol)` are available on the |prod| REST APIs, :abbr:`CLIs
.. :only: partner .. :only: partner
.. include:: ../_includes/openstack-fault-management-overview.rest .. include:: ../../_includes/openstack-fault-management-overview.rest