Documentation enhancements for Security and Fault Management

Fixed commit message
Update with review comments for Patch Set 1
Added a new fault and performance section to the Introduction guide.
Change-Id: Ia9e38ab9e8b88430bf7f475200e8bb65b12e5a75
This commit is contained in:
Oliver 2022-06-24 14:02:05 -04:00 committed by Juanita-Balaraj
parent ca28c7b1fe
commit 6c78cd0121
3 changed files with 39 additions and 3 deletions

View File

@ -1,3 +0,0 @@
{
"restructuredtext.confPath": ""
}

View File

@ -0,0 +1,38 @@
.. _fault-and-performance-management-940c6f6b3f6e:
=================================
Performance and Fault Management
=================================
|prod| provides a number of tools to allow system administrators to manage
performance and troubleshoot system issues.
Performance Management
----------------------
|prod| utilizes collectd ( https://collectd.org/ ) to capture the following
platform statistics and to generate threshold events based on
these statistics:
- CPU Usage of Platform Cores of |prod| hosts
- Platform Memory Usage of |prod| hosts
- Platform File Systems Usage
- Platform Interface Usage
- PTP Clock Skew Monitor
Any collectd threshold events trigger |prod| fault management Set/Clear
Customer Alarms.
Fault Management
----------------
For an overview of |prod| fault management, see
:ref:`fault-management-overview`.
For a listing of all |prod| fault management resources, including alarm log
messages, see 'Alarm messages' and 'Log messages' in the :ref:`Fault Management
Contents <index-fault-kub-f45ef76b6f16>` page.

View File

@ -33,6 +33,7 @@ Learn more about StarlingX:
functional_overview
deploy_config_overview
deploy_options
fault-and-performance-management-940c6f6b3f6e
terms
consuming
StarlingX Project Overview (PDF) <https://www.starlingx.io/collateral/StarlingX_Onboarding_Deck_for_Web.pdf>