update release notes format and fix some bugs 81/1881/1
authorweichen <niweichen@chinamobile.com>
Sat, 30 Nov 2019 09:30:22 +0000 (04:30 -0500)
committerweichen <niweichen@chinamobile.com>
Sat, 30 Nov 2019 09:30:22 +0000 (04:30 -0500)
Signed-off-by: weichen <niweichen@chinamobile.com>
Change-Id: If0b902729cecfe6dcdbd20f5dd1a738430a78491

docs/architecture/architecture.rst
docs/release-notes.rst

index ddcf6ce..ca81ac4 100644 (file)
@@ -15,30 +15,52 @@ Figure 1: O-RAN architecture overview
 
 In the O-RAN architecture, the radio side includes Near-RT RIC, O-CU-CP, O-CU-UP, O-DU, and O-RU. The management side includes Service Management and Orchestration Framework that contains a Non-RT-RIC function. 
 
+
 Components Definition
 ---------------------
 For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1].
 
-near-RT RIC: O-RAN near-real-time RAN Intelligent Controller: a logical function that enables near-real-time control and optimization of O-RAN elements and resources via fine-grained data collection and actions over E2 interface.
 
-non-RT RIC: O-RAN non-real-time RAN Intelligent Controller: a logical function that enables non-real-time control and optimization of RAN elements and resources, AI/ML workflow including model training and updates, and policy-based guidance of applications/features in near-RT RIC.
+near-RT RIC: 
+O-RAN near-real-time RAN Intelligent Controller: a logical function that enables near-real-time control and optimization of O-RAN elements and resources via fine-grained data collection and actions over E2 interface.
+
+
+non-RT RIC:
+O-RAN non-real-time RAN Intelligent Controller: a logical function that enables non-real-time control and optimization of RAN elements and resources, AI/ML workflow including model training and updates, and policy-based guidance of applications/features in near-RT RIC.
+
+NMS:
+A Network Management System 
+
+
+O-CU:
+O-RAN Central Unit: a logical node hosting RRC, SDAP and PDCP protocols
+
+
+O-CU-CP:
+O-RAN Central Unit – Control Plane: a logical node hosting the RRC and the control plane part of the PDCP protocol
+
+
+O-CU-UP: 
+O-RAN Central Unit – User Plane: a logical node hosting the user plane part of the PDCP protocol and the SDAP protocol
+
 
-NMS: A Network Management System 
+O-DU: 
+O-RAN Distributed Unit: a logical node hosting RLC/MAC/High-PHY layers based on a lower layer functional split.
 
-O-CU: O-RAN Central Unit: a logical node hosting RRC, SDAP and PDCP protocols
 
-O-CU-CP: O-RAN Central Unit – Control Plane: a logical node hosting the RRC and the control plane part of the PDCP protocol
+O-RU: 
+O-RAN Radio Unit: a logical node hosting Low-PHY layer and RF processing based on a lower layer functional split.  This is similar to 3GPP’s “TRP” or “RRH” but more specific in including the Low-PHY layer (FFT/iFFT, PRACH extraction).  
 
-O-CU-UP: O-RAN Central Unit – User Plane: a logical node hosting the user plane part of the PDCP protocol and the SDAP protocol
 
-O-DU: O-RAN Distributed Unit: a logical node hosting RLC/MAC/High-PHY layers based on a lower layer functional split.
+O1: 
+Interface between management entities in Service Management and Orchestration Framework and O-RAN managed elements, for operation and management, by which FCAPS management, Software management, File management shall be achieved. 
 
-O-RU: O-RAN Radio Unit: a logical node hosting Low-PHY layer and RF processing based on a lower layer functional split.  This is similar to 3GPP’s “TRP” or “RRH” but more specific in including the Low-PHY layer (FFT/iFFT, PRACH extraction).  
 
-O1: Interface between management entities in Service Management and Orchestration Framework and O-RAN managed elements, for operation and management, by which FCAPS management, Software management, File management shall be achieved. 
+O1*: 
+Interface between Service Management and Orchestration Framework and Infrastructure Management Framework supporting O-RAN virtual network functions.
 
