From: Claudio D. Gasparini Date: Wed, 26 May 2021 16:45:09 +0000 (+0200) Subject: Include module diagram X-Git-Tag: 1.0.0~3^2 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=7c4f8109f4ec2be6b5c9aec4f93af1ab8e09cee2;p=oam%2Fnf-oam-adopter.git Include module diagram Issue-ID: OAM-208 Signed-off-by: Claudio D. Gasparini Change-Id: I5853e649c3a641ec34acbc9e6286fb4689530707 --- diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 8207a84..1495df2 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -2,10 +2,26 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. +=============== Developer Guide =============== +.. image:: nf-oam-adopter-diagram.png + :alt: Diagram + Architecture design of FM / PM Adopter +-------------------------------------- -.. image:: nf-oam-adopter-diagram.png +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 diff --git a/docs/index.rst b/docs/index.rst index 49d12eb..ede0d7f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,7 +9,7 @@ NF OAM Adopter ============== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: overview.rst diff --git a/docs/overview.rst b/docs/overview.rst index 08c9b4c..02e8747 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -2,8 +2,8 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. -NF OAM Adopter Overview -======================= +Overview +======== NF OAM Adopter provides FM and PM VES event notification capabilities. diff --git a/docs/pm/index.rst b/docs/pm/index.rst index f47ad48..433aaa9 100644 --- a/docs/pm/index.rst +++ b/docs/pm/index.rst @@ -2,20 +2,16 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. +=============== PM REST Manager -############### +=============== PM REST Manager library follows `VES Event Listener 7.1 `_ -.. toctree:: - :maxdepth: 3 - :caption: Contents: - PM VES Message -============== +-------------- -Datatype: commonEventHeader -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Datatype: commonEventHeader** .. list-table:: :header-rows: 1 @@ -142,8 +138,7 @@ Datatype: commonEventHeader - none -Datatype: measurementFields -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Datatype: measurementFields** .. list-table:: :header-rows: 1 @@ -180,10 +175,9 @@ Datatype: measurementFields - none REST PM Configuration -===================== +--------------------- -Rest Adapter configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Rest Adapter configuration** Configuration file **application.yml** contains global definitions required to be consumed by PM REST adapters services. @@ -192,8 +186,7 @@ Configuration file **application.yml** contains global definitions required to b - **synchronization-time-frequency** Defines the time for execution of pull of PM files and forwarding as VES Message - **mapping-config-path** Defines the path where mapping configuration file is located -Rest SB Client Adapter configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Rest SB Client Adapter configuration** - **ran-token-endpoint** Defines rand endpoint from where token will be obtained - **ran-pm-endpoint:** Defines rand endpoint from where ZIP with PM files will be GET. @@ -203,7 +196,7 @@ Rest SB Client Adapter configuration :language: YAML Mapping Configuration -~~~~~~~~~~~~~~~~~~~~~ +--------------------- Configuration file **pm-ves-message-mapping.yaml** contains all definitions required to define the mapping from ZIP file with collection of csv files information to VES Message format @@ -232,20 +225,18 @@ from ZIP file with collection of csv files information to VES Message format :language: YAML PM Adapter Configuration -======================== +------------------------ PM Adapters can be instantiated at runtime -Create a PM Adapter -~~~~~~~~~~~~~~~~~~~ +**Create a PM Adapter** **POST** ``https://:/adapters/adapter`` .. literalinclude:: create-adapter.json :language: JSON -Get PM Adapters -~~~~~~~~~~~~~~~ +**Get PM Adapters** **GET** ``https://:/adapters/`` @@ -253,7 +244,6 @@ Get PM Adapters :language: JSON -Delete PM Adapter -~~~~~~~~~~~~~~~~~ +**Delete PM Adapter** **DELETE** ``https://:/adapters/adapter/10.53.40.50`` diff --git a/docs/snmp/index.rst b/docs/snmp/index.rst index 5dbe202..03c4d29 100644 --- a/docs/snmp/index.rst +++ b/docs/snmp/index.rst @@ -2,20 +2,16 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. +================ SNMP2VES Manager -################ +================ SNMP Manager library follows `VES Event Listener 7.1 `_ -.. toctree:: - :maxdepth: 3 - :caption: Contents: - FM VES Message -------------- -Datatype: commonEventHeader -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Datatype: commonEventHeader** .. list-table:: :header-rows: 1 @@ -141,8 +137,7 @@ Datatype: commonEventHeader - no - none -Datatype: faultFields -~~~~~~~~~~~~~~~~~~~~~ +**Datatype: faultFields** .. list-table:: :header-rows: 1 diff --git a/docs/structureDiagram.png b/docs/structureDiagram.png new file mode 100644 index 0000000..6284861 Binary files /dev/null and b/docs/structureDiagram.png differ diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 4380a54..da359bf 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -2,11 +2,11 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. -NF OAM Adopter User Guide -========================= +User Guide +========== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: ./snmp/index.rst diff --git a/ves-nf-oam-adopter/ves-nf-oam-adopter-artifacts/pom.xml b/ves-nf-oam-adopter/ves-nf-oam-adopter-artifacts/pom.xml index 7269b55..45a17d8 100644 --- a/ves-nf-oam-adopter/ves-nf-oam-adopter-artifacts/pom.xml +++ b/ves-nf-oam-adopter/ves-nf-oam-adopter-artifacts/pom.xml @@ -76,6 +76,11 @@ ves-nf-oam-adopter-pm-sb-rest-client ${project.version} + + ${project.groupId} + ves-nf-oam-adopter-app + ${project.version} + \ No newline at end of file