f4be9c22efcc7a81a7e921776c0acd4938053f42
[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 (INF)
6 ==================
7
8 This project implements a real time platform (rtp) 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 The could be container based or VM based, in this release, we only cover the container one. 
12 In general the performance sensitive parts of the 5G stack require real time platform,
13 especially for O-DU, the L1 and L2 are requiring the real time feature,
14 the platform should support the Preemptive Scheduling feature. 
15  
16 Following requirements are going to address the container based solution:
17
18 1.Support the real time kernel
19
20 2.Support Node Feature Discovery
21
22
23 3.Support CPU Affinity and Isolation
24
25
26 4.Support Dynamic HugePages Allocation
27
28
29 And for the network requirements, the following should be supported:
30
31 1.Multiple Networking Interface
32
33
34 2.High performance data plane including the DPDK based vswitch and PCI pass-through/SR-IOV.
35
36
37 In the Bronze release, the following components and services are enabled:
38
39 1. Fault Management
40
41 2. Configuration Management
42
43 3. Software Management
44
45 4. Host Management
46
47 5. Service Management
48
49 6. Support the ansible bootstrap to implement the zero touch provisioning
50
51 NOTE: These features leverage the StarlingX (www.starlingx.io). And in Bronze release, these features are only avalaible for IA platform.
52
53 NOTE: In this release single server solution is supported only. All the functionalities include controller functions, storage functions and compute functions are integrated in the single server.  
54
55 About Yocto and OpenEmbedded
56 ----------------------------
57 The Yocto Project is an open source collaboration project that provides templates,
58 tools and methods to help you create custom Linux-based systems for embedded and
59 IOT products, regardless of the hardware architecture.
60
61 OpenEmbedded is a build automation framework and cross-compile environment used
62 to create Linux distributions for embedded devices. The OpenEmbedded framework
63 is developed by the OpenEmbedded community, which was formally established in 2003.
64 OpenEmbedded is the recommended build system of the Yocto Project, which is a Linux
65 Foundation workgroup that assists commercial companies in the development of Linux-based
66 systems for embedded products.
67
68
69 About StarlingX
70 ---------------
71 StarlingX is a complete cloud infrastructure software stack for the edge used by the most demanding applications in industrial IOT, telecom, video delivery and other ultra-low latency use cases. With deterministic low latency required by edge applications, and tools that make distributed edge manageable, StarlingX provides a container-based infrastructure for edge implementations in scalable solutions that is ready for production now.
72
73 Contact info
74 ------------
75 If you need support or add new features/components, please feel free to contact the following:
76 - Jackie Huang <jackie.huang@windriver.com>
77 - Xiaohua Zhang <xiaohua.zhang@windriver.com>