Skip to end of metadata
Go to start of metadata

(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:

  1. Download the API information form (Click to download) or you can use this link to fill out then download the form from Google Drive. 
  2. Follow steps below to fill in the API info form
  3. Upload the form before  (Click to upload)
  4. The API subcommittee will review inputs and verify links. PTLs can check the result from 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. 

    • 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?

Uploaded API Info Forms

 

  File Modified
Microsoft Excel Spreadsheet Akraino_API_Info_5G_MEC_Slice_System.xlsx Jan 22, 2021 by Zigeng Fu
Microsoft Excel Spreadsheet Akraino_API_Info_AI_Edge_Federated_ML.xlsx Nov 11, 2020 by Julie Han
Microsoft Excel Spreadsheet Akraino_API_Info_AI Edge_Video Security Monitoring.xlsx Feb 02, 2021 by Hechun Zhang
Microsoft Excel Spreadsheet Akraino_API_Info_CVB.xlsx Jan 12, 2021 by Tao Wang
Microsoft Excel Spreadsheet Akraino_API_Info_EALTEdge.xlsx Nov 12, 2020 by Gaurav Agrawal
Microsoft Excel Spreadsheet Akraino_API_Info_ELIOT-IOT-Gateway.xlsx Dec 11, 2020 by khemendra kumar
Microsoft Excel Spreadsheet Akraino_API_Info_ELIOT-uCPE.xlsx Dec 06, 2020 by khemendra kumar
Microsoft Excel Spreadsheet Akraino_API_Info_IEC_Type_4.xlsx Jan 12, 2021 by Bart Dong
Microsoft Excel Spreadsheet Akraino_API_Info_IEC TYPE3(Android cloud native applications on Arm servers in edge for Integrated Edge Cloud (IEC) Blueprint Family).xlsx Feb 01, 2021 by hanyu ding
Microsoft Excel Spreadsheet Akraino_API_Info_IEC TYPE3(Android cloud native applications on Arm servers in edge for Integrated Edge Cloud (IEC) Blueprint Family).xlsx Feb 01, 2021 by hanyu ding
Microsoft Excel Spreadsheet Akraino_API_Info_IEC TYPE3(Android cloud native applications on Arm servers in edge for Integrated Edge Cloud (IEC) Blueprint Family).xlsx Feb 01, 2021 by hanyu ding
Microsoft Excel Spreadsheet Akraino_API_Info_KNI_IE.xlsx Oct 30, 2020 by Ricardo Noriega
Microsoft Excel Spreadsheet Akraino_API_Info_KNI_PAE.xlsx Oct 30, 2020 by Ricardo Noriega
Microsoft Excel Spreadsheet Akraino_API_Info_NetworkCloudWithTF.xlsx Dec 09, 2020 by Sukhdev Kapur
Microsoft Excel Spreadsheet Akraino_API_Info_PCEI_R4.xlsx Jan 04, 2021 by Oleg Berzin
Microsoft Excel Spreadsheet Akraino_API_Info_PrivateLTE5GICN.xlsx Feb 04, 2021 by Prem Sankar G
Microsoft Excel Spreadsheet Akraino_API_Info_RadioEdgeCloud.xlsx Nov 02, 2020 by Paul Carver
Microsoft Excel Spreadsheet Akraino_API_Info_smartnic.xlsx Dec 11, 2020 by yihui wang
Microsoft Excel Spreadsheet Akraino_API_Info.xlsx Feb 21, 2021 by Hao Zhongwang
Microsoft Excel Spreadsheet Akraino_API_Info-KubeEdge.xlsx Oct 06, 2020 by Jiafeng Zhu
Microsoft Excel Spreadsheet Akraino_API_Info-MicroMEC.xlsx Initial version, edited with Libreoffice. Oct 26, 2020 by Ferenc Székely
Microsoft Excel Spreadsheet Akraino_API_Predictive_Maintenance_rev.xlsx Dec 18, 2020 by V S
Microsoft Excel Spreadsheet Akraino_API_Predictive_Maintenance.xlsx Nov 27, 2020 by V S
Microsoft Excel Spreadsheet Akraino_ICN_API_Info.xlsx Nov 29, 2020 by Kuralamudhan Ramakrishnan
Microsoft Excel Spreadsheet Intelligent Vehicle-Infrastructure Cooperation System API_Info.xlsx Feb 21, 2021 by Hao Zhongwang

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

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

API subcommittee review completed and info accepted


2Jane 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

API subcommittee review completed and info accepte


3

Jane Shen

Email sent: 10/15

Form uploaded

API subcommittee review completed and info accepted


4

Jiafeng Zhu

Jane Shen

Form uploaded

API subcommittee 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

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

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

Jeff Brower

Form uploaded

Scheduled for review at API subcommittee meeting 18Dec

API subcommittee review completed and info accepted


8

Jane Shen 

Form uploaded

API subcommittee review completed and info accepted


9

Jane Shen

Form uploaded

API subcommittee review completed and info accepted


10

Jane Shen

Email sent: 10/15

Email received

Form uploaded  

API subcommittee review scheduled for  

API subcommittee review completed and info accepted


11Jeff Brower (assignment transferred from Jiafeng Zhu 13Jan21)

Hechun replied by e-mail 12Jan, form is in progress

Form uploaded  

API subcommittee review scheduled for

API subcommittee review completed and info accepted


12Jeff Brower (assignment transferred from Jiafeng Zhu 13Jan21)

Email sent 2Feb20 Hechun and Liya Yu, and 9Feb20 Hechun and Zhongwan Hao

Form uploaded  

API subcommittee review scheduled for 

API Subcommittee completed and info accepted  


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  

Reviewed by API subcommittee

API subcommittee review completed and info accepted


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

Form uploaded , reviewed by API subcommittee

API subcommittee review completed and info accepted


15

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)

