037c99f0b7
Added Data Networks toctree Changed case on doc title in top level index - changed doc directory to fault-mgmt. Added Distributed Cloud section. Broke out "OpenStack Fault Management Overview" statement about remote log collection to conditionally included file. Incorporated patch 6 review comments. Also implemented rST :abbr: for first instance of SNMP in each file. Changed port number and community string in two SNMP walk examples. Change-Id: I1afd71265e752c4c9a54bf2dc9a173b3e17332a7 Signed-off-by: Stone <ronald.stone@windriver.com>
172 lines
3.2 KiB
ReStructuredText
172 lines
3.2 KiB
ReStructuredText
.. 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.
|
|
|
|
================
|
|
Fault Management
|
|
================
|
|
|
|
--------------------
|
|
StarlingX Kubernetes
|
|
--------------------
|
|
|
|
.. 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
|
|
configuring-snmp-trap-destinations
|
|
snmp-active-alarm-table
|
|
snmp-event-table
|
|
adding-an-snmp-community-string-using-the-cli
|
|
setting-snmp-identifying-information
|
|
|
|
**********************************
|
|
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
|
|
-------------------
|
|
|
|
.. 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 |