Skip to content
This repository has been archived by the owner on May 27, 2022. It is now read-only.

Commit

Permalink
Merge pull request #57 from open-ness/openness_release_2009
Browse files Browse the repository at this point in the history
Openness release 2009
  • Loading branch information
cjnolan authored Sep 30, 2020
2 parents 68115bc + 5f9b901 commit 2a65d31
Show file tree
Hide file tree
Showing 116 changed files with 3,364 additions and 4,099 deletions.
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Copyright (c) 2019-2020 Intel Corporation
## <b>Network Edge</b>
### <b>Step 1.</b> Get Hardware &#9658; <b>Step 2.</b> [Getting started](https://github.com/open-ness/specs/blob/master/doc/getting-started/network-edge/controller-edge-node-setup.md) &#9658; <b>Step 3.</b> [Applications Onboarding](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/network-edge-applications-onboarding.md)

## <b>OnPremises Edge</b>
### <b>Step 1.</b> Get Hardware &#9658; <b>Step 2.</b> [Getting started](https://github.com/open-ness/specs/blob/master/doc/getting-started/on-premises/controller-edge-node-setup.md) &#9658; <b>Step 3.</b> [Applications Onboarding](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/on-premises-applications-onboarding.md)

# OpenNESS solution documentation index

Expand All @@ -22,24 +20,19 @@ Below is the complete list of OpenNESS solution documentation

## Getting Started - Setup

