From e60b972a046de738a1a0275e29b83b28a8ddcd02 Mon Sep 17 00:00:00 2001 From: Stone Date: Thu, 25 Mar 2021 09:03:42 -0400 Subject: [PATCH] Directory reorganization for FM This update brings FM in line with directory and index structure of other content. Signed-off-by: Stone Change-Id: If730098dc3eb119defa89647b04ac9f7c8717992 --- doc/source/fault-mgmt/index.rst | 157 ++---------------- .../100-series-alarm-messages.rst | 2 +- .../200-series-alarm-messages.rst | 2 +- ...ries-maintenance-customer-log-messages.rst | 0 .../300-series-alarm-messages.rst | 2 +- .../400-series-alarm-messages.rst | 2 +- .../400-series-customer-log-messages.rst | 0 .../500-series-alarm-messages.rst | 2 +- .../750-series-alarm-messages.rst | 2 +- .../800-series-alarm-messages.rst | 2 +- .../900-series-alarm-messages.rst | 2 +- ...es-orchestration-customer-log-messages.rst | 0 ...larms-management-for-distributed-cloud.rst | 0 .../cli-commands-and-paged-output.rst | 0 .../cli-commands-for-dc-alarms-management.rst | 0 .../deleting-an-alarm-using-the-cli.rst | 0 .../enabling-snmp-support.rst | 0 .../events-suppression-overview.rst | 2 +- .../fault-management-overview.rst | 2 +- .../fault-mgmt/{ => kubernetes}/index.rs1 | 0 doc/source/fault-mgmt/kubernetes/index.rst | 135 +++++++++++++++ .../setting-snmp-identifying-information.rst | 0 .../snmp-active-alarm-table.rst | 0 .../{ => kubernetes}/snmp-event-table.rst | 0 .../{ => kubernetes}/snmp-overview.rst | 0 .../suppressing-an-alarm-using-the-cli.rst | 0 .../suppressing-and-unsuppressing-events.rst | 2 +- .../the-global-alarm-banner.rst | 2 +- .../fault-mgmt/{ => kubernetes}/traps.rst | 0 .../troubleshooting-log-collection.rst | 2 +- .../{ => kubernetes}/uninstalling-snmp.rst | 0 .../unsuppressing-an-alarm-using-the-cli.rst | 0 .../viewing-active-alarms-using-horizon.rst | 0 .../viewing-active-alarms-using-the-cli.rst | 0 .../viewing-alarm-details-using-the-cli.rst | 0 ...iewing-suppressed-alarms-using-the-cli.rst | 0 .../viewing-the-event-log-using-horizon.rst | 2 +- .../viewing-the-event-log-using-the-cli.rst | 0 doc/source/fault-mgmt/openstack/index.rst | 36 ++++ .../openstack-alarm-messages-300s.rst | 2 +- .../openstack-alarm-messages-400s.rst | 2 +- .../openstack-alarm-messages-700s.rst | 2 +- .../openstack-alarm-messages-800s.rst | 2 +- ...mer-log-messages-270s-virtual-machines.rst | 2 +- ...ck-customer-log-messages-401s-services.rst | 2 +- ...mer-log-messages-700s-virtual-machines.rst | 2 +- .../openstack-fault-management-overview.rst | 2 +- 47 files changed, 205 insertions(+), 167 deletions(-) rename doc/source/fault-mgmt/{ => kubernetes}/100-series-alarm-messages.rst (99%) rename doc/source/fault-mgmt/{ => kubernetes}/200-series-alarm-messages.rst (98%) rename doc/source/fault-mgmt/{ => kubernetes}/200-series-maintenance-customer-log-messages.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/300-series-alarm-messages.rst (93%) rename doc/source/fault-mgmt/{ => kubernetes}/400-series-alarm-messages.rst (95%) rename doc/source/fault-mgmt/{ => kubernetes}/400-series-customer-log-messages.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/500-series-alarm-messages.rst (93%) rename doc/source/fault-mgmt/{ => kubernetes}/750-series-alarm-messages.rst (95%) rename doc/source/fault-mgmt/{ => kubernetes}/800-series-alarm-messages.rst (98%) rename doc/source/fault-mgmt/{ => kubernetes}/900-series-alarm-messages.rst (98%) rename doc/source/fault-mgmt/{ => kubernetes}/900-series-orchestration-customer-log-messages.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/alarms-management-for-distributed-cloud.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/cli-commands-and-paged-output.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/cli-commands-for-dc-alarms-management.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/deleting-an-alarm-using-the-cli.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/enabling-snmp-support.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/events-suppression-overview.rst (94%) rename doc/source/fault-mgmt/{ => kubernetes}/fault-management-overview.rst (95%) rename doc/source/fault-mgmt/{ => kubernetes}/index.rs1 (100%) create mode 100644 doc/source/fault-mgmt/kubernetes/index.rst rename doc/source/fault-mgmt/{ => kubernetes}/setting-snmp-identifying-information.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/snmp-active-alarm-table.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/snmp-event-table.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/snmp-overview.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/suppressing-an-alarm-using-the-cli.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/suppressing-and-unsuppressing-events.rst (96%) rename doc/source/fault-mgmt/{ => kubernetes}/the-global-alarm-banner.rst (94%) rename doc/source/fault-mgmt/{ => kubernetes}/traps.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/troubleshooting-log-collection.rst (97%) rename doc/source/fault-mgmt/{ => kubernetes}/uninstalling-snmp.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/unsuppressing-an-alarm-using-the-cli.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/viewing-active-alarms-using-horizon.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/viewing-active-alarms-using-the-cli.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/viewing-alarm-details-using-the-cli.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/viewing-suppressed-alarms-using-the-cli.rst (100%) rename doc/source/fault-mgmt/{ => kubernetes}/viewing-the-event-log-using-horizon.rst (96%) rename doc/source/fault-mgmt/{ => kubernetes}/viewing-the-event-log-using-the-cli.rst (100%) create mode 100644 doc/source/fault-mgmt/openstack/index.rst rename doc/source/fault-mgmt/{ => openstack}/openstack-alarm-messages-300s.rst (96%) rename doc/source/fault-mgmt/{ => openstack}/openstack-alarm-messages-400s.rst (93%) rename doc/source/fault-mgmt/{ => openstack}/openstack-alarm-messages-700s.rst (98%) rename doc/source/fault-mgmt/{ => openstack}/openstack-alarm-messages-800s.rst (97%) rename doc/source/fault-mgmt/{ => openstack}/openstack-customer-log-messages-270s-virtual-machines.rst (96%) rename doc/source/fault-mgmt/{ => openstack}/openstack-customer-log-messages-401s-services.rst (94%) rename doc/source/fault-mgmt/{ => openstack}/openstack-customer-log-messages-700s-virtual-machines.rst (99%) rename doc/source/fault-mgmt/{ => openstack}/openstack-fault-management-overview.rst (91%) diff --git a/doc/source/fault-mgmt/index.rst b/doc/source/fault-mgmt/index.rst index 1e15287b4..870855fab 100644 --- a/doc/source/fault-mgmt/index.rst +++ b/doc/source/fault-mgmt/index.rst @@ -11,161 +11,28 @@ Fault Management StarlingX Kubernetes -------------------- -.. toctree:: - :maxdepth: 1 +An admin user can view |prod-long| fault management alarms and logs in order +to monitor and respond to fault conditions. - fault-management-overview - -***************** -The global banner -***************** +You can access active and historical alarms, and customer logs using the CLI, +GUI, REST APIs and |SNMP|. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - 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 + kubernetes/index ------------------- StarlingX OpenStack ------------------- -.. toctree:: - :maxdepth: 1 +|prod-os| is a containerized application running on top of |prod|. - openstack-fault-management-overview - -************************ -OpenStack alarm messages -************************ +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. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - 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 \ No newline at end of file + openstack/index diff --git a/doc/source/fault-mgmt/100-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst similarity index 99% rename from doc/source/fault-mgmt/100-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst index 596d2bdd9..7c0199c14 100644 --- a/doc/source/fault-mgmt/100-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/100-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/200-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst similarity index 98% rename from doc/source/fault-mgmt/200-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst index a49c3691e..e10e920e4 100644 --- a/doc/source/fault-mgmt/200-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/200-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/200-series-maintenance-customer-log-messages.rst b/doc/source/fault-mgmt/kubernetes/200-series-maintenance-customer-log-messages.rst similarity index 100% rename from doc/source/fault-mgmt/200-series-maintenance-customer-log-messages.rst rename to doc/source/fault-mgmt/kubernetes/200-series-maintenance-customer-log-messages.rst diff --git a/doc/source/fault-mgmt/300-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst similarity index 93% rename from doc/source/fault-mgmt/300-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst index 8229f628f..8a09015ff 100644 --- a/doc/source/fault-mgmt/300-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/300-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/400-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst similarity index 95% rename from doc/source/fault-mgmt/400-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst index 42533121f..01ce24e1b 100644 --- a/doc/source/fault-mgmt/400-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/400-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/400-series-customer-log-messages.rst b/doc/source/fault-mgmt/kubernetes/400-series-customer-log-messages.rst similarity index 100% rename from doc/source/fault-mgmt/400-series-customer-log-messages.rst rename to doc/source/fault-mgmt/kubernetes/400-series-customer-log-messages.rst diff --git a/doc/source/fault-mgmt/500-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst similarity index 93% rename from doc/source/fault-mgmt/500-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst index d4424bf6c..df37f6796 100644 --- a/doc/source/fault-mgmt/500-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/500-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/750-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst similarity index 95% rename from doc/source/fault-mgmt/750-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst index d54adba79..e6d9a13a4 100644 --- a/doc/source/fault-mgmt/750-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/750-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/800-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst similarity index 98% rename from doc/source/fault-mgmt/800-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst index f134c0924..eb2bfef84 100644 --- a/doc/source/fault-mgmt/800-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/800-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/900-series-alarm-messages.rst b/doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst similarity index 98% rename from doc/source/fault-mgmt/900-series-alarm-messages.rst rename to doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst index c7d5641c8..c5a53ec9d 100644 --- a/doc/source/fault-mgmt/900-series-alarm-messages.rst +++ b/doc/source/fault-mgmt/kubernetes/900-series-alarm-messages.rst @@ -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 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: diff --git a/doc/source/fault-mgmt/900-series-orchestration-customer-log-messages.rst b/doc/source/fault-mgmt/kubernetes/900-series-orchestration-customer-log-messages.rst similarity index 100% rename from doc/source/fault-mgmt/900-series-orchestration-customer-log-messages.rst rename to doc/source/fault-mgmt/kubernetes/900-series-orchestration-customer-log-messages.rst diff --git a/doc/source/fault-mgmt/alarms-management-for-distributed-cloud.rst b/doc/source/fault-mgmt/kubernetes/alarms-management-for-distributed-cloud.rst similarity index 100% rename from doc/source/fault-mgmt/alarms-management-for-distributed-cloud.rst rename to doc/source/fault-mgmt/kubernetes/alarms-management-for-distributed-cloud.rst diff --git a/doc/source/fault-mgmt/cli-commands-and-paged-output.rst b/doc/source/fault-mgmt/kubernetes/cli-commands-and-paged-output.rst similarity index 100% rename from doc/source/fault-mgmt/cli-commands-and-paged-output.rst rename to doc/source/fault-mgmt/kubernetes/cli-commands-and-paged-output.rst diff --git a/doc/source/fault-mgmt/cli-commands-for-dc-alarms-management.rst b/doc/source/fault-mgmt/kubernetes/cli-commands-for-dc-alarms-management.rst similarity index 100% rename from doc/source/fault-mgmt/cli-commands-for-dc-alarms-management.rst rename to doc/source/fault-mgmt/kubernetes/cli-commands-for-dc-alarms-management.rst diff --git a/doc/source/fault-mgmt/deleting-an-alarm-using-the-cli.rst b/doc/source/fault-mgmt/kubernetes/deleting-an-alarm-using-the-cli.rst similarity index 100% rename from doc/source/fault-mgmt/deleting-an-alarm-using-the-cli.rst rename to doc/source/fault-mgmt/kubernetes/deleting-an-alarm-using-the-cli.rst diff --git a/doc/source/fault-mgmt/enabling-snmp-support.rst b/doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst similarity index 100% rename from doc/source/fault-mgmt/enabling-snmp-support.rst rename to doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst diff --git a/doc/source/fault-mgmt/events-suppression-overview.rst b/doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst similarity index 94% rename from doc/source/fault-mgmt/events-suppression-overview.rst rename to doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst index 35c2a35ba..0753000f0 100644 --- a/doc/source/fault-mgmt/events-suppression-overview.rst +++ b/doc/source/fault-mgmt/kubernetes/events-suppression-overview.rst @@ -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 from the **Search** field. -.. figure:: figures/uty1463514747661.png +.. figure:: ../figures/uty1463514747661.png :scale: 70 % :alt: Event Suppression \ No newline at end of file diff --git a/doc/source/fault-mgmt/fault-management-overview.rst b/doc/source/fault-mgmt/kubernetes/fault-management-overview.rst similarity index 95% rename from doc/source/fault-mgmt/fault-management-overview.rst rename to doc/source/fault-mgmt/kubernetes/fault-management-overview.rst index 7734226d0..17ccea70b 100644 --- a/doc/source/fault-mgmt/fault-management-overview.rst +++ b/doc/source/fault-mgmt/kubernetes/fault-management-overview.rst @@ -15,7 +15,7 @@ alarms and :ref:`Customer Log Messages for the list of customer logs reported by |prod|. 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 :ref:`Viewing Active Alarms Using the CLI diff --git a/doc/source/fault-mgmt/index.rs1 b/doc/source/fault-mgmt/kubernetes/index.rs1 similarity index 100% rename from doc/source/fault-mgmt/index.rs1 rename to doc/source/fault-mgmt/kubernetes/index.rs1 diff --git a/doc/source/fault-mgmt/kubernetes/index.rst b/doc/source/fault-mgmt/kubernetes/index.rst new file mode 100644 index 000000000..4e33b2c5d --- /dev/null +++ b/doc/source/fault-mgmt/kubernetes/index.rst @@ -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 diff --git a/doc/source/fault-mgmt/setting-snmp-identifying-information.rst b/doc/source/fault-mgmt/kubernetes/setting-snmp-identifying-information.rst similarity index 100% rename from doc/source/fault-mgmt/setting-snmp-identifying-information.rst rename to doc/source/fault-mgmt/kubernetes/setting-snmp-identifying-information.rst diff --git a/doc/source/fault-mgmt/snmp-active-alarm-table.rst b/doc/source/fault-mgmt/kubernetes/snmp-active-alarm-table.rst similarity index 100% rename from doc/source/fault-mgmt/snmp-active-alarm-table.rst rename to doc/source/fault-mgmt/kubernetes/snmp-active-alarm-table.rst diff --git a/doc/source/fault-mgmt/snmp-event-table.rst b/doc/source/fault-mgmt/kubernetes/snmp-event-table.rst similarity index 100% rename from doc/source/fault-mgmt/snmp-event-table.rst rename to doc/source/fault-mgmt/kubernetes/snmp-event-table.rst diff --git a/doc/source/fault-mgmt/snmp-overview.rst b/doc/source/fault-mgmt/kubernetes/snmp-overview.rst similarity index 100% rename from doc/source/fault-mgmt/snmp-overview.rst rename to doc/source/fault-mgmt/kubernetes/snmp-overview.rst diff --git a/doc/source/fault-mgmt/suppressing-an-alarm-using-the-cli.rst b/doc/source/fault-mgmt/kubernetes/suppressing-an-alarm-using-the-cli.rst similarity index 100% rename from doc/source/fault-mgmt/suppressing-an-alarm-using-the-cli.rst rename to doc/source/fault-mgmt/kubernetes/suppressing-an-alarm-using-the-cli.rst diff --git a/doc/source/fault-mgmt/suppressing-and-unsuppressing-events.rst b/doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst similarity index 96% rename from doc/source/fault-mgmt/suppressing-and-unsuppressing-events.rst rename to doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst index 0100c9b81..e6d4f67e6 100644 --- a/doc/source/fault-mgmt/suppressing-and-unsuppressing-events.rst +++ b/doc/source/fault-mgmt/kubernetes/suppressing-and-unsuppressing-events.rst @@ -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 to unsuppressed. - .. image:: figures/nlc1463584178366.png \ No newline at end of file + .. image:: ../figures/nlc1463584178366.png \ No newline at end of file diff --git a/doc/source/fault-mgmt/the-global-alarm-banner.rst b/doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst similarity index 94% rename from doc/source/fault-mgmt/the-global-alarm-banner.rst rename to doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst index 102cb54ef..f7db34047 100644 --- a/doc/source/fault-mgmt/the-global-alarm-banner.rst +++ b/doc/source/fault-mgmt/kubernetes/the-global-alarm-banner.rst @@ -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 alarm severity. -.. image:: figures/xyj1558447807645.png +.. image:: ../figures/xyj1558447807645.png .. note:: Suppressed alarms are not shown. For more about suppressed alarms, see diff --git a/doc/source/fault-mgmt/traps.rst b/doc/source/fault-mgmt/kubernetes/traps.rst similarity index 100% rename from doc/source/fault-mgmt/traps.rst rename to doc/source/fault-mgmt/kubernetes/traps.rst diff --git a/doc/source/fault-mgmt/troubleshooting-log-collection.rst b/doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst similarity index 97% rename from doc/source/fault-mgmt/troubleshooting-log-collection.rst rename to doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst index cec72bbe0..70df06f94 100644 --- a/doc/source/fault-mgmt/troubleshooting-log-collection.rst +++ b/doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst @@ -96,4 +96,4 @@ Collect Tool Caveats and Usage .. only:: partner - .. include:: ../_includes/troubleshooting-log-collection.rest \ No newline at end of file + .. include:: ../../_includes/troubleshooting-log-collection.rest \ No newline at end of file diff --git a/doc/source/fault-mgmt/uninstalling-snmp.rst b/doc/source/fault-mgmt/kubernetes/uninstalling-snmp.rst similarity index 100% rename from doc/source/fault-mgmt/uninstalling-snmp.rst rename to doc/source/fault-mgmt/kubernetes/uninstalling-snmp.rst diff --git a/doc/source/fault-mgmt/unsuppressing-an-alarm-using-the-cli.rst b/doc/source/fault-mgmt/kubernetes/unsuppressing-an-alarm-using-the-cli.rst similarity index 100% rename from doc/source/fault-mgmt/unsuppressing-an-alarm-using-the-cli.rst rename to doc/source/fault-mgmt/kubernetes/unsuppressing-an-alarm-using-the-cli.rst diff --git a/doc/source/fault-mgmt/viewing-active-alarms-using-horizon.rst b/doc/source/fault-mgmt/kubernetes/viewing-active-alarms-using-horizon.rst similarity index 100% rename from doc/source/fault-mgmt/viewing-active-alarms-using-horizon.rst rename to doc/source/fault-mgmt/kubernetes/viewing-active-alarms-using-horizon.rst diff --git a/doc/source/fault-mgmt/viewing-active-alarms-using-the-cli.rst b/doc/source/fault-mgmt/kubernetes/viewing-active-alarms-using-the-cli.rst similarity index 100% rename from doc/source/fault-mgmt/viewing-active-alarms-using-the-cli.rst rename to doc/source/fault-mgmt/kubernetes/viewing-active-alarms-using-the-cli.rst diff --git a/doc/source/fault-mgmt/viewing-alarm-details-using-the-cli.rst b/doc/source/fault-mgmt/kubernetes/viewing-alarm-details-using-the-cli.rst similarity index 100% rename from doc/source/fault-mgmt/viewing-alarm-details-using-the-cli.rst rename to doc/source/fault-mgmt/kubernetes/viewing-alarm-details-using-the-cli.rst diff --git a/doc/source/fault-mgmt/viewing-suppressed-alarms-using-the-cli.rst b/doc/source/fault-mgmt/kubernetes/viewing-suppressed-alarms-using-the-cli.rst similarity index 100% rename from doc/source/fault-mgmt/viewing-suppressed-alarms-using-the-cli.rst rename to doc/source/fault-mgmt/kubernetes/viewing-suppressed-alarms-using-the-cli.rst diff --git a/doc/source/fault-mgmt/viewing-the-event-log-using-horizon.rst b/doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst similarity index 96% rename from doc/source/fault-mgmt/viewing-the-event-log-using-horizon.rst rename to doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst index 2b695f77a..00ac760d0 100644 --- a/doc/source/fault-mgmt/viewing-the-event-log-using-horizon.rst +++ b/doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-horizon.rst @@ -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 **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 sort the view of the entries by severity, click **Severity**; the entries diff --git a/doc/source/fault-mgmt/viewing-the-event-log-using-the-cli.rst b/doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-the-cli.rst similarity index 100% rename from doc/source/fault-mgmt/viewing-the-event-log-using-the-cli.rst rename to doc/source/fault-mgmt/kubernetes/viewing-the-event-log-using-the-cli.rst diff --git a/doc/source/fault-mgmt/openstack/index.rst b/doc/source/fault-mgmt/openstack/index.rst new file mode 100644 index 000000000..e30d8744f --- /dev/null +++ b/doc/source/fault-mgmt/openstack/index.rst @@ -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 \ No newline at end of file diff --git a/doc/source/fault-mgmt/openstack-alarm-messages-300s.rst b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-300s.rst similarity index 96% rename from doc/source/fault-mgmt/openstack-alarm-messages-300s.rst rename to doc/source/fault-mgmt/openstack/openstack-alarm-messages-300s.rst index c98f0a7fc..4bcd21ed4 100644 --- a/doc/source/fault-mgmt/openstack-alarm-messages-300s.rst +++ b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-300s.rst @@ -6,7 +6,7 @@ Alarm Messages - 300s ===================== -.. include:: ../_includes/openstack-alarm-messages-xxxs.rest +.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest .. _alarm-messages-300s-table-zrd-tg5-v5: diff --git a/doc/source/fault-mgmt/openstack-alarm-messages-400s.rst b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst similarity index 93% rename from doc/source/fault-mgmt/openstack-alarm-messages-400s.rst rename to doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst index ec58d929d..31e68d73f 100644 --- a/doc/source/fault-mgmt/openstack-alarm-messages-400s.rst +++ b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst @@ -6,7 +6,7 @@ Alarm Messages - 400s ===================== -.. include:: ../_includes/openstack-alarm-messages-xxxs.rest +.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest .. list-table:: :widths: 6 15 diff --git a/doc/source/fault-mgmt/openstack-alarm-messages-700s.rst b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst similarity index 98% rename from doc/source/fault-mgmt/openstack-alarm-messages-700s.rst rename to doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst index 66857bfb1..de5dde30c 100644 --- a/doc/source/fault-mgmt/openstack-alarm-messages-700s.rst +++ b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst @@ -6,7 +6,7 @@ Alarm Messages - 700s ===================== -.. include:: ../_includes/openstack-alarm-messages-xxxs.rest +.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest .. _alarm-messages-700s-table-zrd-tg5-v5: diff --git a/doc/source/fault-mgmt/openstack-alarm-messages-800s.rst b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst similarity index 97% rename from doc/source/fault-mgmt/openstack-alarm-messages-800s.rst rename to doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst index 7a8c05b5e..573324f68 100644 --- a/doc/source/fault-mgmt/openstack-alarm-messages-800s.rst +++ b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst @@ -6,7 +6,7 @@ Alarm Messages - 800s ===================== -.. include:: ../_includes/openstack-alarm-messages-xxxs.rest +.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest .. _alarm-messages-800s-table-zrd-tg5-v5: diff --git a/doc/source/fault-mgmt/openstack-customer-log-messages-270s-virtual-machines.rst b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst similarity index 96% rename from doc/source/fault-mgmt/openstack-customer-log-messages-270s-virtual-machines.rst rename to doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst index b37f47348..bf47db52c 100644 --- a/doc/source/fault-mgmt/openstack-customer-log-messages-270s-virtual-machines.rst +++ b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst @@ -6,7 +6,7 @@ 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: diff --git a/doc/source/fault-mgmt/openstack-customer-log-messages-401s-services.rst b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst similarity index 94% rename from doc/source/fault-mgmt/openstack-customer-log-messages-401s-services.rst rename to doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst index 6173825de..f2da7f701 100644 --- a/doc/source/fault-mgmt/openstack-customer-log-messages-401s-services.rst +++ b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst @@ -6,7 +6,7 @@ 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: diff --git a/doc/source/fault-mgmt/openstack-customer-log-messages-700s-virtual-machines.rst b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst similarity index 99% rename from doc/source/fault-mgmt/openstack-customer-log-messages-700s-virtual-machines.rst rename to doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst index 3a13c8750..056acf697 100644 --- a/doc/source/fault-mgmt/openstack-customer-log-messages-700s-virtual-machines.rst +++ b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst @@ -6,7 +6,7 @@ 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: diff --git a/doc/source/fault-mgmt/openstack-fault-management-overview.rst b/doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst similarity index 91% rename from doc/source/fault-mgmt/openstack-fault-management-overview.rst rename to doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst index c79109b93..6e2faf456 100644 --- a/doc/source/fault-mgmt/openstack-fault-management-overview.rst +++ b/doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst @@ -21,4 +21,4 @@ Management Protocol)` are available on the |prod| REST APIs, :abbr:`CLIs .. :only: partner - .. include:: ../_includes/openstack-fault-management-overview.rest \ No newline at end of file + .. include:: ../../_includes/openstack-fault-management-overview.rest \ No newline at end of file