-O1*: Interface between Service Management and Orchestration Framework and Infrastructure Management Framework supporting O-RAN virtual network functions.
 
-xAPP: Independent software plug-in to the Near-RT RIC platform to provide functional extensibility to the RAN by third parties.
+xAPP: 
+Independent software plug-in to the Near-RT RIC platform to provide functional extensibility to the RAN by third parties.
 
 
index 9f13bb5..d5e699d 100644 (file)
@@ -1,4 +1,4 @@
-e. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright (C) 2019 CMCC 
 
@@ -33,55 +33,58 @@ Version history
 
 Amber Release Summary
 ---------------------
-RAN Intelligent Controller Applications (RICAPP) Amber release features contain: 
 
-The MC xAPP which supports calculation of a number of metrics and KPIs based on X2 messages received from UEEC.
+RAN Intelligent Controller Applications (RICAPP) features 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The MC xAPP, which supports calculation of a number of metrics and KPIs based on X2 messages received from UEEC.
 
 * :doc:`RIC Measurement Campaign (MC) xApp Release-notes <ric-app-mc:release-notes>`
 
 
-The Acumos xAPP adapter which contains the code needed to use an existing Acumos microservice as an O-RAN xAPP, by providing “glue” that listens and speaks RMR protocol and translates these into calls to the Acumos microservice, which is co-deployed in the same pod as the adapter.
+The Acumos xAPP adapter, which contains the code needed to use an existing Acumos microservice as an O-RAN xAPP, by providing “glue” that listens and speaks RMR protocol and translates these into calls to the Acumos microservice, which is co-deployed in the same pod as the adapter.
 
 * :doc:`RIC APP ML Release-notes <ric-app-ml:release-notes>`
 
 
