README.md

SPDX-License-Identifier: Apache-2.0
Copyright (c) 2019-2020 Intel Corporation

OpenNESS Quick Start

Network Edge

Step 1. Get Hardware ► Step 2. Getting started ► Step 3. Applications Onboarding

OpenNESS solution documentation index

Below is the complete list of OpenNESS solution documentation

Architecture

• architecture.md: OpenNESS Architecture overview
• flavors.md: OpenNESS Deployment Flavors

Getting Started - Setup

• getting-started: Folder containing how to get started with installing and trying OpenNESS Network Edge solutions
  • openness-experience-kits.md: Overview of the OpenNESS Experience kits that are used to install the Network Edge solutions
  • network-edge: Folder containing how to get started with installing and trying OpenNESS Network Edge
    • controller-edge-node-setup.md: Started here for installing and trying OpenNESS Network Edge
    • supported-epa.md: List of Silicon and Software EPA that are features that are supported in OpenNESS Network Edge

Application onboarding - Deployment

• applications-onboard: Now that you have installed OpenNESS platform start in this folder to onboard sample application on OpenNESS Network Edge
  • network-edge-applications-onboarding.md: Steps for onboarding sample application on OpenNESS Network Edge
  • openness-edgedns.md: Using edge DNS service
  • openness-interface-service.md: Using network interfaces management service
  • using-openness-cnca.md: Steps for configuring 4G CUPS or 5G Application Function for Edge deployment for Network Edge
  • openness-eaa.md: Edge Application Agent: Description of Edge Application APIs and Edge Application Authentication APIs
  • openness-certsigner.md: Steps for issuing platform certificates

Radio Access Network (RAN)

• ran: Folder containing details of 4G and 5G RAN deployment support
  • openness_ran.md: Whitepaper detailing the 4G and 5G RAN deployment support on OpenNESS for Network Edge
  • openness_xran.md: Whitepaper detailing O-RAN Sample Application deployment support on OpenNESS

Core Network - 4G and 5G

• core-network: Folder containing details of 4G CUPS and 5G edge cloud deployment support
  • openness_epc.md: Whitepaper detailing the 4G CUPS support for Edge cloud deployment in OpenNESS for Network Edge
  • openness_ngc.md: Whitepaper detailing the 5G Edge Cloud deployment support in OpenNESS for Network Edge
  • openness_upf.md: Whitepaper detailing the UPF, AF, NEF deployment support on OpenNESS for Network Edge

Enhanced Platform Awareness

• enhanced-platform-awareness: Folder containing individual Silicon and Software EPA that are features that are supported in OpenNESS and Network Edge
  • openness-hugepage.md: Hugepages support for Edge Applications and Network Functions
  • openness-node-feature-discovery.md: Edge Node hardware and software feature discovery support in OpenNESS
  • openness-sriov-multiple-interfaces.md: Dedicated Physical Network interface allocation support for Edge Applications and Network Functions
  • openness-dedicated-core.md: Dedicated CPU core allocation support for Edge Applications and Network Functions
  • openness-bios.md: Edge platform BIOS and Firmware and configuration support in OpenNESS
  • openness-fpga.md: Dedicated FPGA IP resource allocation support for Edge Applications and Network Functions
  • openness_hddl.md: Using Intel® Movidius™ Myriad™ X High Density Deep Learning (HDDL) solution in OpenNESS
  • openness-topology-manager.md: Resource Locality awareness support through Topology manager in OpenNESS
  • openness-vca.md: Visual Compute Accelerator Card - Analytics (VCAC-A)
  • openness-kubernetes-dashboard.md: Kubernetes Dashboard in OpenNESS
  • openness-rmd.md: Cache Allocation using Resource Management Daemon(RMD) in OpenNESS
  • openness-telemetry: Telemetry Support in OpenNESS

Dataplane

• dataplane: Folder containing Dataplane and inter-app infrastructure support in OpenNESS
  • openness-interapp.md: InterApp Communication support in OpenNESS
  • openness-ovn.md: OpenNESS Support for OVS as dataplane with OVN
  • openness-userspace-cni.md: Userspace CNI - Container Network Interface Kubernetes plugin

Edge Applications

• applications: Folder Containing resource material for Edge Application developers
  • openness_appguide.md: How to develop or Port existing cloud application to the Edge cloud based on OpenNESS
  • openness_ovc.md: Open Visual Cloud Smart City reference Application for OpenNESS
  • openness_openvino.md: AI inference reference Edge application for OpenNESS
  • openness_va_services.md: Video Analytics Services for OpenNESS
  • openness_service_mesh.md: Service Mesh support in OpenNESS

Cloud Adapters

• cloud-adapters: How to deploy public cloud IoT gateways on OpenNESS Edge Cloud
  • openness_awsgreengrass.md: Deploying single or multiple instance of Amazon Greengrass IoT gateway on OpenNESS edge cloud as an edge application
  • openness_baiducloud.md: Deploying single or multiple instance of Baidu IoT gateway on OpenNESS edge cloud as an edge application

API and Schema

• Edge Application API: EAA
• Edge Application Authentication API
• Core Network Configuration API
• schema: Folder containing APIs protobuf or schema for varios endpoints in OpenNESS solution

Orchestration

• openness-helm.md: Helm support in OpenNESS

Release history

• openness_releasenotes.md: This document provides high level system features, issues and limitations information for OpenNESS

Related resources

• OpenNESS Website - Developers : Website containing developer resources
• Intel Network Builders OpenNESS training

List of Abbreviations

• 3GPP: Third Generation Partnership Project
• CUPS: Control and User Plane Separation of EPC Nodes
• AF: Application Function
• API: Application Programming Interface
• APN: Access Point Name
• EPC: Evolved Packet Core
• ETSI: European Telecommunications Standards Institute
• FQDN: Fully Qualified Domain Name
• HTTP: Hyper Text Transfer Protocol
• IMSI: International Mobile Subscriber Identity
• JSON: JavaScript Object Notation
• MEC: Multi-Access Edge Computing
• OpenNESS: Open Network Edge Services Software
• LTE: Long-Term Evolution
• MCC: Mobile Country Code
• MME: Mobility Management Entity
• MNC: Mobile Network Code
• NEF: Network Exposure Function
• OAM: Operations, Administration and Maintenance
• PDN: Packet Data Network
• PFCP: Packet Forwarding Control Protocol- SGW: Serving Gateway- PGW: PDN Gateway
• PGW-C: PDN Gateway - Control Plane Function
• PGW-U: PDN Gateway - User Plane Function
• REST: REpresentational State Transfer
• SGW-C: Serving Gateway - Control Plane Function
• SGW-U: Serving Gateway - User Plane Function
• TAC: Tracking Area Code
• UE: User Equipment (in the context of LTE)
• VIM: Virtual Infrastructure Manager
• UUID: Universally Unique IDentifier
• AMF: Access and Mobility Mgmt Function
• SMF: Session Management Function
• AUSF: Authentication Server Function
• NEF: Network Exposure Function
• NRF: Network function Repository Function
• UDM: Unified Data Management
• PCF: Policy Control Function
• UPF: User Plane Function
• DN: Data Network
• AF: Application Function
• SR-IOV: Single Root I/O Virtualization
• NUMA: Non-Uniform Memory Access
• COTS: Commercial Off-The-Shelf
• DU: Distributed Unit of RAN
• CU: Centralized Unit of RAN
• OEK: OpenNESS Experience Kit
• IDO: Intel Distribution of OpenNESS