X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=1495df260ae91dd55e814eca30f4e14294fcff5c;hb=refs%2Fheads%2Fmaster;hp=08153d68767fcb39f82cf780c5f8947528ec5ff8;hpb=811e44e99a8884b2c316ea4a88ef88e75ee0e47d;p=oam%2Fnf-oam-adopter.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 08153d6..1495df2 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -2,7 +2,26 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. +=============== Developer Guide =============== -This document provides a quickstart for developers of the NF OAM Adopter. \ No newline at end of file +.. image:: nf-oam-adopter-diagram.png + :alt: Diagram + +Architecture design of FM / PM Adopter +-------------------------------------- + +Adapter has been design to provided common libraries that can be reused to generate application as per vendor needs. + +**Modules** + +- **o-ran-ves-adapter-api** module provides generated POJOS from VES 7.1 json Schema, together with VesEventNotifier interface. +- **o-ran-ves-adapter-event-notifier** module provides VesEventNotifier service implementation, responsible of forward VES events to the VES Collector via REST. +- **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. +- **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. +- **o-ran-ves-adapter-app** module contains the application, is responsible to assemble the whole set of libraries. +- **ves-nf-oam-adopter-pm-sb-rest-client** module contains mock vendor specific PM REST Client implementation (ves-nf-oam-adopter-mock app). + +.. image:: structureDiagram.png + :alt: Diagram \ No newline at end of file