Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / doc / ac773628ad1da1a1aabd96cefec93799545e146f / . / docs / projects.rst
blob: 3f218024faf22ddaadce2fe96ad49676e6682b43 [file] [log] [blame]
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. SPDX-License-Identifier: CC-BY-4.0
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]3.. Copyright (C) 2019 CMCC
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]4
weichendbea4a62020-02-26 22:39:51 -0500[diff] [blame]5.. index rst file
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]6
7
weichendbea4a62020-02-26 22:39:51 -0500[diff] [blame]8O-RAN SC Projects
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]9===============================
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]10
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]11RAN Intelligent Controller Applications (RICAPP)
12------------------------------------------------
13RICAPP includes open source sample xAPPs and platform applications that can we used for integration, testing, and demonstrations.
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]14
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]15More detailed function documentation can be found as follow:
16
weichenab5e08b2020-06-09 23:41:48 -0400[diff] [blame]17* :doc:`Alarm Go Library <ric-plt-alarm-go:index>`
weichen664c5322019-11-20 02:24:51 -0500[diff] [blame]18* :doc:`Admission Control xAPP <ric-app-admin:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]19* :doc:`GS-lite Stream Processing Engine <com-gs-lite:index>`
weichenab5e08b2020-06-09 23:41:48 -0400[diff] [blame]20* :doc:`HelloWorld xAPP <ric-app-hw:index>`
weichena00e30f2019-11-27 04:47:28 -0500[diff] [blame]21* :doc:`KPI monitoring <ric-app-kpimon:index>`
weichenab5e08b2020-06-09 23:41:48 -0400[diff] [blame]22* :doc:`QoE Predictor xApp <ric-app-qp:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]23* :doc:`RIC APP ML <ric-app-ml:index>`
24* :doc:`RIC Measurement Campaign (MC) xApp <ric-app-mc:index>`
weichenab5e08b2020-06-09 23:41:48 -0400[diff] [blame]25* :doc:`Traffic Steering xAPP <ric-app-ts:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]26
weichen10a1e572019-11-17 22:43:06 -0500[diff] [blame]27
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]28Near Realtime RAN Intelligent Controller (RIC)
29----------------------------------------------
30This project a initial RIC Platform to support xAPPs with limited support for O1, A1, and E2 interfaces.
weichen10a1e572019-11-17 22:43:06 -0500[diff] [blame]31
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]32More detailed function documentation can be found as follow:
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]33
weichen914edd62019-11-14 02:01:38 -0500[diff] [blame]34* :doc:`A1 <ric-plt-a1:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]35* :doc:`ASN.1 Documents <ric-plt-asn1-documents:index>`
weichen914edd62019-11-14 02:01:38 -0500[diff] [blame]36* :doc:`DBAAS <ric-plt-dbaas:index>`
weichenef2d6c12019-12-02 02:42:54 -0500[diff] [blame]37* :doc:`E2 <ric-plt-e2:index>`
38* :doc:`E2MGR <ric-plt-e2mgr:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]39* :doc:`GOLOG <com-golog:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]40* :doc:`Jaegeradapter <ric-plt-jaegeradapter:index>`
41* :doc:`LOG <com-log:index>`
weichenef2d6c12019-12-02 02:42:54 -0500[diff] [blame]42* :doc:`nodeb-rnib <ric-plt-nodeb-rnib:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]43* :doc:`PYLOG <com-pylog:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]44* :doc:`Reasouce Status Manager <ric-plt-resource-status-manager:index>`
45* :doc:`RIC Message Router <ric-plt-lib-rmr:index>`
weichen914edd62019-11-14 02:01:38 -0500[diff] [blame]46* :doc:`Routing Manager <ric-plt-rtmgr:index>`
47* :doc:`Shared Data Layer (SDL) in C++ <ric-plt-sdl:index>`
48* :doc:`Shared Data Layer (SDL) in Go <ric-plt-sdlgo:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]49* :doc:`Streaming Protobufs <ric-plt-streaming-protobufs:index>`
weichenef2d6c12019-12-02 02:42:54 -0500[diff] [blame]50* :doc:`Subscription Manager <ric-plt-submgr:index>`
weichen914edd62019-11-14 02:01:38 -0500[diff] [blame]51* :doc:`Tracelibcpp <ric-plt-tracelibcpp:index>`
52* :doc:`Tracelibgo <ric-plt-tracelibgo:index>`
53* :doc:`Vespamgr <ric-plt-vespamgr:index>`
weichend25cbea2020-06-10 02:12:45 -0400[diff] [blame]54* :doc:`xapp-frame <ric-plt-xapp-frame:index>`
55* :doc:`xAPP C++ <ric-plt-xapp-frame-cpp:index>`
56* :doc:`xApp Python <ric-plt-xapp-frame-py:index>`
weichen914edd62019-11-14 02:01:38 -0500[diff] [blame]57
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]58
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]59Non-RealTime RAN Intelligent Controller (NONRTRIC)
60--------------------------------------------------
elinuxhenrike8796f52020-04-14 17:09:16 +0200[diff] [blame]61Non-RT RIC focus on feature functionality of A1-interface (consumer and provider), and closed-loop use cases. The Non-RT RIC project will also work together with the OAM project to align activities on a case-by-case base for O1 interfaces. Project should focus on use cases supported in ONAP. The work should be sponsored in O-RAN and initial code contributions in O-RAN SC. Interoperability with ONAP should be aligned between the standards and will follow initial contributions in this project.
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]62
63More detailed function documentation can be found as follow:
64
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]65* :doc:`A1 Interface Simulator <sim-a1-interface:index>`
elinuxhenrike8796f52020-04-14 17:09:16 +0200[diff] [blame]66* :doc:`Non-RT RIC Policy Agent <nonrtric:index>`
67* :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]68
69
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]70Operations and Maintenance (OAM)
71--------------------------------
72The O-RAN-SC-OAM project provides reference implementation according to the O-RAN OAM (WG1) documents. In addition we provide a common MnS-Consumer for development and module test purposes. The assumption is that the projects for the ManagedElements can concentrate on the more important user-plane.
73
74More detailed function documentation can be found as follow:
75
weichen443311b2019-11-29 01:42:15 -0500[diff] [blame]76* :doc:`OAM Operation and Maintenance <oam:index>`
weichen914edd62019-11-14 02:01:38 -0500[diff] [blame]77* :doc:`RIC Dashboard <portal-ric-dashboard:index>`
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]78
79
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]80O-RAN Central Unit (OCU)
81------------------------
82The OCU is target an initial software deliverable with limited functionality. Focus on aa basic E2 interface to enable initial integration testing between RIC and OCU.
83
84More detailed function documentation can be found as follow:
85
weichenac773622020-06-19 00:26:23 -0400[diff] [blame^]86.. * :doc:`Open LTE <scp-ocu-openlte:index>`
87
88* :doc:`5G NR <scp-ocu-5gnr:index>`
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]89
90
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]91O-RAN Distributed Unit High Layers (ODUHIGH)
92--------------------------------------------
93Focus on initial L2 functional blocks based on seed code contributions.
94
95More detailed function documentation can be found as follow:
weichen635c0af2019-11-20 04:25:54 -0500[diff] [blame]96
weichen664c5322019-11-20 02:24:51 -0500[diff] [blame]97* :doc:`O-DU Layer 2 <o-du-l2:index>`
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]98
99
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]100O-RAN Distributed Unit Low Layers (ODULOW)
101------------------------------------------
102Focus on initial L1 functional blocks based on seed code contributions.
103
104More detailed function documentation can be found as follow:
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]105
weichen0829aea2019-11-20 22:37:22 -0500[diff] [blame]106* :doc:`O-DU Layer 1 <o-du-phy:index>`
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]107
weichen664c5322019-11-20 02:24:51 -0500[diff] [blame]108
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]109Infrastructure (INF)
110--------------------
111Initial building blocks for infrastructure to run O-RAN NF components.
112
113More detailed function documentation can be found as follow:
114
115* :doc:`Realtime Platform <pti-rtp:index>`
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]116
117
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]118Simulations(SIM)
119----------------
120Initial simulators used for testing O-RAN NF interfaces.
121
122More detailed function documentation can be found as follow:
123
weichen10a1e572019-11-17 22:43:06 -0500[diff] [blame]124* :doc:`SIM/O1-Interface <sim-o1-interface:index>`
weichen332b2872019-11-12 01:41:31 -0500[diff] [blame]125
126
weichen58b8cbc2019-11-18 03:47:15 -0500[diff] [blame]127Integration and Testing (INT)
128-----------------------------
129The integration and test effort will focus on testing the requirements documented in each release. This will focus on end to end test and use case testing.
130
131INF Testing shall primarily be done on the Akraino-REC (Radio Edge Cloud) blueprint. While Non-RT RIC and O1 interface testing will primarily use ONAP components.
132
133More detailed function documentation can be found as follow:
134
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]135* :doc:`IT-DEP <it-dep:index>`
weichend773eca2019-11-29 05:17:40 -0500[diff] [blame]136* :doc:`IT-DEV <it-dev:index>`
137* :doc:`IT-OTF <it-otf:index>`
weichen862f8822020-06-08 04:51:03 -0400[diff] [blame]138* :doc:`IT-TEST <it-test:index>`
weichen10a1e572019-11-17 22:43:06 -0500[diff] [blame]139
140
141
142