Cherry release page for the O-RAN Software community
Welcome to the Cherry release page for the O-RAN Software community
This page contains all the information specific to the Cherry release
See Requirements and Software Architecture under Committees and Projects for more details on current activities.
Second release capabilities include contributions under the following projects:
Table of Contents |
---|
Get Bronze
- Use the master branch of the repos.
Documentation
- TODO
Cherry Release Timeline
Cherry Timeline
- Getting Started with Cherry to set up and run O-RAN
- Release Date:
- Source Code:
- Release Tar ball:
- Cherry release docker image list: Release Image List
- Source Code:
- Maintenance:
- Source Code:
- Release Changelog:
- it/dep: Add A1 STD V2 simulators. Fix bugs in helm 3 installation.
- scp/ric-app/kpimon: Release version 1.0.1. Use SDL library.
- nonrtric: Release new docker images. Fix maven project settings.
- ric-plt/ric-dep: Update alarmmanager helm charts.
- ric-plt/lib/rmr: Release new RMR version, fix multiple bugs.
- ric-plt/e2mgr: Update RMR version to 4.5.2.
- ric-plt/e2: Update RMR version to 4.5.2.
- ric-plt/alarm-go: Update RMR version to 4.5.2.
- ric-plt/o1: Update RMR version to 4.5.2.
- ric-plt/rtmgr: Update RMR version to 4.5.2.
- ric-plt/submgr: Update RMR version to 4.5.2.
- ric-plt/a1: Update RMR version to 4.5.2.
- sim/a1-interface: Update cherry release documents
Documentation
- Developer Documentation
- Highlighted use cases
- Service Management and Orchestration (SMO) [ RSAC LCM call flow ]
- Applications (xApps) [ RSAC Traffic Steering call flow ]
- O-DU
- Non-RT RIC
- A1 Enrichment Interface (A1-EI)
- Wiki
Cherry Release Timeline
Cherry Timeline
Near-Real-time RIC X-APPs (RICAPP) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Primary Goals: Expand the community working on open source xApps for O-RAN SC. Enhance the set of open source xApps in support of the R-SAC use cases (traffic steering, health check, life cycle management) as well new use cases. Update and enhance existing xApps to take advantage of the new features in xApp SDK (implemented by the xApp frameworks in C++, go, and python). | ||||||||||
Cherry release highlights (12-08-20):
| ||||||||||
PTL: Matti Hiltunen | ||||||||||
Jira: Count of Epics, User Stories, Tasks, and Issues:
| ||||||||||
Status (9-8-20): Integration of KPIMON in progress, new xApps under design, QP-Driver updated to use new SDK for alarms and metrics. Status (9-30-20): Samsung taking over integration and testing of KPIMON; Viavi simulator producing data - an update in the data content expected this week (UE throughput, UE ID); ML-model building started based on Viavi and other simulated data (QP, AD); new xApp repos requested (Signal Storm Protection, Load Prediction); bug fixes to HelloWorld, E2 AP/SM abstraction layer underway for HelloWorld. Status(11-17-20): ML-xApps (QP,AD) code committed - dealing with merge issues. End to end testing and bug fixes underway. E2AP/SM abstraction work for HelloWorld (C++) xApp completed. New repos created for HelloWorld in go and python (for Dawn). |
Near-Real-time RAN Intelligent Controller Platform (E2 Interface) (RICPLT) |
---|
Mission: Better manageability of, for example, E2 connections, the RIC platform as well as xApps via the xApp frameworks. Primary Goals: Support operator-initiated health-check via E2 and be able to close all current or reject all future E2 connections. More manageability of the RIC platform and xApps, including, for example, platform statistics from E2 and A1 and more capabilities in the language-specific xApp frameworks and SDL (shared data layer). |
Cherry release highlights (2020-12-01): We implemented the operator-initiated E2 connection health check. There is now more alignment in the level of support of various xapp framework and SDL features in python, c++ and go. For example: SDL (shared data layer) now also supports notifications in Python. The xApp framework for C++ now supports alarms, statistics and configuration management. xApps can now use SDL notifications for changes in connection states of E2 nodes. By confirming route updates before continuing we increased robustness in management of internal routes. We now also support using existing non-E2 protocols for communication with RAN. We also adapted the scaling implementation for E2 termination to the reversal of E2AP connection initiation introduced by E2AP 01.00. The E2 manager can now reject new E2 connections requests in addition to closing all E2 connections. E2 and A1 now provide platform statistics for their connections. Detailed list of JIRA items that we worked on in Cherry (requires LinuxFoundation login): Remaining open items: link (1 items). Items that are marked as done: link (23 items). Moved out from Cherry: link (24 = 13 stretch goal items and 11 "normal items"). |
PTL: Thoralf Czichy |
Status 2020-12-11: HCL: RIC-360 done. ATT: (e-mail sent): RIC-359 (likely postponed) Status 2020-12-08: HCL: DONE: RIC-149 (=RIC-362), RIC-509, RIC-109. // delayed into Dawn: RIC-150 // RIC-360: Code submitted & Merged CLOSE once gerrit review in RIUC-678 is done (see open review https://gerrit.o-ran-sc.org/r/c/it/dep/+/5237) ATT: (e-mail sent): RIC-359 (likely postponed) Status 2020-11-24: HCL: RIC-149, RIC-150, RIC-360, RIC-509. Ask if RIC-362 (duplicate of RIC-149) is already implemented by HCL. Nokia: (1) stats related: RIC-422 posytponed to early Dawn. Related stats-items (RIC-33, RIC-126) postponed to later (likelly ZZZ_future). (2) submgr related RIC-76 and RIC-71 were postponed. ATT: (e-mail sent): RIC-359 (likely postponed) Status 2020-11-05: Remaining open items RIC-56: I now moved all sub user storied for actual alarms as separate independent Epics. Can be tested with artiifical alarm or QP driver xApp alarm. The framework is ready. Marking RIC-56 as Done. RIC-57: two subitems open (for Nune 2020-11-12 reminder sent) and one for Timo (RIC-104). Two e-mails sent. Result: RIC-104 (not yet done, move out of Cherry) Done RIC-76: e-mail sent as item 6 in bulk mail. RIC-95: Completed (2020-11-12) RIC-359: Queried status. 2020-11-12: Reminder sent RIC-360, RIC-150. RIC-362, RIC-509: Reminder to subteam h1 sent. RIC-363: e-mail send to Matti. 2020-11-12: reminder sent and Matti will close it with some conclusions. DONE RIC-365 DONE. and remaining subuser stories (like RIC.429) moved to future work epic (RIC-681) RIC-367 DONE and two subitems moved to Dawn RIC-682. xapp-framework python. e-mail sent we need to get the E2AP work done, and then we could extract one subitem as own epic and clsoe teh oevrall item. RIC-422: e-mail send to Nune (bulk mail) Status 2020-09-30: (a) I (PTL) am happy to see HCL doing work on Sonarqube for repos. Much more work done by HCL in context of benchmarking (simulator work), new helm and k8s version, Redis cluster suppor and testing, JIRA link for team H1 (b) Samsung also doing key work items, e.g. for RIC-95 health check (with side affect of support for E2 SERVICE QUERY and related) - suffering from simulator support (RIC-372 already mentioned below), work started on demo (aka more elboarte hello world) xApp in go/python. (c) four items moved out of Cherry as already visible that not enough time: link . (d) 28 Cherry items = 4 moved out of Cherry + 10 done + 14 in progress or still to be started (e) Matti and Thoralf gave a presentation on RIC status in the virtual ONeS 2020 (link). Waiting for copyright/licensing results between O-RAN and O-RAN SC. Status 2020-09-02: (a) I (PTL) am happy to see teams from Samsung and HCL joining the project with them actively working on capabilities related to the E2 simulator (actually in Alex' simulator project), more test automation (using the robotframework), benchmarking, SDL (shared data layer). (b) RIC-372 was the first commit from these new participants (c) we might be aiming for self-certification under LF's CII badge level "basic", (d) work on O1-related functions, like E2 and A1 statistics, or some alarms already done. (e) Adaptation to E2APv1.1 (likely released in November) only happening post-Cherry. |
Non-Real-time RIC (A1 Interface) (NONRTRIC) | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Primary Goals:
| ||||||||||||||||||||||||||||||||||||||
Cherry Feature Scope:
Update - 06/October/2020
Update - 04/November/2020
Update - 08/December/2020
| ||||||||||||||||||||||||||||||||||||||
PTL: John Keeney | ||||||||||||||||||||||||||||||||||||||
Jira: Count of Epics (
|
OAM (O1 Interface) | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Primary Goals:
| ||||||||||||||||||||||||||||||||||||||||
Cherry Feature Scope:
Please see OAM Cherry page for further details | ||||||||||||||||||||||||||||||||||||||||
PTL: Martin Skorupski | ||||||||||||||||||||||||||||||||||||||||
Status: Jira: Count of Epics (
| ||||||||||||||||||||||||||||||||||||||||
Demo of OAM use cases |
O-RAN Central Unit (OCU) | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Primary Goals:
| ||||||||||||||||||||||||||||||||||||||||||||||||
Cherry Feature Scope: RRC:
NG:
E1:
F1:
| ||||||||||||||||||||||||||||||||||||||||||||||||
PTL: user-a934b | ||||||||||||||||||||||||||||||||||||||||||||||||
Jira: Count of Epics, User Stories, Tasks, and Issues:
|
O-DU High |
---|
Primary Goals:
|
Cherry Feature Scope:
|
Updated: 16 December 2020 Documentation and release related activities for Cherry release have been completed. Jira: EPICS Status below:
Dependency/Blockers:
|
O-DU Low | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Primary Goals:
| ||||||||||||||||||||||||
Cherry Release Feature Scope:
| ||||||||||||||||||||||||
PTL: @Zhimin Yuan | ||||||||||||||||||||||||
|
Near real-time RIC X-APPs (RICAPP)
Primary Goals: TODO
Cherry feature scope: TODO
PTL: Matti Hiltunen
Jira: Count of Epics, User Stories, Tasks, and Issues:
Jira | ||||||||
---|---|---|---|---|---|---|---|---|
|
Near Realtime RAN Intelligent Controller Platform (E2 Interface) (RIC-PLT)
Cherry feature scope: TODO
PTL: Thoralf Czichy
Status TODO
Non-Real-time RIC (A1 Interface) (NONRTRIC)
The primary goal of Non-RT RIC is to support intelligent RAN optimization by providing policy-based guidance, ML model management and enrichment information to the near-RT RIC function so that the RAN can optimize, e.g., RRM under certain conditions.
It can also perform intelligent radio resource management function in non-real-time interval (i.e., greater than 1 second).
Non-RT RIC can use data analytics and AI/ML training/inference to determine the RAN optimization actions for which it can leverage SMO services such as data collection and provisioning services of the O-RAN nodes.
Bronze Feature Scope:
Initial design and start implementation of NONRTRIC Platform.
Continue evolution of A1 interface.
Continue evolution of A1 Policy Management functions.
Modeling and implementation of the Non-RealTime RIC aspects of the "Health Check" and "Traffic Steering" use cases
PTL: John Keeney
Jira: Count of Epics (
Jira | ||||||||
---|---|---|---|---|---|---|---|---|
|
Jira | ||||||||
---|---|---|---|---|---|---|---|---|
|
Jira Charts | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
OAM (O1 Interface)
PTL: Martin Skorupski
Status:
- Please log in into Jira: https://jira.o-ran-sc.org/secure/RapidBoard.jspa?rapidView=8&projectKey=OAM&view=reporting&chart=sprintRetrospective&sprint=25
- ongoing work on SMO Distribution and Documentation
- Heathcheck use case can be demonstarted any time with real equipment in OWL
- First ideas for a Cherry Use Case: SoftwareManagement: Upgrade from xRan-fronthaul to o-ran-fronthaul to o-ran-o1-ru
- Close interworking with 3GPP yang editors via O-RAN Working Group 1 Modeling team - preparation of LS and CR
O-RAN Central Unit (OCU)
The O-CU project provides 5G SA reference implementation according to the O-RAN WG8 documents. In addition we provide the implementation of RRC SDAP PDCP and F1AP module and API between them.
Basic CU functions defined in O-RAN WG8
Support E2E use case defined in O-RAN
Bronze Feature Scope:
F1
- support Interface Management procedures
- support UE Context Management procedures
- support RRC Message Transfer procedures
- support System Information Procedures
SDAP
- support transfer of user plane data;
- support mapping between a QoS flow and a DRB for both DL and UL;
- support marking QoS flow ID in both DL and UL packets;
- support reflective QoS flow to DRB mapping for the UL SDAP data PDUs.
PDCP
- support transfer of data (user plane or control plane);
- support maintenance of PDCP SNs;
- support header compression and decompression using the ROHC protocol;
- support ciphering and deciphering;
- support integrity protection and integrity verification;
- support timer based SDU discard;
- support reordering and in-order delivery;
- support out-of-order delivery;
RRC
- support Broadcast of system information;
- support RRC connection control;
Ng
- support PDU Session Management Procedures
- support UE Context Management Procedures
- support Transport of NAS Messages Procedures
- support Interface Management Procedures
E1
- support Interface Management procedures
- support Bearer Context Management procedures
Jira: Count of Epics, User Stories, Tasks, and Issues:
Jira | ||||||
---|---|---|---|---|---|---|
|
Jira | ||||||
---|---|---|---|---|---|---|
|
Jira | ||||||
---|---|---|---|---|---|---|
|
|
|
Jira | ||||||
---|---|---|---|---|---|---|
|
Jira | ||||||
---|---|---|---|---|---|---|
|
O-DU High
Bronze Feature Scope:
- O-DU High layers (MAC, RLC and app):
- Re-align seed code to 3GPP Release 15.3.0
- Align seed code to WG8 AAD specification and interfaces
- Implementation of cell broadcast procedure and UE attach procedure (SA mode)
for FDD mode and FR1 (Numerology = 0, Bandwidth = 20 MHz) and basic scheduler APIs for single UE and single HARQ transmission
- F1-U interface development
- F1-C interface enhancement:
- Support for following additional F1AP messages:
- Initial UL RRC Message Transfer
- UL/DL RRC Message Transfer
- UE Context Setup Request/Response
- Enhance F1AP messages:
- F1AP Setup Request/Response
- GNB DU Config Update
- Support for following additional F1AP messages:
- Basic FAPI messages Implementation
Out of Scope:
- Use cases – Traffic Steering, Health Check related messages and call flows
- TDD functionality, NSA
- End to end testing
Limitations/Dependencies:
- FAPI Implementation – Dependency on O-DU Low to open source WLS files, interface files
- Testing: Currently only some unit testing can be done due to lack test infrastructure i.e UE or UE simulator, O-RU, O-CU and core components.
PTL: Sachin Srivastava
Jira: EPICS are mentioned below:
- https://jira.o-ran-sc.org/browse/ODUHIGH-1 - Done
- As an O-DU L2 developer, I want to create F1AP module based on F1 interface APIs and develop them as per the architecture defined
- https://jira.o-ran-sc.org/browse/ODUHIGH-8 - Done
- As an O-DU L2 developer, I want to implement FAPI interface towards O-DU low
- https://jira.o-ran-sc.org/browse/ODUHIGH-9 - Done
- As an O-DU L2 developer, I want to implement cell broadcast procedure at MAC Layer
- https://jira.o-ran-sc.org/browse/ODUHIGH-10 - WIP
- As an O-DU L2 developer, I want to implement UE attach procedure with basic scheduling
- https://jira.o-ran-sc.org/browse/ODUHIGH-11 - Done
- As an O-DU L2 developer, I want to implement E2 interface
- https://jira.o-ran-sc.org/browse/ODUHIGH-27 - Done
- As an O-DU L2 developer, I want to develop RLC layer interfaces
O-DU Low
Bronze Release highlights(Jun.8):
The Bronze Release includes:
- ORAN WG8 Software Specification compliant DU Low implementation including O-RAN FrontHaul compliant Radio<-> L1 interface, FAPI compliant L1<->L2 interfaces, and a shared memory and buffer management library for efficient L1<->L2 communication
- Ability to link in a high-performance L1 stack application with advanced 5GNR features including 3GPP TS 38.211, 212, 213, 214 and 215, running on Intel Xeon processor based O-DU hardware, and packaged with a comprehensive functional and performance evaluation framework.
Primary Goals: The O-RAN-SC-ODU LOW project provides reference implementation of ODU-LOW according to the O-RAN AAD specification (WG8) documents. The reference design will follow the open interface toward ODU HIGH, RRU and Accelerator, provide physical layer signal processing functionality according to ORAN specification and 3GPP .
Epics
Planning
Develop L1/L2 FAPI Interface API
1.Develop the L1/L2 FAPI API files
2.Develop the interface parse software for O-DU low software
Jira | ||||||
---|---|---|---|---|---|---|
|
Done
Develop O-DU Low binary
1.Upstream the O-DU low binary file with typical test cases
2.Provide loader for OSC to download and test
Jira | ||||||
---|---|---|---|---|---|---|
|
Done
Enhance O-RAN Front Haul Library
1.Develop new features, include support category B, Support block floating point compression and decompression
2.Develop the CI/CD infrastructure according to O-RAN requirement
Jira | ||||||
---|---|---|---|---|---|---|
|
Done
O-DU interface with accelerator
Depend on the specification definition(TBD)
Limitations/Dependencies:
- L1 binary license agreement – affact the L1 binary release
- ICC usage agreement – it'll affact FAPI lib, O-RAN FH lib compilation and execution. it'll affact L1 binary execution
Status update:
| ||
Simulators (SIM) | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Primary Goals:
| ||||||||||||||||||||||||||||
Cherry Feature Scope:
| ||||||||||||||||||||||||||||
PTL: Alex Stancu | ||||||||||||||||||||||||||||
Jira: Count of Epics, User Stories, Tasks, and Issues:
| ||||||||||||||||||||||||||||
Status (07 Oct. 2020):
|
Infrastructure (INF) | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Primary Goals:
| ||||||||||||||||||||||||||||||||||||||||
Cherry Feature Scope: TODO | ||||||||||||||||||||||||||||||||||||||||
PTL: Xiaohua Zhang | ||||||||||||||||||||||||||||||||||||||||
Jira: Count of Epics, User Stories, Tasks, and Issues:
|
Integration and Test (INT) | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Primary Goals: To support OSC project CI pipeline. To test and validate the components and use cases | |||||||||||||||||||||||||
Cherry Feature Scope:
| |||||||||||||||||||||||||
PTL: Zhe Huang | |||||||||||||||||||||||||
Jira: Count of Epics, User Stories, Tasks, and Issues:
|
Simulators (SIM)
PTL: Alex Stancu
|
Jira Charts | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Blockers: need resources for E2 Simulator enhancements for supporting Traffic Steering use case
Infrastructure (INF)
Bronze Feature Scope: Based on release Amber, support the ARM based system. Align with requirement of the O-Cloud, add more services such as fault management , configuraiton management , software management , host management and service management. Improve the automation by adopting the ansible, and integrate with INT project.
Bronze Releae Highlights:
- Implement the container based O-Cloud reference design, and with real time features which is critical for the performance sensitive application such as DU.
- Integrate the telco grade features include fault management, software management, service management, host management and configuration management which leverage from StarlingX.
- Support the ARM based real time Kubernetes cluster.
Status (28 Oct. 2020):
|
Documentation (DOC) |
---|
Primary Goals: TODO |
Bronze Feature Scope: TODO |
PTL: weichen ni |
Jira: Count of Epics, User Stories, Tasks, and Issues: |
PTL: Xiaohua Zhang
Jira: Count of Epics, User Stories, Tasks, and Issues:
Jira | ||||||||
---|---|---|---|---|---|---|---|---|
|
Integration and Test (INT)
PTL: user-d3360
Service Management and Orchestration (SMO) |
---|
Primary Goals: The 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). |
Cherry Feature Scope: SMO entered the Cherry release in the middle of third sprint of code development. As such its scope is fairly modest. They are validation of application packages, assuming that we can agree on the format of the package, on boarding of applications and storing them in a package catalog which also has to be agreed upon, and as a stretch goal, setting up an environment where YANG modules that will be used by O-RAN, whether they are from 3GPP, and O-RAN itself can be used by vendors developing RIC, CU, DU and the RU to test a MVP configuration. |
PTL: Mahesh Jethanandani |
Status: A proposal was made on application package format, and there was some agreement on it following the ETSI SOL 004 specification. The contributions into the SMO project currently validate that part of the agreement, and allow for Network Function, xApp and rApp vendors to validate their package using the tools developed in SMO. David Kinseyis driving package catalog requirements, which is LCM Step 3. But it was determined that package catalog can be implementation specific, and therefore SMO cannot validate any particular catalog. As such LCM Step 3 will be skipped. The second part of SMO was the setup of a framework for testing of YANG models that are going to be used by SMO and the Network Functions that constitute the O-RAN solution. Thanks Martin Skorupski, Zhe Huang , and Alex in setting up that framework in the OSC lab. For a detailed workflow and end-to-end test manual of the two parts, refer to Cherry Release Test Plans for SMO. Jira: Count of Epics ( |
|
|
|
|
| ||||||||||
Documentation (DOC) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Primary Goals: Bronze release documentation for OSC and developers | ||||||||||
Bronze Feature Scope: Improve current documentation skeleton and content, make documentation more understandable for readers. Focusing on integration documentation, the new feature of Bronze release. | ||||||||||
PTL: weichen ni | ||||||||||
Jira: Count of Epics, User Stories, Tasks, and Issues: | ||||||||||