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 Infrastructure 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 3.Support CPU Affinity and Isolation
  23
  24 4.Support Dynamic HugePages Allocation
  25
  26
  27 And for the network requirements, the following should be supported:
  28
  29 1.Multiple Networking Interface
  30
  31
  32 2.High performance data plane including the DPDK based vswitch and PCI pass-through/SR-IOV.
  33
  34
  35 In the Bronze release, the following components and services are enabled:
  36
  37 1. Fault Management
  38
  39    - Framework for infrastructure services to raise and persist alarm and event data.
  40
  41      - Set, clear and query customer alarms
  42
  43      - Generate customer logs for significant events
  44
  45    - Maintains an Active Alarm List
  46
  47    - Provides REST API to query alarms and events, also available through SNMP traps
  48
  49    - Support for alarm suppression
  50
  51    - Operator alarms
  52
  53      - On platform nodes and resources
  54
  55      - On hosted virtual resources
  56
  57    - Operator logs - Event List
  58
  59      - Logging of sets/clears of alarms
  60
  61      - Related to platform nodes and resources
  62
  63      - Related to hosted virtual resources
  64
  65 2. Configuration Management
  66
  67    - Manages Installation and Commissioning
  68
  69      - Auto-discover of new nodes
  70
  71      - Full Infrastructure management
  72
  73      - Manage installation parameters (i.e. console, root disks)
  74
  75    - Nodal Configuration
  76
  77      - Node role, role profiles
  78
  79      - Core, memory (including huge page) assignments
  80
  81      - Network Interfaces and storage assignments
  82
  83    - Hardware Discovery
  84
  85      - CPU/cores, SMT, processors, memory, huge pages
  86
  87      - Storage, ports
  88
  89      - GPUs, storage, Crypto/compression H/W
  90
  91 3. Software Management
  92
  93    - Manages Installation and Commissioning
  94
  95      - Auto-discover of new nodes
  96
  97      - Full Infrastructure management
  98
  99      - Manage installation parameters (i.e. console, root disks)
 100
 101    - Nodal Configuration
 102
 103      - Node role, role profiles
 104
 105      - Core, memory (including huge page) assignments
 106
 107      - Network Interfaces and storage assignments
 108
 109    - Hardware Discovery
 110
 111      - CPU/cores, SMT, processors, memory, huge pages
 112
 113      - Storage, ports
 114
 115      - GPUs, storage, Crypto/compression H/W
 116 4. Host Management
 117
 118    - Full life-cycle and availability management of the physical hosts
 119
 120    - Detects and automatically handles host failures and initiates recovery
 121
 122    - Monitoring and fault reporting for:
 123
 124      - Cluster connectivity
 125
 126      - Critical process failures
 127
 128      - Resource utilization thresholds, interface states
 129
 130      - H/W fault / sensors, host watchdog
 131
 132      - Activity progress reporting
 133
 134    - Interfaces with board management (BMC)
 135
 136      - For out of band reset
 137
 138      - Power-on/off
 139
 140      - H/W sensor monitoring
 141 5. Service Management
 142
 143    - Manages high availability of critical infrastructure and cluster services
 144
 145      - Supports many redundancy models: N, or N+M
 146
 147      - Active or passive monitoring of services
 148
 149      - Allows for specifying the impact of a service failure and escalation policy
 150
 151      - Automatically recovers failed services
 152
 153    - Uses multiple messaging paths to avoid split-brain communication failures
 154
 155      - Up to 3 independent communication paths
 156
 157      - LAG can also be configured for multi-link protection of each path
 158
 159      - Messages are authenticated using HMAC
 160
 161      - SHA-512 if configured / enabled on an interface by-interface basis
 162 6. Support the ansible bootstrap to implement the zero touch provisioning
 163
 164 Enable the ansible configuration functions for infrastructure itself including the image installation and service configuration.
 165
 166
 167 NOTE: These features leverage the StarlingX (www.starlingx.io). And in Bronze release, these features are only avalaible for IA platform.
 168
 169 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.
 170
 171 About Yocto and OpenEmbedded
 172 ----------------------------
 173 The Yocto Project is an open source collaboration project that provides templates,
 174 tools and methods to help you create custom Linux-based systems for embedded and
 175 IOT products, regardless of the hardware architecture.
 176
 177 OpenEmbedded is a build automation framework and cross-compile environment used
 178 to create Linux distributions for embedded devices. The OpenEmbedded framework
 179 is developed by the OpenEmbedded community, which was formally established in 2003.
 180 OpenEmbedded is the recommended build system of the Yocto Project, which is a Linux
 181 Foundation workgroup that assists commercial companies in the development of Linux-based
 182 systems for embedded products.
 183
 184
 185 About StarlingX
 186 ---------------
 187 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.
 188
 189 Contact info
 190 ------------
 191 If you need support or add new features/components, please feel free to contact the following:
 192
 193 - Jackie Huang <jackie.huang@windriver.com>
 194
 195 - Xiaohua Zhang <xiaohua.zhang@windriver.com>