StarlingX Fault Management
Go to file
fperez 625e253b7c Add new FM API methods
New API methods have been added to allow getting,
setting, and clearing faults by providing both
alarm_id and entity_instance_id.

Changes in this commit:
- For clear_fault operation, the query has been updated
to allow the removal of multiple rows with a single
query. The entity_instance_id parameter can now be a
prefix, enabling the matching of multiple alarms with
the same alarm_id.
This change does not affect existing use cases.

- New method get_faults_by_id_n_eid, This method allows
API clients to retrieve a list of alarms that match an
alarm_id and a prefix of entity_instance_id, thereby
matching multiple alarms.

- New method set_faults. This method accepts a list of
alarms as a parameter and calls the same core set_fault
function for each alarm.

[PASS] Build and install packages
[PASS] Remove several alarms that matches 'alarm_id',
       'entity_instance_id=%'
[PASS] Get list of alarms that match 'alarm_id' and
       'entity_instance_id=%'
[PASS] Verify that the new behavior for removing alarms
       does not affect previous use cases.
[PASS] Test set_faults API function providing a list
       of alarms. Verify the alarms in the list are
       being created.
[PASS] Enable debug mode to verify that queries are as
       expected.

Story: 2011106
task: 50756

Change-Id: Ib9dcfa97960a5d50865133a61810681e5a09edbe
Signed-off-by: fperez <fabrizio.perez@windriver.com>
2024-08-12 16:43:59 -03:00
api-ref/source Removing system uuid from alarms summary 2021-08-12 19:55:39 -04:00
devstack Implement access control for FM API 2022-08-26 10:54:39 -03:00
doc Add alarm id, definition for system peer and subcloud peer group 2023-10-13 15:56:12 +08:00
fm-api Add new FM API methods 2024-08-12 16:43:59 -03:00
fm-common Add new FM API methods 2024-08-12 16:43:59 -03:00
fm-doc Add controller-fs alarm to fault management 2024-05-30 17:10:41 -03:00
fm-mgr Update debian package versions to use git commits 2023-02-09 18:06:57 +00:00
fm-rest-api Define kernel mismatch alarms: 100.120, 100.121 2023-06-30 08:02:41 -04:00
python-fmclient Support newer version of yaml 2023-05-31 16:36:27 +00:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-06-04 14:20:25 +02:00
.gitignore Create test framework for python with stestr. 2020-01-16 16:45:45 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:34 +00:00
.zuul.yaml Fix github mirroring for this repo 2023-04-28 12:38:51 -04:00
bindep.txt py3: Add support for python 3.9 2021-09-01 08:58:34 -04:00
centos_build_layer.cfg Build layering, add layer build config file 2019-10-15 19:41:08 +08:00
centos_iso_image.inc Remove snmp-ext and snmp-audittrail from FM 2021-01-04 14:57:33 -03:00
centos_pkg_dirs Remove snmp-ext and snmp-audittrail from FM 2021-01-04 14:57:33 -03:00
centos_stable_docker_images.inc Create the stable wheel and image build files 2019-03-24 21:08:19 -04:00
centos_stable_wheels.inc Create the stable wheel and image build files 2019-03-24 21:08:19 -04:00
CONTRIBUTORS.wrs StarlingX open source release updates 2018-05-31 07:36:00 -07:00
debian_build_layer.cfg Add debian_build_layer.cfg file 2021-10-28 15:26:08 -04:00
debian_iso_image.inc Debian: fault: update debian_iso_image.inc 2022-11-18 08:15:57 +08:00
debian_pkg_dirs Update debian-pkg-dirs with fm-doc library 2022-02-04 02:02:56 +00:00
debian_stable_docker_images.inc Add stx-fm-rest-api loci image 2022-10-27 15:29:06 +00:00
debian_stable_wheels.inc Add stx-fm-rest-api loci image 2022-10-27 15:29:06 +00:00
LICENSE StarlingX open source release updates 2018-05-31 07:36:00 -07:00
pylint.rc Support newer version of yaml 2023-05-31 16:36:27 +00:00
README.rst starlingx/fault README improvement 2023-07-19 10:48:29 -03:00
requirements.txt Adding pylint zuul and tox target 2020-03-11 09:05:18 -05:00
test-requirements.txt Tox and Zuul cleanup for python3.9 2023-03-02 19:32:25 +00:00
tox.ini Tox and Zuul cleanup for python3.9 2023-03-02 19:32:25 +00:00

Fault Management (FM)

The starlingx/fault repository handles Fault Management (FM) services1, and provides the fm command-line interface (CLI)2.

This repository is not intended to be developed standalone, but rather as part of the StarlingX Source System, which is defined by the StarlingX manifest3.

References


  1. https://docs.starlingx.io/api-ref/fault↩︎

  2. https://docs.starlingx.io/cli_ref/fm.html↩︎

  3. https://opendev.org/starlingx/manifest.git↩︎