From 6f46a39b7de0e3290ae8f2aa8f6ab9b66076b4f4 Mon Sep 17 00:00:00 2001 From: demx8as6 Date: Sat, 17 Sep 2022 15:07:41 +0200 Subject: [PATCH] Describe the usage of this docker-compose - fix redirected links in docs IssueID: OAM-284 Change-Id: Ie1a90d6c77e7ea4c06967293ed855880bee7851f Signed-off-by: demx8as6 --- docs/abbreviations.rst | 2 +- docs/overview.rst | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/abbreviations.rst b/docs/abbreviations.rst index 6fefd7d..9364997 100644 --- a/docs/abbreviations.rst +++ b/docs/abbreviations.rst @@ -332,7 +332,7 @@ Abbreviations +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | VM | Virtual Machine | +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| VNF | `Virtual Network Function `__ | +| VNF | `Virtual Network Function `__ | +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | VNFC | Virtual Network Function Component | +--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/overview.rst b/docs/overview.rst index bda7dd0..b297a26 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -7,14 +7,14 @@ OAM Operation and Maintenance Overview The O-RAN SC OAM project provides administrative and operator 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 `_ +The project follows the specifications for the `O1 interface `_ 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 -to control and to manage O-RAN ManagedElements and O-RAN ManagedFunctions. +to control and to manage O-RAN ManagedElements and O-RAN ManagedFunctions. .. figure:: ./_static/o-ran-architecture.png :alt: SDN-R in ONAP @@ -33,7 +33,7 @@ The project uses the following Linux Foundation resources: ``_ * Issues are tracked in this Jira: - ``_ + ``_ * Project information is available in this Wiki: ``_ @@ -42,23 +42,23 @@ The project uses the following Linux Foundation resources: Scope ----- -According to the `O-RAN-OAM-Architecture document `_ -all ManagedElements (ME) (near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) +According to the `O-RAN-OAM-Architecture document `_ +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 -- a http-client for Fault Management (FM), Performance Management (PM) and other - events on each Management-Service-Provider (MnS-Provider) running on the +- a http-client for Fault Management (FM), Performance Management (PM) and other + events on each Management-Service-Provider (MnS-Provider) running on the ManagedElement. -THe O-RAN-SC-OAM project provides reference implementation according to the -O-RAN OAM documents. In addition it provides a lightweight MnS-Consumer for -development and module test purposes. The assumption is that the projects +THe O-RAN-SC-OAM project provides reference implementation according to the +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. -Each project requires its own OAM repository to address the specific needs +Each project requires its own OAM repository to address the specific needs of the ManagedFunction. The following O-RAN specifications are considered during implementations: -- 2.16.6