Update docs OAM architecture diagram 99/5899/1
authordemx8as6 <martin.skorupski@highstreet-technologies.com>
Wed, 17 Mar 2021 14:05:04 +0000 (15:05 +0100)
committerdemx8as6 <martin.skorupski@highstreet-technologies.com>
Fri, 16 Apr 2021 09:49:03 +0000 (11:49 +0200)
in addtion some editorial changes were made.

IssueID: OAM-171
Change-Id: Id623786e71f06a98140e2121d7a4b8db0b8d4716
Signed-off-by: demx8as6 <martin.skorupski@highstreet-technologies.com>
.gitignore
docs/_static/o-ran-architecture.png
docs/abbreviations.rst
docs/config-deploy.rst
docs/developer-guide.rst
docs/mediator.rst
docs/overview.rst
docs/release-notes.rst
docs/sdnr_Docker_Image_configuration.rst

index 45418a7..803ce49 100644 (file)
@@ -22,6 +22,7 @@ pom.xml.next
 dependency-reduced-pom.xml
 buildNumber.properties
 .mvn/timing.properties
 dependency-reduced-pom.xml
 buildNumber.properties
 .mvn/timing.properties
+*.pyc
 
 */**/bin/
 
 
 */**/bin/
 
@@ -32,12 +33,13 @@ target/
 # Opendaylight yang-tools
 yang-gen-sal/
 
 # Opendaylight yang-tools
 yang-gen-sal/
 
-# Eclipse related
+# IDE (Eclipse, vsCode) related
 .project
 .classpath
 .settings/
 target-ide/
 release.properties
 .project
 .classpath
 .settings/
 target-ide/
 release.properties
+.vsCode
 
 # data models in scp/oam/modeling
 *.yang
 
 # data models in scp/oam/modeling
 *.yang
index 9642d0d..af0d517 100644 (file)
Binary files a/docs/_static/o-ran-architecture.png and b/docs/_static/o-ran-architecture.png differ
index 0f59b36..bcdc719 100644 (file)
@@ -82,7 +82,7 @@ Abbreviations
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | GBP              | `Group-Based Policy <https://wiki.openstack.org/wiki/GroupBasedPolicy>`__                                                                                                    |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | GBP              | `Group-Based Policy <https://wiki.openstack.org/wiki/GroupBasedPolicy>`__                                                                                                    |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| GNFC             | `Genric Network Function Controller <https://wiki.onap.org/download/attachments/45300148/ONAP_GNF_ControllersSOL003.pptx?version=1&modificationDate=1548619943000&api=v2>`__ |
+| GNFC             | `Generic Network Function Controller <https://wiki.onap.org/download/attachments/45300148/ONAP_GNF_ControllersSOL003.pptx?version=1&modificationDate=1548619943000&api=v2>`__ |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | GUI              | `Graphical User Interface <https://en.wikipedia.org/wiki/Graphical_user_interface>`__                                                                                        |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | GUI              | `Graphical User Interface <https://en.wikipedia.org/wiki/Graphical_user_interface>`__                                                                                        |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -92,7 +92,7 @@ Abbreviations
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | HPA              | Hardware Platform Awareness                                                                                                                                                  |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | HPA              | Hardware Platform Awareness                                                                                                                                                  |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP             | HyperText Transfer Protococol                                                                                                                                                |
+| HTTP             | HyperText Transfer Protocol                                                                                                                                                |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | HV VES           | `High Volume Virtual function Event Stream <https://wiki.onap.org/display/DW/High+Volume+VES+Collector>`__                                                                   |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | HV VES           | `High Volume Virtual function Event Stream <https://wiki.onap.org/display/DW/High+Volume+VES+Collector>`__                                                                   |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -288,7 +288,7 @@ Abbreviations
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | TSC              | Technical Steering Committee                                                                                                                                                 |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | TSC              | Technical Steering Committee                                                                                                                                                 |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| U-UI             | `Usecase User Interface <https://wiki.onap.org/display/DW/Usecase+UI+Project>`__                                                                                             |
+| U-UI             | `Use case User Interface <https://wiki.onap.org/display/DW/Usecase+UI+Project>`__                                                                                             |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | UI               | `User Interface <https://en.wikipedia.org/wiki/User_interface>`__                                                                                                            |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | UI               | `User Interface <https://en.wikipedia.org/wiki/User_interface>`__                                                                                                            |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -300,7 +300,7 @@ Abbreviations
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | vDNS             | Virtual Domain Name Server (an example VNF)                                                                                                                                  |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | vDNS             | Virtual Domain Name Server (an example VNF)                                                                                                                                  |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| VDU              | `Virtualisation Deployment Unit <https://wiki.onap.org/display/DW/Comparison+of+Current+R3+Clean+Version+with+IFA011+v2.5.1>`__                                              |
+| VDU              | `Virtualization Deployment Unit <https://wiki.onap.org/display/DW/Comparison+of+Current+R3+Clean+Version+with+IFA011+v2.5.1>`__                                              |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | VES              | `Virtual function Event Stream <https://wiki.opnfv.org/download/attachments/6819329/OPNVF%20VES.pptx?version=4&modificationDate=1466395653000&api=v2>`__                     |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | VES              | `Virtual function Event Stream <https://wiki.opnfv.org/download/attachments/6819329/OPNVF%20VES.pptx?version=4&modificationDate=1466395653000&api=v2>`__                     |
 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
