From 361ea43f4c71f511b495fad4832c0c969eb4b1da Mon Sep 17 00:00:00 2001 From: Xiaohua Zhang Date: Wed, 27 May 2020 17:17:34 -0400 Subject: [PATCH] Update the doc overview and release note. Issue-ID: INF-16 Signed-off-by: Xiaohua Zhang Change-Id: I398b636d1e0dc55ce2de58942e5e80a2b41822f2 --- docs/overview.rst | 49 ++++++++++++++++++++++++++++++++++--------------- docs/release-notes.rst | 17 +++++++++++++++-- 2 files changed, 49 insertions(+), 17 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index ea04455..f4be9c2 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -2,41 +2,55 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2019 Wind River Systems, Inc. -RTP Overview -============ +RTP Overview (INF) +================== -This project implements a real time platform to deploy the O-CU and O-DU. +This project implements a real time platform (rtp) to deploy the O-CU and O-DU. -In O-RAN architecture, the O-DU and O-CU could have different deployed scenarios. -In general the performance sensitive parts of the 5G stack require real time platform, +In O-RAN architecture, the O-DU and O-CU could have different deployed scenarios. +The could be container based or VM based, in this release, we only cover the container one. +In general the performance sensitive parts of the 5G stack require real time platform, +especially for O-DU, the L1 and L2 are requiring the real time feature, the platform should support the Preemptive Scheduling feature. - -For example, from implementation perspective, the non-virtualized DU, -VM based DU and container based DU are requiring a real time host system. + Following requirements are going to address the container based solution: -1.Support Node Feature Discovery +1.Support the real time kernel + +2.Support Node Feature Discovery -2.Support CPU Affinity and Isolation +3.Support CPU Affinity and Isolation -3.Support Dynamic HugePages Allocation +4.Support Dynamic HugePages Allocation And for the network requirements, the following should be supported: + 1.Multiple Networking Interface 2.High performance data plane including the DPDK based vswitch and PCI pass-through/SR-IOV. -It will support the X86_64 and ARM. +In the Bronze release, the following components and services are enabled: + +1. Fault Management + +2. Configuration Management + +3. Software Management +4. Host Management -This is based on Yocto/OpenEmbedded, so it includes a Yocto/OpenEmbedded compatible -layers meta-oran and wrapper scripts to pull all required Yocto/OE layers to build -out the reference platform. +5. Service Management + +6. Support the ansible bootstrap to implement the zero touch provisioning + +NOTE: These features leverage the StarlingX (www.starlingx.io). And in Bronze release, these features are only avalaible for IA platform. + +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. About Yocto and OpenEmbedded ---------------------------- @@ -51,6 +65,11 @@ OpenEmbedded is the recommended build system of the Yocto Project, which is a Li Foundation workgroup that assists commercial companies in the development of Linux-based systems for embedded products. + +About StarlingX +--------------- +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. + Contact info ------------ If you need support or add new features/components, please feel free to contact the following: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 4602988..be44bd2 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -7,7 +7,7 @@ Release-notes ============= -This document provides the release notes for 1.0.0 of RTP. +This document provides the release notes for 2.0.0 of RTP. .. contents:: :depth: 3 @@ -24,13 +24,25 @@ Version history | 2019-11-02 | 1.0.0 | Jackie Huang | Initial version | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| | | | | +| 2020-06-14 | 2.0.0. | Xiaohua Zhang | | | | | | | +--------------------+--------------------+--------------------+--------------------+ | | | | | | | | | | +--------------------+--------------------+--------------------+--------------------+ +Version 2.0.0, 2020-06-14 +------------------------- +- Second version (Bronze) +- Based on Yocto version 2.7 +- Linux kernel 5.0 with preempt-rt patches +- Leverage the StarlingX 3.0 +- Support the AIO (all-in-one) deployment scenario +- With Software Management, Configuration Management, Host Management, Service Management, and Service Management enabled for IA platform +- Support the Kubernetes Cluster for ARM platform (verified by NXP LX2160A) +- With the ansbile bootstrap supported for IA platform + + Version 1.0.0, 2019-11-02 ------------------------- - Initial Version @@ -45,3 +57,4 @@ Version 1.0.0, 2019-11-02 - node-feature-discovery-0.4.0 - cpu-manager-for-kubernetes-1.3.1 + -- 2.16.6