* [<b>getting-started</b>: Folder containing how to get started with installing and trying OpenNESS OnPremises and Network Edge solutions](https://github.com/open-ness/specs/blob/master/doc/getting-started)
* [<b>openness-experience-kits.md</b>: Overview of the OpenNESS Experience kits that are used to install the Network and OnPremises Edge solutions](https://github.com/open-ness/specs/blob/master/doc/getting-started/openness-experience-kits.md)
* [<b>getting-started</b>: Folder containing how to get started with installing and trying OpenNESS Network Edge solutions](https://github.com/open-ness/specs/blob/master/doc/getting-started)
* [<b>openness-experience-kits.md</b>: Overview of the OpenNESS Experience kits that are used to install the Network Edge solutions](https://github.com/open-ness/specs/blob/master/doc/getting-started/openness-experience-kits.md)
* [<b>network-edge</b>: Folder containing how to get started with installing and trying OpenNESS Network Edge](https://github.com/open-ness/specs/blob/master/doc/getting-started/network-edge)
* [<b>controller-edge-node-setup.md</b>: Started here for installing and trying OpenNESS Network Edge](https://github.com/open-ness/specs/blob/master/doc/getting-started/network-edge/controller-edge-node-setup.md)
* [<b>supported-epa.md</b>: List of Silicon and Software EPA that are features that are supported in OpenNESS Network Edge](https://github.com/open-ness/specs/blob/master/doc/getting-started/network-edge/supported-epa.md)
* [<b>on-premises</b>: Folder Containing how to get started with installing and trying OpenNESS OnPremises](https://github.com/open-ness/specs/blob/master/doc/getting-started/on-premises)
* [<b>controller-edge-node-setup.md</b>: Started here for installing and trying OpenNESS OnPremises Edge](https://github.com/open-ness/specs/blob/master/doc/getting-started/on-premises/controller-edge-node-setup.md)
* [<b>openness-gateway.md:</b> OpenNESS Gateway support for deploying edge platform and Controller on separate IP Subnet](https://github.com/open-ness/specs/blob/master/doc/getting-started/on-premises/openness-gateway.md)
* [<b>supported-epa.md</b>: List of Silicon and Software EPA features that are supported in OpenNESS OnPremises Edge](https://github.com/open-ness/specs/blob/master/doc/getting-started/on-premises/supported-epa.md)

## Application onboarding - Deployment

* [<b>applications-onboard</b>: Now that you have installed OpenNESS platform start in this folder to onboard sample application on OpenNESS Network or OnPremises Edge](https://github.com/open-ness/specs/blob/master/doc/applications-onboard)
* [<b>applications-onboard</b>: Now that you have installed OpenNESS platform start in this folder to onboard sample application on OpenNESS Network Edge](https://github.com/open-ness/specs/blob/master/doc/applications-onboard)
* [<b>network-edge-applications-onboarding.md</b>: Steps for onboarding sample application on OpenNESS Network Edge](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/network-edge-applications-onboarding.md)
* [<b>on-premises-applications-onboarding.md</b>: Steps for onboarding sample application on OpenNESS OnPremises Edge](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/on-premises-applications-onboarding.md)
* [<b>openness-edgedns.md</b>: Using edge DNS service](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/openness-edgedns.md)
* [<b>openness-interface-service.md</b>: Using network interfaces management service](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/openness-interface-service.md)
* [<b>using-openness-cnca.md</b>: Steps for configuring 4G CUPS or 5G Application Function for Edge deployment for Network and OnPremises Edge](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/using-openness-cnca.md)
* [<b>using-openness-cnca.md</b>: Steps for configuring 4G CUPS or 5G Application Function for Edge deployment for Network Edge](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/using-openness-cnca.md)
* [<b>openness-eaa.md</b>: Edge Application Agent: Description of Edge Application APIs and Edge Application Authentication APIs](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/openness-eaa.md)

## Radio Access Network (RAN)
Expand All @@ -50,13 +43,13 @@ Below is the complete list of OpenNESS solution documentation
## Core Network - 4G and 5G

* [<b>core-network</b>: Folder containing details of 4G CUPS and 5G edge cloud deployment support](https://github.com/open-ness/specs/tree/master/doc/core-network)
* [<b>openness_epc.md</b>: Whitepaper detailing the 4G CUPS support for Edge cloud deployment in OpenNESS for Network and OnPremises Edge](https://github.com/open-ness/specs/blob/master/doc/core-network/openness_epc.md)
* [<b>openness_ngc.md</b>: Whitepaper detailing the 5G Edge Cloud deployment support in OpenNESS for Network and OnPremises Edge](https://github.com/open-ness/specs/blob/master/doc/core-network/openness_ngc.md)
* [<b>openness_epc.md</b>: Whitepaper detailing the 4G CUPS support for Edge cloud deployment in OpenNESS for Network Edge](https://github.com/open-ness/specs/blob/master/doc/core-network/openness_epc.md)
* [<b>openness_ngc.md</b>: Whitepaper detailing the 5G Edge Cloud deployment support in OpenNESS for Network Edge](https://github.com/open-ness/specs/blob/master/doc/core-network/openness_ngc.md)
* [<b>openness_upf.md</b>: Whitepaper detailing the UPF, AF, NEF deployment support on OpenNESS for Network Edge](https://github.com/open-ness/specs/blob/master/doc/core-network/openness_upf.md)

## Enhanced Platform Awareness

* [<b>enhanced-platform-awareness</b>: Folder containing individual Silicon and Software EPA that are features that are supported in OpenNESS OnPremises and Network Edge](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness)
* [<b>enhanced-platform-awareness</b>: Folder containing individual Silicon and Software EPA that are features that are supported in OpenNESS and Network Edge](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness)
* [<b>openness-hugepage.md</b>: Hugepages support for Edge Applications and Network Functions](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-hugepage.md)
* [<b>openness-node-feature-discovery.md</b>: Edge Node hardware and software feature discovery support in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-node-feature-discovery.md)
* [<b>openness-sriov-multiple-interfaces.md</b>: Dedicated Physical Network interface allocation support for Edge Applications and Network Functions](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-sriov-multiple-interfaces.md)
Expand All @@ -65,18 +58,13 @@ Below is the complete list of OpenNESS solution documentation
* [<b>openness-fpga.md</b>: Dedicated FPGA IP resource allocation support for Edge Applications and Network Functions](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-fpga.md)
* [<b>openness_hddl.md</b>: Using Intel® Movidius™ Myriad™ X High Density Deep Learning (HDDL) solution in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness_hddl.md)
* [<b>openness-topology-manager.md</b>: Resource Locality awareness support through Topology manager in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-topology-manager.md)
* [<b>openness-environment-variables.md</b>: Environment Variable configuration support in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-environment-variables.md)
* [<b>openness-tunable-exec.md</b>: Configurable startup command support for containers in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-tunable-exec.md)
* [<b>openness-port-forward.md</b>: Support for setting up port forwarding of a container in OpenNESS On-Prem mode](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-port-forward.md)
* [<b>openness-shared-storage.md</b>: Shared storage for containers in OpenNESS On-Prem mode](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-shared-storage.md)
* [<b>openness-vca.md</b>: Visual Compute Accelerator Card - Analytics (VCAC-A)](https://github.com/open-ness/specs/blob/master/doc/enhanced-platform-awareness/openness-vcac-a.md)

## Dataplane

* [<b>dataplane</b>: Folder containing Dataplane and inter-app infrastructure support in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/dataplane)
* [<b>openness-interapp.md</b>: InterApp Communication support in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/dataplane/openness-interapp.md)
* [<b>openness-ovn.md</b>: OpenNESS Support for OVS as dataplane with OVN](https://github.com/open-ness/specs/blob/master/doc/dataplane/openness-ovn.md)
* [<b>openness-nts.md</b>: Dataplane support for Edge Cloud between ENB and EPC (S1-U) Deployment](https://github.com/open-ness/specs/blob/master/doc/dataplane/openness-nts.md)
* [<b>openness-userspace-cni.md</b>: Userspace CNI - Container Network Interface Kubernetes plugin](https://github.com/open-ness/specs/blob/master/doc/dataplane/openness-userspace-cni.md)

## Edge Applications
Expand All @@ -85,6 +73,8 @@ Below is the complete list of OpenNESS solution documentation
* [<b>openness_appguide.md</b>: How to develop or Port existing cloud application to the Edge cloud based on OpenNESS](https://github.com/open-ness/specs/blob/master/doc/applications/openness_appguide.md)
* [<b>openness_ovc.md</b>: Open Visual Cloud Smart City reference Application for OpenNESS](https://github.com/open-ness/specs/blob/master/doc/applications/openness_ovc.md)
* [<b>openness_openvino.md</b>: AI inference reference Edge application for OpenNESS](https://github.com/open-ness/specs/blob/master/doc/applications/openness_openvino.md)
* [<b>openness_va_services.md</b>: Video Analytics Services for OpenNESS](https://github.com/open-ness/specs/blob/master/doc/applications/openness_va_services.md)
* [<b>openness_service_mesh.md</b>: Service Mesh support in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/applications/openness_service_mesh.md)

## Cloud Adapters

Expand All @@ -96,10 +86,7 @@ Below is the complete list of OpenNESS solution documentation

* [<b>Edge Application API: EAA</b>](https://www.openness.org/api-documentation/?api=eaa)
* [<b>Edge Application Authentication API</b>](https://www.openness.org/api-documentation/?api=auth)
* [<b>OnPremises Controller API: EAA</b>](https://www.openness.org/api-documentation/?api=controller)
* [<b>Core Network Configuration API</b>](https://www.openness.org/api-documentation/?api=cups)
* [<b>Edge Lifecycle Management API: ELA</b>](https://github.com/open-ness/specs/blob/master/schema/pb/ela.proto)
* [<b>Edge Virtualization Infrastructure API: EVA</b>](https://github.com/open-ness/specs/blob/master/schema/pb/eva.proto)
* [<b>schema</b>: Folder containing APIs protobuf or schema for varios endpoints in OpenNESS solution](https://github.com/open-ness/specs/tree/master/schema)

## Orchestration
Expand Down Expand Up @@ -161,4 +148,4 @@ Below is the complete list of OpenNESS solution documentation
- DU: Distributed Unit of RAN
- CU: Centralized Unit of RAN
- OEK: OpenNESS Experience Kit
- IDO: Intel Distribution of OpenNESS
- IDO: Intel Distribution of OpenNESS
5 changes: 0 additions & 5 deletions _data/navbars/applications-onboarding.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ section:
meta_title: OpenNESS Network Edge Application On-Boarding Process
meta_description: OpenNESS application on-boarding process for the Network Edge provides instructions on how to deploy an application from the Edge Controller to Edge Nodes in the cluster.

- title: OnPremises Applications Onboarding
path: /doc/applications-onboard/on-premises-applications-onboarding
meta_title: OpenNESS OnPremises Mode Application On-Boarding Process
meta_description: OpenNESS application on-boarding process for the OnPremises mode provides instructions on how to deploy an application from the Edge Controller on Edge Nodes.

- title: Edge DNS
path: /doc/applications-onboard/openness-edgedns
meta_title: OpenNESS Provides Edge DNS and Supports DNS Microservice
Expand Down
7 changes: 1 addition & 6 deletions _data/navbars/dataplane.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,13 @@ section:
- title: Inter-App Communication
path: /doc/dataplane/openness-interapp
meta_title: Inter-App Communication Support in OpenNESS
meta_description: OpenNESS provides Inter-App Communication support for both the On-Premises and Network edge modes of OpenNESS.
meta_description: OpenNESS provides Inter-App Communication support for Network edge modes of OpenNESS.

- title: OVN/OVS
path: /doc/dataplane/openness-ovn
meta_title: OpenNESS Support for OVS as Dataplane with OVN
meta_description: The primary objective of supporting OVN/OVS in OpenNESS is to demonstrate the capability of using a standard dataplane like OVS for an Edge Compute platform.

- title: NTS
path: /doc/dataplane/openness-nts
meta_title: OpenNESS NTS - Dataplane support for Edge Cloud between ENB and EPC Deployment
meta_description: OpenNESS NTS is a Dataplane component that provides a network traffic control service and a data forwarding service to mobile edge applications, specifically for S1-U deployments.

- title: Userspace CNI
path: /doc/dataplane/openness-userspace-cni
meta_title: OpenNESS Userspace CNI, Setup Userspace CNI
Expand Down
5 changes: 5 additions & 0 deletions _data/navbars/edge-applications.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,8 @@ section:
path: /doc/applications/openness_va_services
meta_title: OpenNESS Video Analytics Services
meta_description: The Video Analytics Services provided by OpenNESS to enable third party edge application to deploy and use hardware optimized video analytics pipelines.

- title: OpenNESS Service Mesh
path: /doc/applications/openness_service_mesh
meta_title: OpenNESS Service Mesh
meta_description: Service mesh acts as a middleware between the edge applications/services and the OpenNESS platform providing abstractions for traffic management, observability and security for the edge micro-services.
25 changes: 5 additions & 20 deletions _data/navbars/enhanced-platform-awareness.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,27 +55,12 @@ section:
meta_title: Cache Allocation for Containers with Resource Management Daemon (RMD)
meta_description: Intel® Resource Director Technology (Intel® RDT) provides visibility and control over how shared resources such as last-level cache (LLC) and memory bandwidth are used by applications, virtual machines (VMs), and containers.

- title: Environment Variables Support
path: /doc/enhanced-platform-awareness/openness-environment-variables
meta_title: Environment Variable Support in OpenNESS
meta_description: Environment variables can be configured when creating a new Docker container. Once the container is running, any application located in that container can detect and use the variable.

- title: Tunable Execution
path: /doc/enhanced-platform-awareness/openness-tunable-exec
meta_title: Tunable Execution - Overriding the Startup Command for Container
meta_description: This feature enables you to override the start-up command for a container, thus removing the need to rebuild it just to make this change.

- title: Port Forwarding
path: /doc/enhanced-platform-awareness/openness-port-forward
meta_title: Setting Up Port Forwarding for Containers
meta_description: This feature enables the user to set up external network ports for their application (container) so that applications running on other hosts can connect.

- title: Shared Storage for containers
path: /doc/enhanced-platform-awareness/openness-shared-storage
meta_title: Shared Storage for Containers in Openness On-Premises Mode
meta_description: OpenNESS On-Prem mode provides possibility to use volume and bind mount storage models known from docker.

- title: Telemetry support in OpenNESS
path: /doc/enhanced-platform-awareness/openness-telemetry
meta_title: Telemetry support in OpenNESS
meta_description: OpenNESS supports platform and application telemetry allowing users to retrieve information about the platform, the underlying hardware, cluster and applications deployed.

- title: Kubernetes Dashboard in OpenNESS
path: /doc/enhanced-platform-awareness/openness-kubernetes-dashboard
meta_title: Kubernetes Dashboard in OpenNESS
meta_description: OpenNESS supports Kubernetes Dashboard that can be used to inspect and manage Kubernetes cluster.
20 changes: 1 addition & 19 deletions _data/navbars/getting-started.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ section:
- title: OpenNESS Experience Kits
path: /doc/getting-started/openness-experience-kits
meta_title: OpenNESS Experience Kits Easy Setup of OpenNESS in Network Edge
meta_description: OpenNESS Experience Kits repository contains easy setup of OpenNESS in Network Edge and On-Premises modes.
meta_description: OpenNESS Experience Kits repository contains easy setup of OpenNESS in Network Edge mode.

- title: Network Edge
path:
Expand All @@ -22,21 +22,3 @@ section:
path: /doc/getting-started/network-edge/supported-epa
meta_title: OpenNESS Network Edge - Enhanced Platform Awareness Features Supported
meta_description: Enhanced Platform Awareness features supported for network edge is to expose capability to edge cloud orchestrator for better performance, consistency, and reliability.

- title: OnPremises
path:
section:
- title: Controller & Edge Node Setup
path: /doc/getting-started/on-premises/controller-edge-node-setup
meta_title: Controller and Edge Node Setup
meta_description: OpenNESS Controller and Edge Node to work together the Edge Node needs to enroll with the Controller until it is serial key recognized by the Controller.

- title: Gateway Feature
path: /doc/getting-started/on-premises/openness-gateway
meta_title: Gateway Feature - Supported Mode of Operation
meta_description: OpenNESS gateway features to the supported mode of operation in this case still, the only requirement being the controller is on a publicly accessible network.

- title: Enhanced Platform Awareness Features Supported
path: /doc/getting-started/on-premises/supported-epa
meta_title: Enhanced Platform Awareness Features Supported
meta_description: Enhanced Platform Awareness features are supported in OpenNESS OnPremises Edge using EVA APIs. OpenNESS controller UI user would use create the HTTP REST POST API.
Binary file added doc/applications-onboard/eaa-images/eaa-comp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions doc/applications-onboard/eaa-images/eaa_notifications.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
260 changes: 260 additions & 0 deletions doc/applications-onboard/eaa-images/eaa_services.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
278 changes: 278 additions & 0 deletions doc/applications-onboard/eaa-images/eaa_subscriptions.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/applications-onboard/eaa-images/openness-eaa.png
Binary file not shown.
Binary file removed doc/applications-onboard/eaa-images/openness_eaa.png
Binary file not shown.
Loading

0 comments on commit 2a65d31

Please sign in to comment.