API subcommittee review completed and info accepted


16

Jane Shen

Email sent: 10/15; replied

Form received by e-mail

Form uploaded

API subcommittee review completed and info accepted


17

Jane Shen

Email sent: 10/15

Form uploaded on 4Jan21

Scheduled for review at API subcommittee meeting  

API subcommittee review completed and info accepted


18Jane Shen

Form uploaded

API subcommittee review completed and info accepted


19Jeff Brower (assignment transferred from Jiafeng Zhu 13Jan21)

Form uploaded

API subcommittee review completed and info accepted


20

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

Form uploaded  

API subcommittee review scheduled for

API subcommittee review completed and info accepted

TSC Meeting Presentation, Feb2021
21

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

API subcommittee review completed and info accepted  

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.


  • No labels

9 Comments

  1. The Excel sheet seems to be editable only on Windows and on Excel. I tried opening it on Google Docs and that did not work. Ferenc opened it with LibreOffice, same result.

    Doing our best to fill it in somehow.

  2. Tapio Tallgren Ferenc Tóth Thanks for your comments, I created a Google Doc sheet, you can fill out the form in Google Doc, download it to your local, then upload it to this page. Here is the link: https://docs.google.com/spreadsheets/d/e/2PACX-1vSbL0gDGuv1avvNSNTdpkeVP1yY-KDIjTYD_xPEIeQMMPxIu61S37ZYwr0nfyCco89EK6ikCATAjolW/pubhtml . You may find those dropdown lists are not working in Google Sheet. It is because MS Excel Macros are disabled when we transfer the form to Google Sheet. However, You can still use the API categories' image as your references. Please let me know if you encounter any difficulties. 



  3. Thanks Kural  ... can you include the link ?

  4. For uploaded for ELIOT IOT-Gateway and uCPE BP

  5. This is the ICN (Integrated Cloud Native) slides link (thanks Kuralamudhan Ramakrishnan). khemendra kumar I still need a link to your ELIOT IOT Gateway slides

  6. PCEI R4 API Spreadsheet has been uploaded for the API sub-committee review  

  7. Thanks Oleg. We have PCEI scheduled for tomorrow (Fri) review at API subcommittee meeting

  8. API info for IoT Workloads at the Smart Device Edge (Predictive Maintenance) BP accepted. Good job guys ! IoT will be well presented in the updated version of the Akraino API Map, due out by end of January