Add more description of the project overview.
[pti/rtp.git] / docs / overview.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 Wind River Systems, Inc.
4
5 RTP Overview 
6 ============
7
8 This project implements a real time platform to deploy the O-CU and O-DU.
9
10 In O-RAN architecture, the O-DU and O-CU could have different deployed scenarios. 
11 In general the performance sensitive parts of the 5G stack require real time platform, 
12 the platform should support the Preemptive Scheduling feature. 
13
14 For example, from implementation perspective, the non-virtualized DU, 
15 VM based DU and container based DU are requiring a real time host system. 
16 Following requirements are going to address the container based solution:
17
18 1.Support Node Feature Discovery
19 2.Support CPU Affinity and Isolation
20 3.Support Dynamic HugePages Allocation
21
22 And for the network requirements, the following should be supported:
23 1.Multiple Networking Interface
24 2.High performance data plane including the DPDK based vswitch and PCI pass-through/SR-IOV.
25
26
27 This is based on Yocto/OpenEmbedded, so it includes a Yocto/OpenEmbedded compatible
28 layers meta-oran and wrapper scripts to pull all required Yocto/OE layers to build
29 out the reference platform.
30
31 About Yocto and OpenEmbedded
32 ----------------------------
33 The Yocto Project is an open source collaboration project that provides templates,
34 tools and methods to help you create custom Linux-based systems for embedded and
35 IOT products, regardless of the hardware architecture.
36
37 OpenEmbedded is a build automation framework and cross-compile environment used
38 to create Linux distributions for embedded devices. The OpenEmbedded framework
39 is developed by the OpenEmbedded community, which was formally established in 2003.
40 OpenEmbedded is the recommended build system of the Yocto Project, which is a Linux
41 Foundation workgroup that assists commercial companies in the development of Linux-based
42 systems for embedded products.
43
44 Contact info
45 ------------
46 If you need support or add new features/components, please feel free to contact the following:
47 - Jackie Huang <jackie.huang@windriver.com>
48 - Xiaohua Zhang <xiaohua.zhang@windriver.com>