blob: c9d9723e6c4e5078e23453d9f0fd14bc55cac4e5 [file] [log] [blame]
weichena928dd22019-11-30 04:30:22 -05001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
weichen332b2872019-11-12 01:41:31 -05002.. 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 -040023| 2019-11-31 | Amber | CMCC | Amber Release |
weichen17164ba2019-12-01 22:54:28 -050024| | | | |
25+--------------------+--------------------+--------------------+--------------------+
weichenac773622020-06-19 00:26:23 -040026| 2020-06-21 | Bronze | CMCC | Bronze Release |
weichen332b2872019-11-12 01:41:31 -050027| | | | |
28+--------------------+--------------------+--------------------+--------------------+
weichen1049f1b2021-07-15 05:02:07 -040029| 2020-12-21 | Cherry | CMCC | Cherry Release |
weichen332b2872019-11-12 01:41:31 -050030| | | | |
weichen1049f1b2021-07-15 05:02:07 -040031+--------------------+--------------------+--------------------+--------------------+
weichen58dd5692021-12-15 06:05:57 -050032| 2021-07-15 | D | CMCC | D Release |
weichen332b2872019-11-12 01:41:31 -050033| | | | |
34+--------------------+--------------------+--------------------+--------------------+
weichen94f0a212021-12-15 03:45:00 -050035| 2021-12-15 | E | CMCC | E Release |
36| | | | |
37+--------------------+--------------------+--------------------+--------------------+
weichen45ff2d32022-07-13 01:51:16 -040038| 2022-7-06 | F | CMCC | F Release |
39| | | | |
40+--------------------+--------------------+--------------------+--------------------+
weichen5944b262023-07-04 16:29:38 +080041| 2022-12-16 | G | CMCC | G Release |
42| | | | |
43+--------------------+--------------------+--------------------+--------------------+
44| 2023-7-04 | H | CMCC | H Release |
45| | | | |
46+--------------------+--------------------+--------------------+--------------------+
weichen074018d2023-12-08 15:21:25 +080047| 2023-12-04 | I | CMCC | I Release |
48| | | | |
49+--------------------+--------------------+--------------------+--------------------+
weichenea736a72024-07-02 14:40:53 +080050| 2024-07-01 | J | CMCC | J Release |
51| | | | |
52+--------------------+--------------------+--------------------+--------------------+
53
weichen5944b262023-07-04 16:29:38 +080054
weichen332b2872019-11-12 01:41:31 -050055
weichenc8c3dcc2020-05-26 05:50:40 -040056Release Summary
weichen94f0a212021-12-15 03:45:00 -050057---------------
weichen1a15d742019-11-28 08:28:08 -050058
weichena928dd22019-11-30 04:30:22 -050059RAN Intelligent Controller Applications (RICAPP) features
60^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
61
weichenab5e08b2020-06-09 23:41:48 -040062.. * :doc:`Alarm Go Library Release-notes <ric-plt-alarm-go:release-notes>`
weichend773eca2019-11-29 05:17:40 -050063
weichen9447de32021-03-07 20:48:19 -050064.. 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 -050065
weichen9447de32021-03-07 20:48:19 -050066.. * :doc:`Admission Control xAPP Release-notes <ric-app-admin:release-notes>`
weichen1a15d742019-11-28 08:28:08 -050067
weichena928dd22019-11-30 04:30:22 -050068GS-lite, which is an open-source, real-time, low-latency, high-throughput stream processing engine.
weichend773eca2019-11-29 05:17:40 -050069It 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 -050070
weichend773eca2019-11-29 05:17:40 -050071* :doc:`GS-lite Stream Processing Engine Release-notes <com-gs-lite:release-notes>`
weichen1a15d742019-11-28 08:28:08 -050072
73
weichenab5e08b2020-06-09 23:41:48 -040074The HelloWorld(HW) xAPP repository contains open-source code for a prototype xAPP for near real-time RAN Intelligent Controller.
75
76* :doc:`HelloWorld xAPP Release-notes <ric-app-hw:release-notes>`
77
78
weichena928dd22019-11-30 04:30:22 -050079The 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 -050080
weichend773eca2019-11-29 05:17:40 -050081* :doc:`KPI monitoring Release-notes <ric-app-kpimon:release-notes>`
weichen1a15d742019-11-28 08:28:08 -050082
83
weichenab5e08b2020-06-09 23:41:48 -040084QoE Predictor (QP) is an Xapp in the Traffic Steering O-RAN use case.
85
86* :doc:`QoE Predictor xApp Release-notes <ric-app-qp:release-notes>`
87
88
weichen8a0ab4c2020-06-08 05:52:44 -040089The 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.
90
91* :doc:`RIC APP ML Release-notes <ric-app-ml:release-notes>`
92
93
94The MC xAPP, which supports calculation of a number of metrics and KPIs based on X2 messages received from UEEC.
95
96* :doc:`RIC Measurement Campaign (MC) xApp Release-notes <ric-app-mc:release-notes>`
97
98
weichen1049f1b2021-07-15 05:02:07 -040099Anomaly Detection (AD) is an xApp in the Traffic Steering O-RAN use case.
100
101* :doc:`Anomaly Detection xApp Release-notes <ric-app-ad:release-notes>`
102
103
weichencdf07332021-09-01 21:43:29 -0400104This 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.
105
106* :doc:`HW-go xAPP Release-notes <ric-app-hw-go:release-notes>`
107
weichen1049f1b2021-07-15 05:02:07 -0400108
weichen1a15d742019-11-28 08:28:08 -0500109
weichena928dd22019-11-30 04:30:22 -0500110Near Realtime RAN Intelligent Controller (RIC) features
111^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500112
weichen8a0ab4c2020-06-08 05:52:44 -0400113The RAN Intelligent Controller (RIC) Platforms 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 -0500114
weichen8a0ab4c2020-06-08 05:52:44 -0400115* :doc:`A1 Release-notes <ric-plt-a1:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500116
117
weichen8a0ab4c2020-06-08 05:52:44 -0400118Asn1-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 -0500119
weichen8a0ab4c2020-06-08 05:52:44 -0400120* :doc:`ASN.1 Documents Release-notes <ric-plt-asn1-documents:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500121
122
weichena928dd22019-11-30 04:30:22 -0500123DBAAS, 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 -0500124
125* :doc:`DBAAS Release-notes <ric-plt-dbaas:release-notes>`
126
weichenef2d6c12019-12-02 02:42:54 -0500127.. * :doc:`E2 Release-notes <ric-plt-e2:release-notes>`
128.. * :doc:`E2MGR Release-notes <ric-plt-e2mgr:release-notes>`
weichen8a0ab4c2020-06-08 05:52:44 -0400129
130Golang, which is an implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
131
132* :doc:`GOLOG Release-notes <com-golog:release-notes>`
133
134
weichen8a0ab4c2020-06-08 05:52:44 -0400135Jaegeradapter, which contains jaeger configuration files. This first version only supports configuration for a jaeger-all-in-one deployment.
136
137* :doc:`Jaegeradapter Release-notes <ric-plt-jaegeradapter:release-notes>`
138
139
140LOG, which is a thread-safe logging C API library with Mapped Diagnostics Context (MDC) support.
141
142* :doc:`LOG Release-notes <com-log:release-notes>`
143
weichenef2d6c12019-12-02 02:42:54 -0500144.. * :doc:`nodeb-rnib Release-notes <ric-plt-nodeb-rnib:release-notes>`
weichen8a0ab4c2020-06-08 05:52:44 -0400145
146PYLOG, which implements a structured logging library with Mapped Diagnostic Context (MDC).
147
148* :doc:`PYLOG Release-notes <com-pylog:release-notes>`
149
weichen8a0ab4c2020-06-08 05:52:44 -0400150.. * :doc:`Resource Status Manager Release-notes <ric-plt-resouce-status-manager:release-notes>`
weichenef2d6c12019-12-02 02:42:54 -0500151.. * :doc:`RIC Message Router Release-notes <ric-plt-lib-rmr:release-notes>`
weichend773eca2019-11-29 05:17:40 -0500152.. * :doc:`Routing Manager Release-notes <ric-plt-rtmgr:release-notes>`
153
weichena928dd22019-11-30 04:30:22 -0500154Shared 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 -0500155
156* :doc:`Shared Data Layer (SDL) in C++ Release-notes <ric-plt-sdl:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500157
158
weichena928dd22019-11-30 04:30:22 -0500159Shared 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 -0500160
weichend773eca2019-11-29 05:17:40 -0500161* :doc:`Shared Data Layer (SDL) in Go Release-notes <ric-plt-sdlgo:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500162
weichen8a0ab4c2020-06-08 05:52:44 -0400163
164Streaming Protobufs, which provides a Protobuf schema for selected set of X2 Application Protocol messages.
165
166* :doc:`Streaming Protobufs Release-notes <ric-plt-streaming-protobufs:release-notes>`
167
weichena39823b2019-12-01 21:36:47 -0500168.. * :doc:`Subscription Manager Release-notes <ric-plt-submgr:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500169
weichena928dd22019-11-30 04:30:22 -0500170Tracelibcpp 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 -0500171
weichend773eca2019-11-29 05:17:40 -0500172* :doc:`Tracelibcpp Release-notes <ric-plt-tracelibcpp:release-notes>`
173
174
weichena928dd22019-11-30 04:30:22 -0500175Tracelibgo 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 -0500176
177* :doc:`Tracelibgo Release-notes <ric-plt-tracelibgo:release-notes>`
178
179
weichena928dd22019-11-30 04:30:22 -0500180The 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 -0500181
182* :doc:`Vespamgr Release-notes <ric-plt-vespamgr:release-notes>`
183
184
weichend25cbea2020-06-10 02:12:45 -0400185xapp-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
186
187* :doc:`xapp-frame Release-notes <ric-plt-xapp-frame:release-notes>`
188
189.. * :doc:`xAPP C++ Release-notes <ric-plt-xapp-frame-cpp:release-notes>`
190.. * :doc:`xApp Python Release-notes<ric-plt-xapp-frame-py:release-notes>`
191
weichend773eca2019-11-29 05:17:40 -0500192
weichencdf07332021-09-01 21:43:29 -0400193
weichena928dd22019-11-30 04:30:22 -0500194Non-RealTime RAN Intelligent Controller (NONRTRIC) features
195^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500196
weichen7a6f3f62020-04-16 23:20:40 -0400197In Bronze release, Non-RT RIC containes Policy Agent, Control Panel and A1 Simulator.
weichend773eca2019-11-29 05:17:40 -0500198
199* :doc:`Non-RT RIC Release-notes <nonrtric:release-notes>`
200
201
202
weichena928dd22019-11-30 04:30:22 -0500203Operations and Maintenance (OAM) features
204^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500205
206OAM which provides reference implementation according to the O-RAN OAM (WG1) documents.
207
208* :doc:`OAM Operation and Maintenance Release-notes <oam:release-notes>`
weichen17738442021-05-28 03:47:42 -0400209* :doc:`TR069 Adapter Release-notes <oam-tr069-adapter:release-notes>`
weichen22baee32021-05-31 02:16:06 -0400210* :doc:`NF OAM Adopter Release-notes <oam-nf-oam-adopter:release-notes>`
weichend773eca2019-11-29 05:17:40 -0500211
212
213The 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.
214
215* :doc:`RIC Dashboard Release-notes <portal-ric-dashboard:release-notes>`
216
217
weichencdf07332021-09-01 21:43:29 -0400218
weichena928dd22019-11-30 04:30:22 -0500219O-RAN Central Unit (OCU) features
220^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500221
weichenac773622020-06-19 00:26:23 -04002225G NR which is a RAN Software Reference Design for a 5G protocol stack
weichend773eca2019-11-29 05:17:40 -0500223
weichenac773622020-06-19 00:26:23 -0400224.. * :doc:`Open LTE Release-notes <scp-ocu-openlte:release-notes>`
weichend773eca2019-11-29 05:17:40 -0500225
226
weichena928dd22019-11-30 04:30:22 -0500227O-RAN Distributed Unit High Layers (ODUHIGH) features
228^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500229
weichena928dd22019-11-30 04:30:22 -0500230O-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 -0500231
232* :doc:`O-DU Layer 2 Release-notes <o-du-l2:release-notes>`
233
234
weichencdf07332021-09-01 21:43:29 -0400235
weichena928dd22019-11-30 04:30:22 -0500236O-RAN Distributed Unit Low Layers (ODULOW) features
237^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500238
weichena928dd22019-11-30 04:30:22 -0500239O-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 -0500240
241* :doc:`O-DU Layer 1 Release-notes <o-du-phy:release-notes>`
242
243
weichencdf07332021-09-01 21:43:29 -0400244
weichena928dd22019-11-30 04:30:22 -0500245Infrastructure (INF) features
246^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500247
weichen57c0f402021-12-21 02:06:46 -0500248RTP O2 repository implements a reference O2 IMS and DMS service to expose O2 interface to SMO.
249
250* :doc:`RTP O2 Release-notes <pti-o2:release-notes>`
251
252
weichena928dd22019-11-30 04:30:22 -0500253Realtime Platform, which implements a real time platform to deploy the O-CU and O-DU components.
weichend773eca2019-11-29 05:17:40 -0500254
255* :doc:`Realtime Platform Release-notes <pti-rtp:release-notes>`
256
257
weichencdf07332021-09-01 21:43:29 -0400258
weichena928dd22019-11-30 04:30:22 -0500259Integration and Testing (INT) features
260^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
weichend773eca2019-11-29 05:17:40 -0500261
262IT-DEP hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying O-RAN SC software.
263
264* :doc:`IT-DEP Release-notes <it-dep:release-notes>`
265
266
weichen8a0ab4c2020-06-08 05:52:44 -0400267IT-DEV which integrates artifacts for developing Near Realtime RAN Intelligent Controller applications (xApps).
268
269* :doc:`IT-DEV Release-notes <it-dev:release-notes>`
270
271
weichen17164ba2019-12-01 22:54:28 -0500272IT-TEST, which contains:
273Test automation scripts written using the robot frameworkDeployment scripts for a dev-test 1-node Kubernetes cluster.
274A functional simulator for the E2 protocol that acts as gNB used to test the RIC.
275A workload generator that is used to benchmark the RIC
weichend773eca2019-11-29 05:17:40 -0500276
277* :doc:`IT-TEST Release-notes <it-test:release-notes>`
278
279
weichend773eca2019-11-29 05:17:40 -0500280IT-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.
281
282* :doc:`IT-Otf Release-notes <it-otf:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500283
284
285
weichen94f0a212021-12-15 03:45:00 -0500286Service Management and Orchestration (SMO) features
287^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
288
weichen57c0f402021-12-21 02:06:46 -0500289SMO O1 repository is for the implementation, installation, and use of the O1 interface of SMO. It uses the Software Defined Netowrk (SDN) Controller for Radio (SDNR) to implement the O1 interface. The software comes in the form of Docker containers that are setup using docker-compose.
290
291* :doc:`SMO O1 Release-notes <smo-o1:release-notes>`
292
293The O1/VES interface supports the monitoring side of SMO. The diagram below shows how the Network Elements interact with the O1/VES interface in the SMO.
weichen94f0a212021-12-15 03:45:00 -0500294
295* :doc:`SMO-VES Release-notes <smo-ves:release-notes>`
296
weichen45ff2d32022-07-13 01:51:16 -0400297SMO-O2 repository is for the implementation, installation, and use of the O2 interface of SMO. It uses the OpenStack Tacker to implement the O2 interface.
298
299* :doc:`SMO-O2 Release-notes <smo-o2:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500300
301
weichen57c0f402021-12-21 02:06:46 -0500302.. Simulations(SIM) Amber release features contain:
303
304.. * :doc:`SIM/O1-Interface Release-notes <sim-o1-interface:release-notes>`
weichen1a15d742019-11-28 08:28:08 -0500305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
weichen332b2872019-11-12 01:41:31 -0500321
322
323
324
325
326
327
328