-GS-lite which is an open-source, real-time, low-latency, high-throughput stream processing engine.
+GS-lite, which is an open-source, real-time, low-latency, high-throughput stream processing engine.
 It is a fork of cask/tigon (https://github.com/cdapio/tigon) maintained to serve the needs of RIC applications (currently MC xApp).
 
 * :doc:`GS-lite Stream Processing Engine Release-notes <com-gs-lite:release-notes>`
 
 
-The AC xAPP which supports full closed loop control as well as report mode operation for admission control of SgNB Addition requests, reporting of metrics over VES, and configuration of single instance policies via the A1-Interface.
+The AC xAPP, which supports full closed loop control as well as report mode operation for admission control of SgNB Addition requests, reporting of metrics over VES, and configuration of single instance policies via the A1-Interface.
 
 * :doc:`Admission Control xAPP Release-notes <ric-app-admin:release-notes>`
 
 
-The KPI Mon xAPP which supports full closed loop control for CuCpResourceStatusReport from multiple gNBs and stores the metrics in Redis DB.
+The KPI Mon xAPP, which supports full closed loop control for CuCpResourceStatusReport from multiple gNBs and stores the metrics in Redis DB.
 
 * :doc:`KPI monitoring Release-notes <ric-app-kpimon:release-notes>`
 
 
 
-Near Realtime RAN Intelligent Controller (RIC) Amber release features contain:
+Near Realtime RAN Intelligent Controller (RIC) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-LOG which is a thread-safe logging C API library with Mapped Diagnostics Context (MDC) support.
+LOG, which is a thread-safe logging C API library with Mapped Diagnostics Context (MDC) support.
 
 * :doc:`LOG Release-notes <com-log:release-notes>`
 
 
-Golang which is an implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
+Golang, which is an implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
 
 * :doc:`GOLOG Release-notes <com-golog:release-notes>`
 
 
-PYLOG which implements a structured logging library with Mapped Diagnostic Context (MDC).
+PYLOG, which implements a structured logging library with Mapped Diagnostic Context (MDC).
 
 * :doc:`PYLOG Release-notes <com-pylog:release-notes>`
 
 ..
 .. * :doc:`A1 Release-notes <ric-plt-a1:release-notes>`
 
-DBAAS which is the needed elements to deploy database as a service (Dbaas) to kubernetes. Dbaas service is realized with a single container running Redis database. The database is configured to be non-persistent and non-redundant.
+DBAAS, which is the needed elements to deploy database as a service (Dbaas) to kubernetes. Dbaas service is realized with a single container running Redis database. The database is configured to be non-persistent and non-redundant.
 
 * :doc:`DBAAS Release-notes <ric-plt-dbaas:release-notes>`
 
@@ -91,48 +94,49 @@ DBAAS which is the needed elements to deploy database as a service (Dbaas) to ku
 ..
 .. * :doc:`Routing Manager Release-notes <ric-plt-rtmgr:release-notes>`
 
-Shared Data Layer which provides a lightweight, high-speed interface for accessing shared data storage. The purpose is to enable utilizing clients to become stateless, conforming with, e.g., the requirements of the fifth generation mobile networks.
+Shared Data Layer, which provides a lightweight, high-speed interface for accessing shared data storage. The purpose is to enable utilizing clients to become stateless, conforming with, e.g., the requirements of the fifth generation mobile networks.
 
 * :doc:`Shared Data Layer (SDL) in C++ Release-notes <ric-plt-sdl:release-notes>`
 
 
-Shared Data Layer which provides a lightweight, high-speed interface for accessing shared data storage. The purpose is to enable utilizing clients to become stateless, conforming with, e.g., the requirements of the fifth generation mobile networks.
+Shared Data Layer, which provides a lightweight, high-speed interface for accessing shared data storage. The purpose is to enable utilizing clients to become stateless, conforming with, e.g., the requirements of the fifth generation mobile networks.
 
 * :doc:`Shared Data Layer (SDL) in Go Release-notes <ric-plt-sdlgo:release-notes>`
 
 
-Jaegeradapter contains jaeger configuration files. This first version only supports configuration for a jaeger-all-in-one deployment.
+Jaegeradapter, which contains jaeger configuration files. This first version only supports configuration for a jaeger-all-in-one deployment.
 
 * :doc:`Jaegeradapter Release-notes <ric-plt-jaegeradapter:release-notes>`
 
 
-Tracelibcpp library implements a function for creating a configured tracer instance. It hides the underlaying tracer implementation from the application. The library currently supports only Jaeger (https://www.jaegertracing.io/) C++ client (https://github.com/jaegertracing/jaeger-client-cpp) tracer implementation.
+Tracelibcpp library, which implements a function for creating a configured tracer instance. It hides the underlaying tracer implementation from the application. The library currently supports only Jaeger (https://www.jaegertracing.io/) C++ client (https://github.com/jaegertracing/jaeger-client-cpp) tracer implementation.
 
 * :doc:`Tracelibcpp Release-notes <ric-plt-tracelibcpp:release-notes>`
 
 
-Tracelibgo library implements a function for creating a configured tracer instance. It hides the underlaying tracer implementation from the application. The trace library currently supports only Jaeger (https://www.jaegertracing.io/) golang client (https://github.com/jaegertracing/jaeger-client-go) tracer implementation.
+Tracelibgo library, which implements a function for creating a configured tracer instance. It hides the underlaying tracer implementation from the application. The trace library currently supports only Jaeger (https://www.jaegertracing.io/) golang client (https://github.com/jaegertracing/jaeger-client-go) tracer implementation.
 
 * :doc:`Tracelibgo Release-notes <ric-plt-tracelibgo:release-notes>`
 
 
-The VESPA manager which uses the VES Agent (https://github.com/nokia/ONAP-VESPA) to adapt near-RT RIC internal statistics’ collection using Prometheus (xApps and platform containers) to ONAP’s VES (VNF event streaming).
+The VESPA manager ,which uses the VES Agent (https://github.com/nokia/ONAP-VESPA) to adapt near-RT RIC internal statistics’ collection using Prometheus (xApps and platform containers) to ONAP’s VES (VNF event streaming).
 
 * :doc:`Vespamgr Release-notes <ric-plt-vespamgr:release-notes>`
 
 
-Asn1-documents which contains a description of the E2 used in the near-RT RIC implementation under O-RAN-SC.
+Asn1-documents, which contains a description of the E2 used in the near-RT RIC implementation under O-RAN-SC.
 
 * :doc:`ASN.1 Documents Release-notes <ric-plt-asn1-documents:release-notes>`
 
 
-Streaming Protobufs which provides a Protobuf schema for selected set of X2 Application Protocol messages.
+Streaming Protobufs, which provides a Protobuf schema for selected set of X2 Application Protocol messages.
 
 * :doc:`Streaming Protobufs Release-notes <ric-plt-streaming-protobufs:release-notes>`
 
 
 
-Non-RealTime RAN Intelligent Controller (NONRTRIC) Amber release features contain:
+Non-RealTime RAN Intelligent Controller (NONRTRIC) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 A dashboard is available. Non-RT RIC does not support R-apps yet. The Non-RT RIC is not yet fully compliant with the A1 specifications for this release. 
 
@@ -140,7 +144,8 @@ A dashboard is available. Non-RT RIC does not support R-apps yet. The Non-RT RIC
 
 
 
-Operations and Maintenance (OAM) Amber release features contain:
+Operations and Maintenance (OAM) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 OAM which provides reference implementation according to the O-RAN OAM (WG1) documents.
 
@@ -152,30 +157,34 @@ The O-RAN SC RIC Dashboard provides administrative and operator functions for a
 * :doc:`RIC Dashboard Release-notes <portal-ric-dashboard:release-notes>`
 
 
-O-RAN Central Unit (OCU) Amber release features contain:
+O-RAN Central Unit (OCU) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-OpenLTE which is a RAN Software Reference Design for a 4G TDD
+OpenLTE, which is a RAN Software Reference Design for a 4G TDD
 
 * :doc:`Open LTE Release-notes <scp-ocu-openlte:release-notes>`
 
 
-O-RAN Distributed Unit High Layers (ODUHIGH) Amber release features contain:
+O-RAN Distributed Unit High Layers (ODUHIGH) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-O-DU Layer 2 which is O-DU layer intilaizations and exchange of F1 Setup Request, F1 Setup Response, GNB DU Config Update and GNB DU Config Update ACK between the ODU and CU STUB.
+O-DU Layer 2, which is O-DU layer intilaizations and exchange of F1 Setup Request, F1 Setup Response, GNB DU Config Update and GNB DU Config Update ACK between the ODU and CU STUB.
 
 * :doc:`O-DU Layer 2 Release-notes <o-du-l2:release-notes>`
 
 
-O-RAN Distributed Unit Low Layers (ODULOW) Amber release features contain:
+O-RAN Distributed Unit Low Layers (ODULOW) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-O-DU Layer 1 which is the O-RAN FHI Lib built on top of DPDK to perform U-plane and C-plane functions according to the ORAN Fronthaul Interface specification between O-DU and O-RU. S-Plane support requires PTP for Linux version 2.0 or later The management plane is outside of the scope of this library implementation.
+O-DU Layer 1, which is the O-RAN FHI Lib built on top of DPDK to perform U-plane and C-plane functions according to the ORAN Fronthaul Interface specification between O-DU and O-RU. S-Plane support requires PTP for Linux version 2.0 or later The management plane is outside of the scope of this library implementation.
 
 * :doc:`O-DU Layer 1 Release-notes <o-du-phy:release-notes>`
 
 
-Infrastructure (INF) Amber release features contain:
+Infrastructure (INF) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Realtime Platform which implements a real time platform to deploy the O-CU and O-DU components.
+Realtime Platform, which implements a real time platform to deploy the O-CU and O-DU components.
 
 * :doc:`Realtime Platform Release-notes <pti-rtp:release-notes>`
 
@@ -185,7 +194,8 @@ Realtime Platform which implements a real time platform to deploy the O-CU and O
 .. * :doc:`SIM/O1-Interface Release-notes <sim-o1-interface:release-notes>`
 
 
-Integration and Testing (INT) Amber release features contain:
+Integration and Testing (INT) features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 IT-DEP hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying O-RAN SC software.