Blueprint Projects API Reporting Requirements
Overview
Motivation: improve customer access and knowledge for blueprint projects. Consistent and well-organized APIs with baseline information will increase Akraino adoption
All project APIs will be organized and published on the API map page of the Akraino API Portal. The API Portal will include both API map navigation and search capability, to allow customers to investigate APIs they may need
In addition to blueprint projects' mandatory baseline API info, optional information about (a) telco network interface APIs, and (b) Kubernetes environment APIs info will be collected. This will be used to support one-stop API presentation, analysis, comparison, finding similar APIs, and sandbox/sample code
The TSC has asked the API subcommittee to identify commonality between APIs, and possibly identify a “base” set of Akraino edge computing APIs. This is future work, under discussion
This page contains API info for Releases R4-R6, in reverse chronological order (i.e. most recent first)
Who should fill in the API requirements form
Akraino blueprint project PTLs should fill in the API info form, as a mandatory requirement for releases R4, R5, and R6
Procedure
Below are instructions for API information gathering:
Download the API information form (Click to download) or you can use this link to fill out then download the form from Google Drive.
Follow steps below to fill in the API info form
Upload the form (link takes you to list of uploaded forms, below that is a drag and drop / browse area for uploading forms)
The API subcommittee will review inputs and verify links. PTLs can check the results in the TSC Release 6 planning table (or previously TSC Release 5 planning table or TSC Release 4 planning table)
You can select API categories by choosing values from drop down lists embedded in the Excel spreadsheet. If you believe your project API doesn't fit existing categories, please explain in the "Comments" field and specify how your project APIs would be better categorized.
Examples
Questions?
You can send your questions to API subcommittee mailing list api@lists.akraino.org
Or, leave comments at the bottom of this page
Join API subcommittee weekly meetings (Friday morning 9:00am PST https://zoom.us/j/294712016) if you'd like to discuss your APIs with us.
In case you don't use Microsoft Office, you can fill out the form in Google Doc https://docs.google.com/spreadsheets/d/e/2PACX-1vSbL0gDGuv1avvNSNTdpkeVP1yY-KDIjTYD_xPEIeQMMPxIu61S37ZYwr0nfyCco89EK6ikCATAjolW/pubhtml. However, you MUST download it from Google Doc and Upload to this page.
Uploaded API Info Forms
R7 API Information Collection and Review Status
Note – updates in this table are made by API subcommittee members only. PTLs should fill out the spreadsheet above, and then upload under "Uploaded API Info Forms" above.
No. | R5 Project Names | API Subcommittee member assignment | Status | Notes |
1 | @thorking @Tao Wang | Brower |
|
|
2 | IEC Type 4: AR/VR oriented Edge Stack for Integrated Edge Cloud (IEC) Blueprint Family @Bart Dong @thorking | Brower |
|
|
3 |
|
|
|
|
4 | ICN - Integrated Cloud-Native Family @Kuralamudhan Ramakrishnan (Deactivated) | Brower |
| Kural sent e-mail Apr 28, 2022 saying no changes for "ICN Blueprint R6 release" but not specifying which ICN BPs |
5 | ICN - Multi-Tenant Secure Cloud Native Platform @Kuralamudhan Ramakrishnan (Deactivated) | Brower |
|
|
6 | @khemendra kumar | Brower |
| Info for ELIOT IOTGateway APIs: |
7 | ELIOT SD-WAN/WAN Edge/uCPE Blueprint @khemendra kumar | Brower |
|
|
8 | Network Cloud and TF (Tungsten Fabric) Integration Project @Sukhdev Kapur | Brower |
|
|
9 | @Ricardo Noriega | Brower |
|
|
10 | @Ricardo Noriega |
|
|
|
11 | Micro MEC | Brower |
|
|
12 | The AI Edge: School/Education Video Security Monitoring @Yu, Liya | Brower |
|
|
13 | The AI Edge: Intelligent Vehicle-Infrastructure Cooperation System(I-VICS) @Hechun Zhang | Brower |
|
|
14 | 5G MEC/Slice System to Support Cloud Gaming, HD Video and Live Broadcasting Blueprint @Feng Yang | Brower |
|
|
15 | @hanyu ding @Rajeev Gadgil | Brower |
|
|
16 | IEC Type 5: SmartNIC for Integrated Edge Cloud (IEC) Blueprint Family @Yihui Wang | Brower |
|
|
17 | Enterprise Applications on Lightweight 5G Telco Edge @gaurav.agrawal | Brower |
| Info for EALTEdge APIs: |
18 | Public Cloud Edge Interface (PCEI) Blueprint @Oleg Berzin (Deactivated) | Brower |
| Note - PCEI Blueprint R6 API documentation located here (as of Apr 12, 2022): |
19 | The AI Edge: Federated ML application at edge @rolandwu | Brower |
|
|
20 | KubeEdge Edge Service Blueprint @Yin Ding |
|
|
|
21 | @Prem Sankar G | Brower |
|
|
22 | Rural Edge blueprint for Tami COVID-19 Blueprint Family @Surojit Banerjee |
|
|
|
23 | @Olivier Bernard (Deactivated) @Cindy Xing @JasonWenMyais @Jack Liu Alexander Su (alexander@nexcom.com) | Brower |
|
|
24 | MEC-based Stable Topology Prediction for Vehicular Networks @Asif Mehmood | Brower |
|
|
25 | IEC Type 2 for Integrated Edge Cloud (IEC) Blueprint Family @Site Administrator @Trevor Tao (Deactivated) | Brower |
|
|
26 |
|
|
|
|
27 | Federated Multi-Access Edge Cloud Platform @Deepak Vij | Brower |
|
|
28 | @Colin Peters | Brower |
|
|
29 | Robot Basic Architecture Based on SESS @Haruhisa Fukano | Brower |
|
|
R7 API Review Meeting Minutes
R6 API Information Collection and Review Status
Note – updates in this table are made by API subcommittee members only. PTLs should fill out the spreadsheet above, and then upload under "Uploaded API Info Forms" above.
No. | R5 Project Names | API Subcommittee member assignment | Status | Notes |
1 | @thorking @Tao Wang | Brower |
|
|
2 | IEC Type 4: AR/VR oriented Edge Stack for Integrated Edge Cloud (IEC) Blueprint Family @Bart Dong @thorking | Brower | No API changes expected from R5, per Bart Dong in TSC meeting Apr 7, 2022. Waiting for e-mail from Bart to confirm this |
|
3 |
|
|
|
|
4 | ICN - Integrated Cloud-Native Family @Kuralamudhan Ramakrishnan (Deactivated) | Brower |
| Kural sent e-mail Apr 28, 2022 saying no changes for "ICN Blueprint R6 release" but not specifying which ICN BPs |
5 | ICN - Multi-Tenant Secure Cloud Native Platform @Kuralamudhan Ramakrishnan (Deactivated) | Brower | No API changes from R5, per e-mail from Salvador Fuentes May 16, 2022 Jeff updated the R6 planning table page and cc'd Kural and TSC May 16, 2022 |
|
6 | @khemendra kumar | Brower | No API changes from R5, per e-mail from Khemendra Kumar Apr 28, 2022 | Info for ELIOT IOTGateway APIs: |
7 | ELIOT SD-WAN/WAN Edge/uCPE Blueprint @khemendra kumar | Brower | No API changes from R5, per e-mail from Khemendra Kumar May 26, 2022 |
|
8 | Network Cloud and TF (Tungsten Fabric) Integration Project @Sukhdev Kapur | Brower |
|
|
9 | @Ricardo Noriega | Brower |
|
|
10 | @Ricardo Noriega |
|
|
|
11 | Micro MEC | Brower |
|
|
12 | The AI Edge: School/Education Video Security Monitoring @Yu, Liya | Brower | No API changes expected from R5, per Liya Yu in TSC meeting Mar 31, 2022. Waiting for e-mail from Liya to confirm this. Confirmed in e-mail sent by Liya May 10, 2022 |
|
13 | The AI Edge: Intelligent Vehicle-Infrastructure Cooperation System(I-VICS) @Hechun Zhang | Brower | No API changes from R5, per e-mail from ZhuMing Zhang Apr 28, 2022 |
|
14 | 5G MEC/Slice System to Support Cloud Gaming, HD Video and Live Broadcasting Blueprint @Feng Yang | Brower | No API changes from R5, per e-mail from Eagan Fu May 23, 2022 |
|
15 | @hanyu ding @Rajeev Gadgil | Brower |
|
|
16 | IEC Type 5: SmartNIC for Integrated Edge Cloud (IEC) Blueprint Family @Yihui Wang | Brower | No API changes expected from R5, per Leo Li in TSC meeting Apr 7, 2022. Waiting for e-mail from Leo to confirm this Leo confirmed by e-mail May 10, 2022 |
|
17 | Enterprise Applications on Lightweight 5G Telco Edge @gaurav.agrawal | Brower | No API changes from R5, per e-mail from Khemendra Kumar Apr 28, 2022 | Info for EALTEdge APIs: |
18 | Public Cloud Edge Interface (PCEI) Blueprint @Oleg Berzin (Deactivated) | Brower | Revised API info form sent to Oleg per his requirements (see API Subcommittee meeting minutes Apr 22, 2022 for details) |