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

Commit 2a65d31

Browse files
authored
Merge pull request #57 from open-ness/openness_release_2009
Openness release 2009
2 parents 68115bc + 5f9b901 commit 2a65d31

File tree

116 files changed

+3364
-4099
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+3364
-4099
lines changed

README.md

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Copyright (c) 2019-2020 Intel Corporation
88
## <b>Network Edge</b>
99
### <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)
1010

11-
## <b>OnPremises Edge</b>
12-
### <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)
1311

1412
# OpenNESS solution documentation index
1513

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

2321
## Getting Started - Setup
2422

25-
* [<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)
26-
* [<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)
23+
* [<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)
24+
* [<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)
2725
* [<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)
2826
* [<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)
2927
* [<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)
30-
* [<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)
31-
* [<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)
32-
* [<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)
33-
* [<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)
3428

3529
## Application onboarding - Deployment
3630

37-
* [<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)
31+
* [<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)
3832
* [<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)
39-
* [<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)
4033
* [<b>openness-edgedns.md</b>: Using edge DNS service](https://github.com/open-ness/specs/blob/master/doc/applications-onboard/openness-edgedns.md)
4134
* [<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)
42-
* [<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)
35+
* [<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)
4336
* [<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)
4437

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

5245
* [<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)
53-
* [<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)
54-
* [<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)
46+
* [<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)
47+
* [<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)
5548
* [<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)
5649

5750
## Enhanced Platform Awareness
5851

59-
* [<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)
52+
* [<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)
6053
* [<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)
6154
* [<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)
6255
* [<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)
@@ -65,18 +58,13 @@ Below is the complete list of OpenNESS solution documentation
6558
* [<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)
6659
* [<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)
6760
* [<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)
68-
* [<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)
69-
* [<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)
70-
* [<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)
71-
* [<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)
7261
* [<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)
7362

7463
## Dataplane
7564

7665
* [<b>dataplane</b>: Folder containing Dataplane and inter-app infrastructure support in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/dataplane)
7766
* [<b>openness-interapp.md</b>: InterApp Communication support in OpenNESS](https://github.com/open-ness/specs/blob/master/doc/dataplane/openness-interapp.md)
7867
* [<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)
79-
* [<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)
8068
* [<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)
8169

8270
## Edge Applications
@@ -85,6 +73,8 @@ Below is the complete list of OpenNESS solution documentation
8573
* [<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)
8674
* [<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)
8775
* [<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)
76+
* [<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)
77+
* [<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)
8878

8979
## Cloud Adapters
9080

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

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

10592
## Orchestration
@@ -161,4 +148,4 @@ Below is the complete list of OpenNESS solution documentation
161148
- DU: Distributed Unit of RAN
162149
- CU: Centralized Unit of RAN
163150
- OEK: OpenNESS Experience Kit
164-
- IDO: Intel Distribution of OpenNESS
151+
- IDO: Intel Distribution of OpenNESS

_data/navbars/applications-onboarding.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ section:
1010
meta_title: OpenNESS Network Edge Application On-Boarding Process
1111
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.
1212

13-
- title: OnPremises Applications Onboarding
14-
path: /doc/applications-onboard/on-premises-applications-onboarding
15-
meta_title: OpenNESS OnPremises Mode Application On-Boarding Process
16-
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.
17-
1813
- title: Edge DNS
1914
path: /doc/applications-onboard/openness-edgedns
2015
meta_title: OpenNESS Provides Edge DNS and Supports DNS Microservice

_data/navbars/dataplane.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,13 @@ section:
88
- title: Inter-App Communication
99
path: /doc/dataplane/openness-interapp
1010
meta_title: Inter-App Communication Support in OpenNESS
11-
meta_description: OpenNESS provides Inter-App Communication support for both the On-Premises and Network edge modes of OpenNESS.
11+
meta_description: OpenNESS provides Inter-App Communication support for Network edge modes of OpenNESS.
1212

1313
- title: OVN/OVS
1414
path: /doc/dataplane/openness-ovn
1515
meta_title: OpenNESS Support for OVS as Dataplane with OVN
1616
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.
1717

18-
- title: NTS
19-
path: /doc/dataplane/openness-nts
20-
meta_title: OpenNESS NTS - Dataplane support for Edge Cloud between ENB and EPC Deployment
21-
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.
22-
2318
- title: Userspace CNI
2419
path: /doc/dataplane/openness-userspace-cni
2520
meta_title: OpenNESS Userspace CNI, Setup Userspace CNI

_data/navbars/edge-applications.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,8 @@ section:
2424
path: /doc/applications/openness_va_services
2525
meta_title: OpenNESS Video Analytics Services
2626
meta_description: The Video Analytics Services provided by OpenNESS to enable third party edge application to deploy and use hardware optimized video analytics pipelines.
27+
28+
- title: OpenNESS Service Mesh
29+
path: /doc/applications/openness_service_mesh
30+
meta_title: OpenNESS Service Mesh
31+
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.

_data/navbars/enhanced-platform-awareness.yml

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -55,27 +55,12 @@ section:
5555
meta_title: Cache Allocation for Containers with Resource Management Daemon (RMD)
5656
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.
5757

58-
- title: Environment Variables Support
59-
path: /doc/enhanced-platform-awareness/openness-environment-variables
60-
meta_title: Environment Variable Support in OpenNESS
61-
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.
62-
63-
- title: Tunable Execution
64-
path: /doc/enhanced-platform-awareness/openness-tunable-exec
65-
meta_title: Tunable Execution - Overriding the Startup Command for Container
66-
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.
67-
68-
- title: Port Forwarding
69-
path: /doc/enhanced-platform-awareness/openness-port-forward
70-
meta_title: Setting Up Port Forwarding for Containers
71-
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.
72-
73-
- title: Shared Storage for containers
74-
path: /doc/enhanced-platform-awareness/openness-shared-storage
75-
meta_title: Shared Storage for Containers in Openness On-Premises Mode
76-
meta_description: OpenNESS On-Prem mode provides possibility to use volume and bind mount storage models known from docker.
77-
7858
- title: Telemetry support in OpenNESS
7959
path: /doc/enhanced-platform-awareness/openness-telemetry
8060
meta_title: Telemetry support in OpenNESS
8161
meta_description: OpenNESS supports platform and application telemetry allowing users to retrieve information about the platform, the underlying hardware, cluster and applications deployed.
62+
63+
- title: Kubernetes Dashboard in OpenNESS
64+
path: /doc/enhanced-platform-awareness/openness-kubernetes-dashboard
65+
meta_title: Kubernetes Dashboard in OpenNESS
66+
meta_description: OpenNESS supports Kubernetes Dashboard that can be used to inspect and manage Kubernetes cluster.

_data/navbars/getting-started.yml

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ section:
88
- title: OpenNESS Experience Kits
99
path: /doc/getting-started/openness-experience-kits
1010
meta_title: OpenNESS Experience Kits Easy Setup of OpenNESS in Network Edge
11-
meta_description: OpenNESS Experience Kits repository contains easy setup of OpenNESS in Network Edge and On-Premises modes.
11+
meta_description: OpenNESS Experience Kits repository contains easy setup of OpenNESS in Network Edge mode.
1212

1313
- title: Network Edge
1414
path:
@@ -22,21 +22,3 @@ section:
2222
path: /doc/getting-started/network-edge/supported-epa
2323
meta_title: OpenNESS Network Edge - Enhanced Platform Awareness Features Supported
2424
meta_description: Enhanced Platform Awareness features supported for network edge is to expose capability to edge cloud orchestrator for better performance, consistency, and reliability.
25-
26-
- title: OnPremises
27-
path:
28-
section:
29-
- title: Controller & Edge Node Setup
30-
path: /doc/getting-started/on-premises/controller-edge-node-setup
31-
meta_title: Controller and Edge Node Setup
32-
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.
33-
34-
- title: Gateway Feature
35-
path: /doc/getting-started/on-premises/openness-gateway
36-
meta_title: Gateway Feature - Supported Mode of Operation
37-
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.
38-
39-
- title: Enhanced Platform Awareness Features Supported
40-
path: /doc/getting-started/on-premises/supported-epa
41-
meta_title: Enhanced Platform Awareness Features Supported
42-
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.
48.4 KB
Loading

doc/applications-onboard/eaa-images/eaa_notifications.svg

Lines changed: 98 additions & 0 deletions
Loading

doc/applications-onboard/eaa-images/eaa_services.svg

Lines changed: 260 additions & 0 deletions
Loading

doc/applications-onboard/eaa-images/eaa_subscriptions.svg

Lines changed: 278 additions & 0 deletions
Loading
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)