View Source

(Under Construction)

Overview

Motivation: improve customer access and knowledge for Release 4 (R4) blueprint projects. Consistent and well-organized APIs with baseline information will increase Akraino adoption.
All R4 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.

Who should fill in the API requirements form

Akraino blueprint project PTLs should fill in the API info form, as a mandatory requirement for R4.

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 before 25 Oct 2020 (Click to upload)
The API subcommittee will review inputs and verify links. PTLs can check the result from TSC Release 4 planning table

Akraino > Blueprint Projects API Reporting Requirements > R4_API_reporting_requirements_spreadsheet_screencap_v3.png

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.

Akraino > Blueprint Projects API Reporting Requirements > R4_API_map.png

- Additional information of any type may be added to the "Comments" field. Don't hesitate to let us know why specific APIs are fundamental / important to your project.
- Please double check all links that you've filled in the form, and make sure they link to the latest version of your project.
- If you have no relevant APIs exported or consumed, please explain why this is the case in the Comments field.

Examples

Click here for KubeEdge Edge Service BP API Information Form Example

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

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.	R4 Project Names	API Subcommittee member assignment	Status	Notes
1	Connected Vehicle Blueprint Thor Chin Tao Wang	Jiafeng Zhu	Email sent: 10/10 replied Form uploaded 15Dec Scheduled for review by API subcommittee 21Dec 6:00p PST (22Dec 10:00a CST) Review discussion: BP will add PaaS APIs, re-upload form
2	IEC Type 4: AR/VR oriented Edge Stack for Integrated Edge Cloud (IEC) Blueprint Family Bart Dong Thor Chin	Jane Shen	First round email exchange on 12/09 with instruction link sent. Form uploaded Scheduled for review by API subcommittee 21Dec 6:00p PST (22Dec 10:00a CST) Review discussion: BP will add PaaS APIs, re-upload form
3	Radio Edge Cloud (REC) Paul Carver	Jane Shen	Email sent: 10/15 Form uploaded API committee review completed and info accepted
4	ICN - Integrated Cloud-Native Family Kuralamudhan Ramakrishnan	Jiafeng Zhu Jane Shen	Form uploaded API committee review completed and info accepted BP reviewed on TSC 16 Dec.	API Sub committee 12/4/2020 meeting minutes Slides presented with API related info:
5	ELIOT IoT Gateway Blueprint khemendra kumar	Jiafeng Zhu	Email sent: 10/10 and 10/15 Try to join their weekly meeting, but none was in the meeting Participated ELIOT weekly meeting 10/21, and demonstrated how to fill out the API Info Form Form uploaded Review completed during API subcommittee meeting 11Dec BP reviewed on TSC 16 Dec.
6	ELIOT SD-WAN/WAN Edge/uCPE Blueprint khemendra kumar	Jiafeng Zhu	Email sent: 10/10 and 10/15 Try to join their weekly meeting, but none was in the meeting Participated ELIOT weekly meeting 10/21, and demonstrated how to fill out the API Info Form Review completed during API subcommittee meeting 11Dec BP reviewed on TSC 16 Dec.
7	Network Cloud and Tungsten Fabric Integration Project Sukhdev Kapur	Jeff Brower	Form uploaded Scheduled for review at API subcommittee meeting 18Dec API committee review completed and info accepted
8	KNI Provider access edge Ricardo Noriega	Jane Shen	Form uploaded API committee review completed and info accepted
9	KNI Industrial Edge Ricardo Noriega	Jane Shen	Form uploaded API committee review completed and info accepted
10	Micro-MEC Ferenc Székely	Jane Shen	Email sent: 10/15 Email received Form uploaded 26 Oct 2020 API committee review scheduled for 22Jan21
11	The AI Edge: School/Education Video Security Monitoring Hechun Zhang	Jiafeng Zhu	Hechun replied by e-mail 12Jan, form is in progress API committee review tentatively scheduled for 22 Jan 2021
12	The AI Edge: Intelligent Vehicle-Infrastructure Cooperation System(I-VICS) Hechun Zhang	Jiafeng Zhu
13	5G MEC/Slice System to Support Cloud Gaming, HD Video and Live Broadcasting Blueprint Feng Yang	Jane Shen	Email sent: 10/15 Form uploaded 25 Oct 2020 Reviewed by API subcommittee Nov 2020
14	IEC Type 3: Android cloud native applications on Arm servers in edge for Integrated Edge Cloud (IEC) Blueprint Family hanyu ding	Jeff Brower (assignment transferred from Jane Shen 15Jan21)	E-mail discussion 21Jan, they have no APIs consumed or exported but still need to fill out the form with BP name and explain current and future API status in the comments
15	IEC Type 5: SmartNIC for Integrated Edge Cloud (IEC) yihui wang	Jeff Brower	Jiafeng sent e-mail 27Oct, Yihui replied 28Oct Form uploaded Scheduled for review by API subcommittee 21Dec 6:00p PST (22Dec 10:00a CST)
16	Enterprise Applications on Lightweight 5G Telco Edge Gaurav Agrawal	Jane Shen	Email sent: 10/15; replied Form received by e-mail Form uploaded API committee review completed and info accepted
17	Public Cloud Edge Interface (PCEI) Blueprint Oleg Berzin	Jane Shen	Email sent: 10/15 Form uploaded on 4Jan21 Scheduled for review at API subcommittee meeting 8Jan
18	The AI Edge: Federated ML application at edge Julie Han	Jane Shen	Form uploaded API committee review completed and info accepted
19	KubeEdge Edge Service Blueprint Yin Ding	Jiafeng Zhu	Form uploaded API committee review completed and info accepted
20	Private LTE/5G ICN Prem Sankar G	Ike Alisson (assignment transferred from Neal Oliver 15Jan21)	Have not joined their group meeting yet, as it is a double-conflict in meeting schedule. Will attempt to work with them offline. Received response email. Still need to follow up..... Prem replied by e-mail 12Jan, form is in progress API committee review tentatively scheduled for 22 Jan 2021
21	IoT Workloads at the Smart Device Edge - Predictive Maintenance (with a Thermal Imaging Camera, vibration sensors, etc.) V S Aaron Williams	Jeff Brower	Form uploaded Scheduled for review by API subcommittee 11Dec Review completed during BP project meeting 11Dec. Updated API info form will be uploaded by V S Form uploaded by V S on 18 Dec, will be reviewed by API subcommittee on 8 Jan	Info received from BP technical members, and Jeff and Jane have attended their weekly meetings to understand their architecture and project API usage. Jeff has created an architecture diagram showing API, CLI, and GUI interfaces. An R4 release review meeting for the BP is scheduled for 9 Dec (Jeff will attend).
22	ELIOT AIoT in Smart Office	Jiafeng Zhu	Email sent: 10/10 and 10/15	This BP is not showing in the R4 Release Planning page

API Review Meeting Minutes

Here is the release 4 BP API review meeting minutes.