index f379485..8949551 100644 (file)
@@ -183,13 +183,13 @@ Kubernetes deployment resources is beyond the scope of this document.
 
   helm -n dev-smo local/onap -f ~/workspace/smo/deploy_smo_bronce.yaml --namespace onap --timeout 900
 
 
   helm -n dev-smo local/onap -f ~/workspace/smo/deploy_smo_bronce.yaml --namespace onap --timeout 900
 
-* verifiy deployment
+* verify deployment
 
 .. code-block:: RST
   :linenos:
 
   helm ls
 
 
 .. code-block:: RST
   :linenos:
 
   helm ls
 
-* verifiy pnf-registration, fault notification use case
+* verify pnf-registration, fault notification use case
 
 Please open the O1 Dashboard: http://localhost:8181/odlux/index.html
 
 Please open the O1 Dashboard: http://localhost:8181/odlux/index.html
index 211480d..6a7cac1 100644 (file)
@@ -7,5 +7,5 @@ OAM Developer Guide
 
 This document provides a quickstart for developers of the O-RAN SC OAM components.
 
 
 This document provides a quickstart for developers of the O-RAN SC OAM components.
 
-All informations fo development are documented in coorespondding O-RAN-SC wiki:
+All information of development are documented in corresponding O-RAN-SC wiki:
 https://wiki.o-ran-sc.org/display/OAM/Operations+and+Maintenance
 https://wiki.o-ran-sc.org/display/OAM/Operations+and+Maintenance
index 1dad777..b05282e 100644 (file)
@@ -5,10 +5,13 @@
 Mediator
 ========
 
 Mediator
 ========
 
-Some device vendors (Altiostar, CommScope, Dragonwave-X) use the
+A 'Mediator' provides an external -  to the physical network function - 
+OAM interface.
+
+Some physical network function manufactures use the
 `generic mediator
 framework <https://github.com/Melacon/NetConf2SNMP>`__. Such mediators
 `generic mediator
 framework <https://github.com/Melacon/NetConf2SNMP>`__. Such mediators
-offer an API to create, delete, start and stop mediator instances.
+offer a management API to control mediator function.
 
 New mediator servers can be added via the '+' button. Afterward, a
 server can be selected to view all available mediator instances.
 
 New mediator servers can be added via the '+' button. Afterward, a
 server can be selected to view all available mediator instances.
index d0bb5b3..a8b458d 100644 (file)
@@ -6,15 +6,15 @@ OAM Operation and Maintenance Overview
 ======================================
 
 The O-RAN SC OAM project provides administrative and operator
 ======================================
 
 The O-RAN SC OAM project provides administrative and operator
-functions for O-RAN components, such as Near-Realtime-RAN-Inelegent-Controller,
+functions for O-RAN components, such as Near-Realtime-RAN-Inelegant-Controller,
 O-RAN Centralized Unit, O-RAN Distributed Unit and O-RAN Radio Unit. 
 
 O-RAN Centralized Unit, O-RAN Distributed Unit and O-RAN Radio Unit. 
 
-The project follows the specifications for the O1 interface as provided by
-O-RAN Working Group1. 
+The project follows the specifications for the `O1 interface <https://www.o-ran.org/specifications>`_ 
+as provided by O-RAN Working Group 1 (new 10).
 
 The O-RAN-SC OAM project adds features and functions to the OpenDaylight-based ONAP
 controller 'CCSDK/SDNC'. It is built on the Common Controller Framework
 
 The O-RAN-SC OAM project adds features and functions to the OpenDaylight-based ONAP
 controller 'CCSDK/SDNC'. It is built on the Common Controller Framework
-to control and manage O-RAN managed elements and O-RAN managed functions. 
+to control and to manage O-RAN ManagedElements and O-RAN ManagedFunctions. 
 
 .. figure:: ./_static/o-ran-architecture.png
    :alt: SDN-R in ONAP
 
 .. figure:: ./_static/o-ran-architecture.png
    :alt: SDN-R in ONAP
