Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / doc / 94f0a21b70057f022a0bc25c3394a8680915e3be / . / docs / release-notes.rst
blob: f4eec8e74a514f6a0a73d365aa1c15495f408582 [file] [log] [blame]
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]2.. SPDX-License-Identifier: CC-BY-4.0
3.. Copyright (C) 2019 CMCC
4
5Release-Notes
6=============
7
8
9This document provides the release notes for O-RAN SC.
10
11.. contents::
12 :depth: 3
13 :local:
14
15
16Version history
17---------------
18
19+--------------------+--------------------+--------------------+--------------------+
20| **Date** | **Ver.** | **Author** | **Comment** |
21| | | | |
22+--------------------+--------------------+--------------------+--------------------+
weichen7a6f3f62020-04-16 23:20:40 -0400[diff] [blame]23| 2019-11-31 | Amber | CMCC | Amber Release |
weichen17164ba2019-12-01 22:54:28 -0500[diff] [blame]24| | | | |
25+--------------------+--------------------+--------------------+--------------------+
weichenac773622020-06-19 00:26:23 -0400[diff] [blame]26| 2020-06-21 | Bronze | CMCC | Bronze Release |
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]27| | | | |
28+--------------------+--------------------+--------------------+--------------------+
weichen1049f1b2021-07-15 05:02:07 -0400[diff] [blame]29| 2020-12-21 | Cherry | CMCC | Cherry Release |
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]30| | | | |
weichen1049f1b2021-07-15 05:02:07 -0400[diff] [blame]31+--------------------+--------------------+--------------------+--------------------+
32| 2021-07-15 | Dawn | CMCC | Dawn Release |
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]33| | | | |
34+--------------------+--------------------+--------------------+--------------------+
weichen94f0a212021-12-15 03:45:00 -0500[diff] [blame^]35| 2021-12-15 | E | CMCC | E Release |
36| | | | |
37+--------------------+--------------------+--------------------+--------------------+
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]38
39
weichenc8c3dcc2020-05-26 05:50:40 -0400[diff] [blame]40Release Summary
weichen94f0a212021-12-15 03:45:00 -0500[diff] [blame^]41---------------
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]42
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]43RAN Intelligent Controller Applications (RICAPP) features
44^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
45
weichenab5e08b2020-06-09 23:41:48 -0400[diff] [blame]46.. * :doc:`Alarm Go Library Release-notes <ric-plt-alarm-go:release-notes>`
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]47
weichen9447de32021-03-07 20:48:19 -0500[diff] [blame]48.. 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.
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]49
weichen9447de32021-03-07 20:48:19 -0500[diff] [blame]50.. * :doc:`Admission Control xAPP Release-notes <ric-app-admin:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]51
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]52GS-lite, which is an open-source, real-time, low-latency, high-throughput stream processing engine.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]53It is a fork of cask/tigon (https://github.com/cdapio/tigon) maintained to serve the needs of RIC applications (currently MC xApp).
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]54
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]55* :doc:`GS-lite Stream Processing Engine Release-notes <com-gs-lite:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]56
57
weichenab5e08b2020-06-09 23:41:48 -0400[diff] [blame]58The HelloWorld(HW) xAPP repository contains open-source code for a prototype xAPP for near real-time RAN Intelligent Controller.
59
60* :doc:`HelloWorld xAPP Release-notes <ric-app-hw:release-notes>`
61
62
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]63The KPI Mon xAPP, which supports full closed loop control for CuCpResourceStatusReport from multiple gNBs and stores the metrics in Redis DB.
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]64
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]65* :doc:`KPI monitoring Release-notes <ric-app-kpimon:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]66
67
weichenab5e08b2020-06-09 23:41:48 -0400[diff] [blame]68QoE Predictor (QP) is an Xapp in the Traffic Steering O-RAN use case.
69
70* :doc:`QoE Predictor xApp Release-notes <ric-app-qp:release-notes>`
71
72
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]73The 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.
74
75* :doc:`RIC APP ML Release-notes <ric-app-ml:release-notes>`
76
77
78The MC xAPP, which supports calculation of a number of metrics and KPIs based on X2 messages received from UEEC.
79
80* :doc:`RIC Measurement Campaign (MC) xApp Release-notes <ric-app-mc:release-notes>`
81
82
weichen1049f1b2021-07-15 05:02:07 -0400[diff] [blame]83Anomaly Detection (AD) is an xApp in the Traffic Steering O-RAN use case.
84
85* :doc:`Anomaly Detection xApp Release-notes <ric-app-ad:release-notes>`
86
87
weichencdf07332021-09-01 21:43:29 -0400[diff] [blame]88This repository contains open-source code for a prototype HW-go xAPP for near real-time RAN Intelligent Controller which makes use of go Xapp Framework.
89
90* :doc:`HW-go xAPP Release-notes <ric-app-hw-go:release-notes>`
91
weichen1049f1b2021-07-15 05:02:07 -0400[diff] [blame]92
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]93
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]94Near Realtime RAN Intelligent Controller (RIC) features
95^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]96
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]97The RAN Intelligent Controller (RIC) Platform’s A1 Mediator component listens for policy type and policy instance requests sent via HTTP (the “northbound” interface), and publishes those requests to running xApps via RMR messages (the “southbound” interface).
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]98
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]99* :doc:`A1 Release-notes <ric-plt-a1:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]100
101
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]102Asn1-documents, which contains a description of the E2 used in the near-RT RIC implementation under O-RAN-SC.
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]103
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]104* :doc:`ASN.1 Documents Release-notes <ric-plt-asn1-documents:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]105
106
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]107DBAAS, 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.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]108
109* :doc:`DBAAS Release-notes <ric-plt-dbaas:release-notes>`
110
weichenef2d6c12019-12-02 02:42:54 -0500[diff] [blame]111.. * :doc:`E2 Release-notes <ric-plt-e2:release-notes>`
112.. * :doc:`E2MGR Release-notes <ric-plt-e2mgr:release-notes>`
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]113
114Golang, which is an implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
115
116* :doc:`GOLOG Release-notes <com-golog:release-notes>`
117
118
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]119Jaegeradapter, which contains jaeger configuration files. This first version only supports configuration for a jaeger-all-in-one deployment.
120
121* :doc:`Jaegeradapter Release-notes <ric-plt-jaegeradapter:release-notes>`
122
123
124LOG, which is a thread-safe logging C API library with Mapped Diagnostics Context (MDC) support.
125
126* :doc:`LOG Release-notes <com-log:release-notes>`
127
weichenef2d6c12019-12-02 02:42:54 -0500[diff] [blame]128.. * :doc:`nodeb-rnib Release-notes <ric-plt-nodeb-rnib:release-notes>`
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]129
130PYLOG, which implements a structured logging library with Mapped Diagnostic Context (MDC).
131
132* :doc:`PYLOG Release-notes <com-pylog:release-notes>`
133
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]134.. * :doc:`Resource Status Manager Release-notes <ric-plt-resouce-status-manager:release-notes>`
weichenef2d6c12019-12-02 02:42:54 -0500[diff] [blame]135.. * :doc:`RIC Message Router Release-notes <ric-plt-lib-rmr:release-notes>`
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]136.. * :doc:`Routing Manager Release-notes <ric-plt-rtmgr:release-notes>`
137
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]138Shared 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.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]139
140* :doc:`Shared Data Layer (SDL) in C++ Release-notes <ric-plt-sdl:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]141
142
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]143Shared 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.
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]144
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]145* :doc:`Shared Data Layer (SDL) in Go Release-notes <ric-plt-sdlgo:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]146
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]147
148Streaming Protobufs, which provides a Protobuf schema for selected set of X2 Application Protocol messages.
149
150* :doc:`Streaming Protobufs Release-notes <ric-plt-streaming-protobufs:release-notes>`
151
weichena39823b2019-12-01 21:36:47 -0500[diff] [blame]152.. * :doc:`Subscription Manager Release-notes <ric-plt-submgr:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]153
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]154Tracelibcpp 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.
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]155
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]156* :doc:`Tracelibcpp Release-notes <ric-plt-tracelibcpp:release-notes>`
157
158
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]159Tracelibgo 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.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]160
161* :doc:`Tracelibgo Release-notes <ric-plt-tracelibgo:release-notes>`
162
163
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]164The 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).
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]165
166* :doc:`Vespamgr Release-notes <ric-plt-vespamgr:release-notes>`
167
168
weichend25cbea2020-06-10 02:12:45 -0400[diff] [blame]169xapp-frame is a simple framework for rapid development of RIC xapps, and supports various services essential for RIC xapps such as RESTful APIs, RMR (RIC Message Routing), database backend services and watching and populating config-map changes in K8S environment
170
171* :doc:`xapp-frame Release-notes <ric-plt-xapp-frame:release-notes>`
172
173.. * :doc:`xAPP C++ Release-notes <ric-plt-xapp-frame-cpp:release-notes>`
174.. * :doc:`xApp Python Release-notes<ric-plt-xapp-frame-py:release-notes>`
175
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]176
weichencdf07332021-09-01 21:43:29 -0400[diff] [blame]177
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]178Non-RealTime RAN Intelligent Controller (NONRTRIC) features
179^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]180
weichen7a6f3f62020-04-16 23:20:40 -0400[diff] [blame]181In Bronze release, Non-RT RIC containes Policy Agent, Control Panel and A1 Simulator.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]182
183* :doc:`Non-RT RIC Release-notes <nonrtric:release-notes>`
184
185
186
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]187Operations and Maintenance (OAM) features
188^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]189
190OAM which provides reference implementation according to the O-RAN OAM (WG1) documents.
191
192* :doc:`OAM Operation and Maintenance Release-notes <oam:release-notes>`
weichen17738442021-05-28 03:47:42 -0400[diff] [blame]193* :doc:`TR069 Adapter Release-notes <oam-tr069-adapter:release-notes>`
weichen22baee32021-05-31 02:16:06 -0400[diff] [blame]194* :doc:`NF OAM Adopter Release-notes <oam-nf-oam-adopter:release-notes>`
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]195
196
197The O-RAN SC RIC Dashboard provides administrative and operator functions for a radio access network (RAN) controller. The web app is built as a single-page app using an Angular (version 8) front end and a Java (version 11) Spring-Boot (version 2.1) back end.
198
199* :doc:`RIC Dashboard Release-notes <portal-ric-dashboard:release-notes>`
200
201
weichencdf07332021-09-01 21:43:29 -0400[diff] [blame]202
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]203O-RAN Central Unit (OCU) features
204^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]205
weichenac773622020-06-19 00:26:23 -0400[diff] [blame]2065G NR which is a RAN Software Reference Design for a 5G protocol stack
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]207
weichenac773622020-06-19 00:26:23 -0400[diff] [blame]208.. * :doc:`Open LTE Release-notes <scp-ocu-openlte:release-notes>`
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]209
210
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]211O-RAN Distributed Unit High Layers (ODUHIGH) features
212^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]213
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]214O-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.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]215
216* :doc:`O-DU Layer 2 Release-notes <o-du-l2:release-notes>`
217
218
weichencdf07332021-09-01 21:43:29 -0400[diff] [blame]219
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]220O-RAN Distributed Unit Low Layers (ODULOW) features
221^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]222
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]223O-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.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]224
225* :doc:`O-DU Layer 1 Release-notes <o-du-phy:release-notes>`
226
227
weichencdf07332021-09-01 21:43:29 -0400[diff] [blame]228
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]229Infrastructure (INF) features
230^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]231
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]232Realtime Platform, which implements a real time platform to deploy the O-CU and O-DU components.
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]233
234* :doc:`Realtime Platform Release-notes <pti-rtp:release-notes>`
235
236
237.. Simulations(SIM) Amber release features contain:
238
239.. * :doc:`SIM/O1-Interface Release-notes <sim-o1-interface:release-notes>`
240
241
weichencdf07332021-09-01 21:43:29 -0400[diff] [blame]242
weichena928dd22019-11-30 04:30:22 -0500[diff] [blame]243Integration and Testing (INT) features
244^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]245
246IT-DEP hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying O-RAN SC software.
247
248* :doc:`IT-DEP Release-notes <it-dep:release-notes>`
249
250
weichen8a0ab4c2020-06-08 05:52:44 -0400[diff] [blame]251IT-DEV which integrates artifacts for developing Near Realtime RAN Intelligent Controller applications (xApps).
252
253* :doc:`IT-DEV Release-notes <it-dev:release-notes>`
254
255
weichen17164ba2019-12-01 22:54:28 -0500[diff] [blame]256IT-TEST, which contains:
257Test automation scripts written using the robot frameworkDeployment scripts for a dev-test 1-node Kubernetes cluster.
258A functional simulator for the E2 protocol that acts as gNB used to test the RIC.
259A workload generator that is used to benchmark the RIC
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]260
261* :doc:`IT-TEST Release-notes <it-test:release-notes>`
262
263
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]264IT-DEV includes the initial commit of the OTF platform code. Applications include otf-frontend, otf-service-api, otf-camunda, and several virtual test head microservices (ping, ssh, robot, ric). In addition setup documentation and installation guides are included to build docker containers and helm charts for deployment.
265
266* :doc:`IT-Otf Release-notes <it-otf:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]267
268
269
weichen94f0a212021-12-15 03:45:00 -0500[diff] [blame^]270Service Management and Orchestration (SMO) features
271^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
272
273The primary goal of the SMO project is to integrate different software artifacts of existing open-source projects creating a fully functional open-source Service Management and Orchestration (SMO).
274
275* :doc:`SMO-VES Release-notes <smo-ves:release-notes>`
276
weichen1a15d742019-11-28 08:28:08 -0500[diff] [blame]277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]295
296
297
298
299
300
301
302