docs/developer-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   4
   5 ===============
   6 Developer Guide
   7 ===============
   8
   9 .. image:: nf-oam-adopter-diagram.png
  10   :alt: Diagram
  11
  12 Architecture design of FM / PM Adopter
  13 --------------------------------------
  14
  15 Adapter has been design to provided common libraries that can be reused to generate application as per vendor needs.
  16
  17 **Modules**
  18
  19 - **o-ran-ves-adapter-api** module provides generated POJOS from VES 7.1 json Schema, together with VesEventNotifier interface.
  20 - **o-ran-ves-adapter-event-notifier**  module provides VesEventNotifier service implementation, responsible of forward VES events to the VES Collector via REST.
  21 - **o-ran-ves-adapter-pm-manager** module is responsible of read and translate CSV PM files from devices end point, translate it to VES event formant, and forward it to VesEventNotifier.
  22 - **o-ran-ves-adapter-snmp-manager** module is responsible of listend for SNMP traps on UDP port (Default 162), translate it to VES event formant, and forward it to VesEventNotifier.
  23 - **o-ran-ves-adapter-app** module contains the application, is responsible to assemble the whole set of libraries.
  24 - **ves-nf-oam-adopter-pm-sb-rest-client** module contains mock vendor specific PM REST Client implementation (ves-nf-oam-adopter-mock app).
  25
  26 .. image:: structureDiagram.png
  27   :alt: Diagram