@@ -24,7 +24,6 @@ to control and manage O-RAN managed elements and O-RAN managed functions.
 
 Project Resources
 -----------------
 
 Project Resources
 -----------------
-
 The project uses the following Linux Foundation resources:
 
 * The source code is maintained in this Gerrit:
 The project uses the following Linux Foundation resources:
 
 * The source code is maintained in this Gerrit:
@@ -43,21 +42,21 @@ The project uses the following Linux Foundation resources:
 Scope
 -----
 
 Scope
 -----
 
-According to the O-RAN-SC-OAM-Architecture document all ManagedElements 
-(near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) implement the 
-O1-interface.
+According to the `O-RAN-OAM-Architecture document <https://www.o-ran.org/specifications>`_ 
+all ManagedElements (ME) (near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) 
+implement the O1-interface.
 
 The O-RAN-OAM-interface specification defines
 
 - a NetConf-Server for Configuration Management (CM) and
 
 The O-RAN-OAM-interface specification defines
 
 - a NetConf-Server for Configuration Management (CM) and
-- a http-client for Fault Managment (FM), Performance Management (PM) and other 
+- a http-client for Fault Management (FM), Performance Management (PM) and other 
   events on each Management-Service-Provider (MnS-Provider) running on the 
   events on each Management-Service-Provider (MnS-Provider) running on the 
-  ManagedElement (ME).
+  ManagedElement.
 
 THe O-RAN-SC-OAM project provides reference implementation according to the 
 
 THe O-RAN-SC-OAM project provides reference implementation according to the 
-O-RAN OAM (WG1) documents. In addition we provide a common MnS-Consumer for 
-development and module test purposes.  The assumption is that the projects 
+O-RAN OAM documents. In addition it provides a lightweight MnS-Consumer for 
+development and module test purposes. The assumption is that the projects 
 for the ManagedElements can concentrate on the more important user-plane.
 
 for the ManagedElements can concentrate on the more important user-plane.
 
-Of cause each project needs its own OAM repo to address the specific needs 
-of the ManagedElement.
+Each project requires its own OAM repository to address the specific needs 
+of the ManagedFunction.
index 32e3d42..28c2ace 100644 (file)
@@ -18,7 +18,7 @@ Version 2.0.4, 2020-06-13
 * Documentation updated
 * Develop reusable OAM API such that the first consumer being a VTH can query, subscribe or publish on a DMAAP topic   Story
 * Create helm deployment for SMO
 * Documentation updated
 * Develop reusable OAM API such that the first consumer being a VTH can query, subscribe or publish on a DMAAP topic   Story
 * Create helm deployment for SMO
-* Featuresplit for starting devicemanages
+* Feature split for starting devicemanagers
 * Seed coder for an YANG linter
 * Please see also Release Notes of `ONAP SDNC <https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/release-notes.html#release-notes>`_ and `ONAP OOM <https://onap-doc.readthedocs.io/projects/onap-oom/en/frankfurt/release-notes.html#release-notes>`_
 
 * Seed coder for an YANG linter
 * Please see also Release Notes of `ONAP SDNC <https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/release-notes.html#release-notes>`_ and `ONAP OOM <https://onap-doc.readthedocs.io/projects/onap-oom/en/frankfurt/release-notes.html#release-notes>`_
 
@@ -26,7 +26,7 @@ Version 2.0.3, 2020-04-08
 -------------------------
 
 * What is an SMO?
 -------------------------
 
 * What is an SMO?
-* Provide xRAN datamodels
+* Provide xRAN data models
 * Provide curl bash scripts for Software Management
 * Add jenkins jobs for oam
 * Add parents to model artifacts
 * Provide curl bash scripts for Software Management
 * Add jenkins jobs for oam
 * Add parents to model artifacts
index 5297a09..4a02088 100644 (file)
@@ -14,10 +14,10 @@ ONAP SDN-R is running in a docker container using ONAP/SDN-C image
 The container is available as Alpine and Ubuntu version. The description
 uses examples for the Alpine version.
 
 The container is available as Alpine and Ubuntu version. The description
 uses examples for the Alpine version.
 
-The alpine based sdnc docker imanges are stored in \ `ONAP Nexus sdnc
+The alpine based sdnc docker images are stored in \ `ONAP Nexus sdnc
 image <https://nexus3.onap.org:10001/v2/onap/sdnc-image/tags/list>`__.
 
 image <https://nexus3.onap.org:10001/v2/onap/sdnc-image/tags/list>`__.
 
-The docker image contains a Opendaylight distribution in a standard
+The docker image contains a OpenDaylight distribution in a standard
 configuration and ONAP/SDN-R specific microservices.
 
 The Root location of ODL Karaf directory structure
 configuration and ONAP/SDN-R specific microservices.
 
 The Root location of ODL Karaf directory structure