Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/smart-edge-open/specs

Additional documentation for experience kits with Ansible-based deployment.
https://github.com/smart-edge-open/specs

Last synced: 24 days ago
JSON representation

Additional documentation for experience kits with Ansible-based deployment.

Awesome Lists containing this project

README 

        

DISCONTINUATION OF PROJECT.



This project will no longer be maintained by Intel.



Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates.



Patches to this project are no longer accepted by Intel.



If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project .



```text

SPDX-License-Identifier: Apache-2.0

Copyright (c) 2019-2020 Intel Corporation

```



# Smart Edge Open Quick Start



   ## Network Edge

   ### Step 1. Get Hardware ► Step 2. [Getting started](https://github.com/smart-edge-open/specs/blob/master/doc/getting-started/smartedge-open-cluster-setup.md) ► Step 3. [Applications Onboarding](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard/network-edge-applications-onboarding.md)



# Smart Edge Open solution documentation index



Below is the complete list of Smart Edge Open solution documentation



## Architecture



* [architecture.md: Smart Edge Open Architecture overview](https://github.com/smart-edge-open/specs/blob/master/doc/architecture.md)

* [flavors.md: Smart Edge Open Deployment Flavors](https://github.com/smart-edge-open/specs/blob/master/doc/flavors.md)



## Getting Started - Setup



* [getting-started: Folder containing how to get started with installing and trying Smart Edge Open Network Edge solutions](https://github.com/smart-edge-open/specs/blob/master/doc/getting-started)

   * [smartedge-open-cluster-setup.md: Getting started here for installing and trying Smart Edge Open Network Edge](https://github.com/smart-edge-open/specs/blob/master/doc/getting-started/smartedge-open-cluster-setup.md)

   * [converged-edge-experience-kits.md: Overview of the Converged Edge Experience Kits that are used to install the Network Edge solutions](https://github.com/smart-edge-open/specs/blob/master/doc/getting-started/converged-edge-experience-kits.md)

   * [non-root-user.md: Using the non-root user on the Smart Edge Open Platform](https://github.com/smart-edge-open/specs/blob/master/doc/getting-started/non-root-user.md)

   * [harbor-registry.md: Enabling Harbor Registry service in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/getting-started/harbor-registry.md)

   * [kubernetes-dashboard.md: Installing  Kubernetes Dashboard for Smart Edge Open Network Edge cluster](https://github.com/smart-edge-open/specs/blob/master/doc/getting-started/kubernetes-dashboard.md)



## Application onboarding - Deployment



* [applications-onboard: Now that you have installed Smart Edge Open platform start in this folder to onboard sample application on Smart Edge Open Network Edge](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard)

   * [network-edge-applications-onboarding.md: Steps for onboarding sample application on Smart Edge Open Network Edge](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard/network-edge-applications-onboarding.md)

   * [smartedge-open-edgedns.md: Using edge DNS service](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard/smartedge-open-edgedns.md)

   * [smartedge-open-interface-service.md: Using network interfaces management service](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard/smartedge-open-interface-service.md)

   * [using-smartedge-open-cnca.md: Steps for configuring 4G CUPS or 5G Application Function for Edge deployment for Network Edge](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard/using-smartedge-open-cnca.md)

   * [smartedge-open-eaa.md: Edge Application Agent: Description of Edge Application APIs and Edge Application Authentication APIs](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard/smartedge-open-eaa.md)

   * [smartedge-open-certsigner.md: Steps for issuing platform certificates](https://github.com/smart-edge-open/specs/blob/master/doc/applications-onboard/smartedge-open-certsigner.md)



## Core Network - 4G and 5G



* [core-network: Folder containing details of 4G CUPS and 5G edge cloud deployment support](https://github.com/smart-edge-open/specs/tree/master/doc/reference-architectures/core-network)

   * [smartedge-open_epc.md: Whitepaper detailing the 4G CUPS support for Edge cloud deployment in Smart Edge Open for Network Edge](https://github.com/smart-edge-open/specs/blob/master/doc/reference-architectures/core-network/smartedge-open_epc.md)

   * [smartedge-open_ngc.md: Whitepaper detailing the 5G Edge Cloud deployment support in Smart Edge Open for Network Edge](https://github.com/smart-edge-open/specs/blob/master/doc/reference-architectures/core-network/smartedge-open_ngc.md)

   * [smartedge-open_upf.md: Whitepaper detailing the UPF, AF, NEF deployment support on Smart Edge Open for Network Edge](https://github.com/smart-edge-open/specs/blob/master/doc/reference-architectures/core-network/smartedge-open_upf.md)



## Enhanced Platform Awareness



* [enhanced-platform-awareness: Folder containing individual Silicon and Software EPA that are features that are supported in Smart Edge Open and Network Edge](https://github.com/smart-edge-open/specs/tree/master/doc/building-blocks/enhanced-platform-awareness)

   * [smartedge-open-hugepage.md: Hugepages support for Edge Applications and Network Functions](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-hugepage.md)

   * [smartedge-open-node-feature-discovery.md: Edge Node hardware and software feature discovery support in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-node-feature-discovery.md)

   * [smartedge-open-sriov-multiple-interfaces.md: Dedicated Physical Network interface allocation support for Edge Applications and Network Functions](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-sriov-multiple-interfaces.md)

   * [smartedge-open-dedicated-core.md: Dedicated CPU core allocation support for Edge Applications and Network Functions](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-dedicated-core.md)

   * [smartedge-open-bios.md: Edge platform BIOS and Firmware and configuration support in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-bios.md)

   * [smartedge-open-qat.md: Resource allocation & configuration of Intel® QuickAssist Adapter](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-qat.md)

   * [smartedge-open-fpga.md: Dedicated FPGA IP resource allocation support for Edge Applications and Network Functions](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-fpga.md)

   * [smartedge-open_hddl.md: Using Intel® Movidius™ Myriad™ X High Density Deep Learning (HDDL) solution in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open_hddl.md)

   * [smartedge-open-topology-manager.md: Resource Locality awareness support through Topology manager in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-topology-manager.md)

   * [smartedge-open-vca.md: Visual Compute Accelerator Card - Analytics (VCAC-A)](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-vcac-a.md)

   * [smartedge-open-rmd.md: Cache Allocation using Resource Management Daemon(RMD) in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-rmd.md)

   * [smartedge-open-telemetry: Telemetry Support in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/enhanced-platform-awareness/smartedge-open-telemetry.md)



## Dataplane



* [dataplane: Folder containing Dataplane and inter-app infrastructure support in Smart Edge Open](https://github.com/smart-edge-open/specs/tree/master/doc/building-blocks/dataplane)

   * [smartedge-open-interapp.md: InterApp Communication support in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/dataplane/smartedge-open-interapp.md)

   * [smartedge-open-ovn.md: Smart Edge Open Support for OVS as dataplane with OVN](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/dataplane/smartedge-open-ovn.md)

   * [smartedge-open-userspace-cni.md: Userspace CNI - Container Network Interface Kubernetes plugin](https://github.com/smart-edge-open/specs/blob/master/doc/building-blocks/dataplane/smartedge-open-userspace-cni.md)



## Edge Applications



* [applications: Folder Containing resource material for Edge Application developers](https://github.com/smart-edge-open/specs/blob/master/doc/applications)

   * [smartedge-open_appguide.md: How to develop or Port existing cloud application to the Edge cloud based on Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/applications/smartedge-open_appguide.md)

   * [smartedge-open_ovc.md: Open Visual Cloud Smart City reference Application for Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/applications/smartedge-open_ovc.md)

   * [smartedge-open_openvino.md: AI inference reference Edge application for Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/applications/smartedge-open_openvino.md)

   * [smartedge-open_va_services.md: Video Analytics Services for Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/applications/smartedge-open_va_services.md)

   * [smartedge-open_service_mesh.md: Service Mesh support in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/applications/smartedge-open_service_mesh.md)



## Cloud Adapters



* [cloud-adapters: How to deploy public cloud IoT gateways on Smart Edge Open Edge Cloud](https://github.com/smart-edge-open/specs/blob/master/doc/cloud-adapters)

     * [smartedge-open_awsgreengrass.md: Deploying single or multiple instance of Amazon Greengrass IoT gateway on Smart Edge Open edge cloud as an edge application](https://github.com/smart-edge-open/specs/blob/master/doc/cloud-adapters/smartedge-open_awsgreengrass.md)

     * [smartedge-open_baiducloud.md: Deploying single or multiple instance of Baidu IoT gateway on Smart Edge Open edge cloud as an edge application](https://github.com/smart-edge-open/specs/blob/master/doc/cloud-adapters/smartedge-open_baiducloud.md)



## API and Schema



* [Edge Application API: EAA](https://www.openness.org/api-documentation/?api=eaa)

* [Edge Application Authentication API](https://www.openness.org/api-documentation/?api=auth)

* [Core Network Configuration API](https://www.openness.org/api-documentation/?api=cups)

* [schema: Folder containing APIs protobuf or schema for varios endpoints in Smart Edge Open solution](https://github.com/smart-edge-open/specs/tree/master/schema)



## Orchestration

* [smartedge-open-helm.md: Helm support in Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/doc/orchestration/smartedge-open-helm.md)



## Release history



* [smartedge-open_releasenotes.md: This document provides high level system features, issues and limitations information for Smart Edge Open](https://github.com/smart-edge-open/specs/blob/master/smartedge-open_releasenotes.md)



## Related resources



* [Smart Edge Open Website - Developers : Website containing developer resources](https://www.openness.org/developers)

* [Intel Network Builders Smart Edge Open training ](https://builders.intel.com/university/networkbuilders/coursescategory/open-network-edge-services-software-smartedge-open)



## 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

- Smart Edge Open: 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

- CEEK: Converged Edge Experience Kits

- IDO: Intel Distribution of Smart Edge Open