jalvarez96/specs

This repository includes the literature related to OpenNESS solution

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

OnPremises 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

Getting Started - Setup

• getting-started: Folder containing how to get started with installing and trying OpenNESS OnPremises and Network Edge solutions
  • openness-experience-kits.md: Overview of the OpenNESS Experience kits that are used to install the Network and OnPremises 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
  • on-premises: Folder Containing how to get started with installing and trying OpenNESS OnPremises
    • controller-edge-node-setup.md: Started here for installing and trying OpenNESS OnPremises Edge
    • openness-gateway.md: OpenNESS Gateway support for deploying edge platform and Controller on separate IP Subnet
    • supported-epa.md: List of Silicon and Software EPA features that are supported in OpenNESS OnPremises Edge

Application onboarding - Deployment

• applications-onboard: Now that you have installed OpenNESS platform start in this folder to onboard sample application on OpenNESS Network or OnPremises Edge
  • network-edge-applications-onboarding.md: Steps for onboarding sample application on OpenNESS Network Edge
  • on-premises-applications-onboarding.md: Steps for onboarding sample application on OpenNESS OnPremises 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 and OnPremises Edge

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

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 and OnPremises Edge
  • openness_ngc.md: Whitepaper detailing the 5G Edge Cloud deployment support in OpenNESS for Network and OnPremises 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 OnPremises 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-environment-variables.md: Environment Variable configuration support in OpenNESS
  • openness-tunable-exec.md: Configurable startup command support for containers in OpenNESS
  • openness-port-forward.md: Support for setting up port forwarding of a container in OpenNESS On-Prem mode
  • openness-shared-storage.md: Shared storage for containers in OpenNESS On-Prem mode

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-nts.md: Dataplane support for Edge Cloud between ENB and EPC (S1-U) Deployment
  • 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

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
• OnPremises Controller API: EAA
• Core Network Configuration API
• Edge Lifecycle Management API: ELA
• Edge Virtualization Infrastructure API: EVA
• schema: Folder containing APIs protobuf or schema for varios endpoints in OpenNESS solution

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