docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 CMCC
   4
   5 Release-Notes
   6 =============
   7
   8
   9 This document provides the release notes for O-RAN SC.
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15
  16 Version history
  17 ---------------
  18
  19 +--------------------+--------------------+--------------------+--------------------+
  20 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  21 |                    |                    |                    |                    |
  22 +--------------------+--------------------+--------------------+--------------------+
  23 | 2019-11-31         | Amber              | CMCC               | Amber Release      |
  24 |                    |                    |                    |                    |
  25 +--------------------+--------------------+--------------------+--------------------+
  26 | 2020-06-21         | Bronze             | CMCC               | Bronze Release     |
  27 |                    |                    |                    |                    |
  28 +--------------------+--------------------+--------------------+--------------------+
  29 | 2020-12-21         | Cherry             | CMCC               | Cherry Release     |
  30 |                    |                    |                    |                    |
  31 +--------------------+--------------------+--------------------+--------------------+
  32 | 2021-07-15         | D                  | CMCC               | D Release          |
  33 |                    |                    |                    |                    |
  34 +--------------------+--------------------+--------------------+--------------------+
  35 | 2021-12-15         | E                  | CMCC               | E Release          |
  36 |                    |                    |                    |                    |
  37 +--------------------+--------------------+--------------------+--------------------+
  38 | 2022-7-06          | F                  | CMCC               | F Release          |
  39 |                    |                    |                    |                    |
  40 +--------------------+--------------------+--------------------+--------------------+
  41 | 2022-12-16         | G                  | CMCC               | G Release          |
  42 |                    |                    |                    |                    |
  43 +--------------------+--------------------+--------------------+--------------------+
  44 | 2023-7-04          | H                  | CMCC               | H Release          |
  45 |                    |                    |                    |                    |
  46 +--------------------+--------------------+--------------------+--------------------+
  47 | 2023-12-04         | I                  | CMCC               | I Release          |
  48 |                    |                    |                    |                    |
  49 +--------------------+--------------------+--------------------+--------------------+
  50
  51
  52 Release Summary
  53 ---------------
  54
  55 RAN Intelligent Controller Applications (RICAPP) features
  56 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  57
  58 .. * :doc:`Alarm Go Library Release-notes <ric-plt-alarm-go:release-notes>`
  59
  60 .. 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.
  61
  62 .. * :doc:`Admission Control xAPP Release-notes <ric-app-admin:release-notes>`
  63
  64 GS-lite, which is an open-source, real-time, low-latency, high-throughput stream processing engine.
  65 It is a fork of cask/tigon (https://github.com/cdapio/tigon) maintained to serve the needs of RIC applications (currently MC xApp).
  66
  67 * :doc:`GS-lite Stream Processing Engine Release-notes <com-gs-lite:release-notes>`
  68
  69
  70 The HelloWorld(HW) xAPP repository contains open-source code for a prototype xAPP for near real-time RAN Intelligent Controller.
  71
  72 * :doc:`HelloWorld xAPP Release-notes <ric-app-hw:release-notes>`
  73
  74
  75 The KPI Mon xAPP, which supports full closed loop control for CuCpResourceStatusReport from multiple gNBs and stores the metrics in Redis DB.
  76
  77 * :doc:`KPI monitoring Release-notes <ric-app-kpimon:release-notes>`
  78
  79
  80 QoE Predictor (QP) is an Xapp in the Traffic Steering O-RAN use case.
  81
  82 * :doc:`QoE Predictor xApp Release-notes <ric-app-qp:release-notes>`
  83
  84
  85 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.
  86
  87 * :doc:`RIC APP ML Release-notes <ric-app-ml:release-notes>`
  88
  89
  90 The MC xAPP, which supports calculation of a number of metrics and KPIs based on X2 messages received from UEEC.
  91
  92 * :doc:`RIC Measurement Campaign (MC) xApp Release-notes <ric-app-mc:release-notes>`
  93
  94
  95 Anomaly Detection (AD) is an xApp in the Traffic Steering O-RAN use case.
  96
  97 * :doc:`Anomaly Detection xApp Release-notes <ric-app-ad:release-notes>`
  98
  99
 100 This 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.
 101
 102 * :doc:`HW-go xAPP Release-notes <ric-app-hw-go:release-notes>`
 103
 104
 105
 106 Near Realtime RAN Intelligent Controller (RIC) features
 107 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 108
 109 The 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).
 110
 111 * :doc:`A1 Release-notes <ric-plt-a1:release-notes>`
 112
 113
 114 Asn1-documents, which contains a description of the E2 used in the near-RT RIC implementation under O-RAN-SC.
 115
 116 * :doc:`ASN.1 Documents Release-notes <ric-plt-asn1-documents:release-notes>`
 117
 118
 119 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.
 120
 121 * :doc:`DBAAS Release-notes <ric-plt-dbaas:release-notes>`
 122
 123 .. * :doc:`E2 Release-notes <ric-plt-e2:release-notes>`
 124 .. * :doc:`E2MGR Release-notes <ric-plt-e2mgr:release-notes>`
 125
 126 Golang, which is an implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
 127
 128 * :doc:`GOLOG Release-notes <com-golog:release-notes>`
 129
 130
 131 Jaegeradapter, which contains jaeger configuration files. This first version only supports configuration for a jaeger-all-in-one deployment.
 132
 133 * :doc:`Jaegeradapter Release-notes <ric-plt-jaegeradapter:release-notes>`
 134
 135
 136 LOG, which is a thread-safe logging C API library with Mapped Diagnostics Context (MDC) support.
 137
 138 * :doc:`LOG Release-notes <com-log:release-notes>`
 139
 140 .. * :doc:`nodeb-rnib Release-notes <ric-plt-nodeb-rnib:release-notes>`
 141
 142 PYLOG, which implements a structured logging library with Mapped Diagnostic Context (MDC).
 143
 144 * :doc:`PYLOG Release-notes <com-pylog:release-notes>`
 145
 146 .. * :doc:`Resource Status Manager Release-notes <ric-plt-resouce-status-manager:release-notes>`
 147 .. * :doc:`RIC Message Router Release-notes <ric-plt-lib-rmr:release-notes>`
 148 .. * :doc:`Routing Manager Release-notes <ric-plt-rtmgr:release-notes>`
 149
 150 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.
 151
 152 * :doc:`Shared Data Layer (SDL) in C++ Release-notes <ric-plt-sdl:release-notes>`
 153
 154
 155 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.
 156
 157 * :doc:`Shared Data Layer (SDL) in Go Release-notes <ric-plt-sdlgo:release-notes>`
 158
 159
 160 Streaming Protobufs, which provides a Protobuf schema for selected set of X2 Application Protocol messages.
 161
 162 * :doc:`Streaming Protobufs Release-notes <ric-plt-streaming-protobufs:release-notes>`
 163
 164 .. * :doc:`Subscription Manager Release-notes <ric-plt-submgr:release-notes>`
 165
 166 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.
 167
 168 * :doc:`Tracelibcpp Release-notes <ric-plt-tracelibcpp:release-notes>`
 169
 170
 171 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.
 172
 173 * :doc:`Tracelibgo Release-notes <ric-plt-tracelibgo:release-notes>`
 174
 175
 176 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).
 177
 178 * :doc:`Vespamgr Release-notes <ric-plt-vespamgr:release-notes>`
 179
 180
 181 xapp-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
 182
 183 * :doc:`xapp-frame Release-notes <ric-plt-xapp-frame:release-notes>`
 184
 185 .. * :doc:`xAPP C++ Release-notes <ric-plt-xapp-frame-cpp:release-notes>`
 186 .. * :doc:`xApp Python Release-notes<ric-plt-xapp-frame-py:release-notes>`
 187
 188
 189
 190 Non-RealTime RAN Intelligent Controller (NONRTRIC) features
 191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 192
 193 In Bronze release, Non-RT RIC containes Policy Agent, Control Panel and A1 Simulator.
 194
 195 * :doc:`Non-RT RIC Release-notes <nonrtric:release-notes>`
 196
 197
 198
 199 Operations and Maintenance (OAM) features
 200 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 201
 202 OAM which provides reference implementation according to the O-RAN OAM (WG1) documents.
 203
 204 * :doc:`OAM Operation and Maintenance Release-notes <oam:release-notes>`
 205 * :doc:`TR069 Adapter Release-notes <oam-tr069-adapter:release-notes>`
 206 * :doc:`NF OAM Adopter Release-notes <oam-nf-oam-adopter:release-notes>`
 207
 208
 209 The 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.
 210
 211 * :doc:`RIC Dashboard Release-notes <portal-ric-dashboard:release-notes>`
 212
 213
 214
 215 O-RAN Central Unit (OCU) features
 216 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 217
 218 5G NR which is a RAN Software Reference Design for a 5G protocol stack
 219
 220 .. * :doc:`Open LTE Release-notes <scp-ocu-openlte:release-notes>`
 221
 222
 223 O-RAN Distributed Unit High Layers (ODUHIGH) features
 224 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 225
 226 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.
 227
 228 * :doc:`O-DU Layer 2 Release-notes <o-du-l2:release-notes>`
 229
 230
 231
 232 O-RAN Distributed Unit Low Layers (ODULOW) features
 233 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 234
 235 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.
 236
 237 * :doc:`O-DU Layer 1 Release-notes <o-du-phy:release-notes>`
 238
 239
 240
 241 Infrastructure (INF) features
 242 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 243
 244 RTP O2 repository implements a reference O2 IMS and DMS service to expose O2 interface to SMO.
 245
 246 * :doc:`RTP O2 Release-notes <pti-o2:release-notes>`
 247
 248
 249 Realtime Platform, which implements a real time platform to deploy the O-CU and O-DU components.
 250
 251 * :doc:`Realtime Platform Release-notes <pti-rtp:release-notes>`
 252
 253
 254
 255 Integration and Testing (INT) features
 256 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 257
 258 IT-DEP hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying O-RAN SC software.
 259
 260 * :doc:`IT-DEP Release-notes <it-dep:release-notes>`
 261
 262
 263 IT-DEV which integrates artifacts for developing Near Realtime RAN Intelligent Controller applications (xApps).
 264
 265 * :doc:`IT-DEV Release-notes <it-dev:release-notes>`
 266
 267
 268 IT-TEST, which  contains:
 269 Test automation scripts written using the robot frameworkDeployment scripts for a dev-test 1-node Kubernetes cluster.
 270 A functional simulator for the E2 protocol that acts as gNB used to test the RIC.
 271 A workload generator that is used to benchmark the RIC
 272
 273 * :doc:`IT-TEST Release-notes <it-test:release-notes>`
 274
 275
 276 IT-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.
 277
 278 * :doc:`IT-Otf Release-notes <it-otf:release-notes>`
 279
 280
 281
 282 Service Management and Orchestration (SMO) features
 283 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 284
 285 SMO 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.
 286
 287 * :doc:`SMO O1 Release-notes <smo-o1:release-notes>`
 288
 289 The 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.
 290
 291 * :doc:`SMO-VES Release-notes <smo-ves:release-notes>`
 292
 293 SMO-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.
 294
 295 * :doc:`SMO-O2 Release-notes <smo-o2:release-notes>`
 296
 297
 298 .. Simulations(SIM) Amber release features contain:
 299
 300 .. * :doc:`SIM/O1-Interface Release-notes <sim-o1-interface:release-notes>`
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324