Skip to end of metadata
Go to start of metadata

Release 6 target date is April 30th 2022.  

Classes of release 6 Blueprints and the requirements to be included in Release 6

The requirements for the blueprints to be included in release 5 are as follows:

Depending upon the situation, the PTLs are suggested to meet the following criteria - 

Class 1: The Blueprints moving from Release 5 to Release 6

If the blueprint is already part of release 5 and you want this to be included in release 5, please follow the following steps:

  • Did you make any improvements in release 6 - e.g. you fixed bugs or added additional features? 
    • If Yes: 
      • Does it impact the APIs or Documentation?
        • If yes,
          • Please update the APIs and the documentation and send the email to respective sub-committee chairs. 
          • For APIs, please see API Subcommittee Guidelines below
        • Run the security scans and upload the link in the table below next to your blueprint
        • Upload the latest CI/CD logs
        • Send an email to tsc@lists.akraino.org to notify the TSC 
        • Put yourself on the TSC agenda and request for the approval
    • If No:
      • No additional formalities are required
      • Send an email to tsc@lists.akraino.org to notify the TSC 
      • Put yourself on the TSC agenda and request for the approval

Class 2: The Blueprints moving from Release 4 to Release 6

If the blueprint is already part of release 4 and not release 5 and you want this to be included in release 6, please follow the following steps:

Note that in release 5, a new requirement was introduced to expose all the API consumed and offered by your blueprint. 

  • Please update the documentation to include new API section.
  • Follow the guidelines to submit API information as per the requirements specified in the API sub-committee
  • send the email to respective documentation and API sub-committee lists.
    • If you require assistance with documentation or APIs, please reach out the respective subcommittee to be included on their agenda and discuss with them otherwise you are done
    • For APIs, please see API Subcommittee Guidelines below
  • Run the security scans and upload the link in the table below next to your blueprint
  • Upload the latest CI/CD logs
  • Send an email to tsc@lists.akraino.org to notify the TSC 
  • Put yourself on the TSC agenda and request for the approval

Class 3: The Blueprints moving from Release 3 or earlier to Release 6

If the blueprint is already part of release 1 or 2 and not release 3 or 4 or 5 and you want this to be included in release 5, please follow the following steps described under Class 4 below.

Class 4: New Blueprints being introduced for the first time in Release 6

Please follow the requirements specified in release 6 with the following exceptions:

  1. The sub-committee presentations are optional starting from release 5 and for your benefit only. If you require assistance on any of the areas such as APIs, documentation, Security scans or CI/CD logs, please schedule a meeting with appropriate subcommittee. 
  2. For APIs, please see API Subcommittee Guidelines below
  3. Once you meet the requirements of respective subcommittee, please send them an email to notify them. Except for APIs, as noted in 2., if they require any clarification, they will either invite you to meet with them or they will approve your blueprint via email.
  4. Send an email to tsc@lists.akraino.org to notify the TSC 
  5. Put yourself on the TSC agenda and request for the approval

API Subcommittee Guidelines

Please follow step-by-step instructions on the API Subcommittee API reporting wiki page. If after submitting your API info form (or an updated form, if you are in Class 1 and the form has changed since Release 4) and notifying the subcommittee by e-mail they have questions, then schedule a time when either subcommittee members may attend your weekly BP meeting or you can attend the API subcommittee weekly meeting in order to discuss and resolve the questions. When meeting, please be prepared with architecture and data flow diagrams so the API subcommittee can understand and confirm 1) APIs consumed and offered by your BP, 2) upstream project APIs, and 3) customer-facing demo APIs. This information will be used to update the Akraino website API Map, which makes your BP visible and searchable to customers and entities outside of Akraino, so completeness and accuracy is important.

Release 6 Requirements

  1. High Level Overall Requirements
  2. CI, Blueprint Validation Lab Sub-Committee Requirements
    1. Present Pod Topology document.
    2. Peering w/LF Jenkins - (Note: peering is an optional requirement)
    3. Push logs through Nexus. (Note: This is mandatory for Incubation self-certified and Maturity)
    4. Usage of topics for release

      1. Releases >= 1.0 (e.g. 1.xyz, 2.xyz etc) are reserved for BP that have been approved as Core by the TSC (considered ‘GA’ quality).

      2. Releases <1.0 (e.g. 0.xyz etc) are reserved for projects that have not reached the Akraino Core level (i.e. anything that is in Incubation (‘alpha’ quality) and Mature (‘beta’ quality).

    5. Enforcement of Static Code Analysis through SonarCloud (SaaS), WIP LF Release Engineering & Security Subcommittee. (Note: This is an optional requirement for Incubation self certified and mandatory for Maturity)

  3. Security Sub-Committee Requirements, please fill in Release 4 Blueprint Scanning Status.  Instructions can be found at:  Steps To Implement Security Scan Requirements
  4. Blueprint Validation Framework Feature Project Requirements See TSC meeting.
  5. Projects going for Maturity Review please refer to Maturity Criteria defined by Process subcommittee BP Graduation Review Processes and Criteria (Note this is not required for self certification, only required for maturity review)
  6. Documentation Sub-Committee Requirements

    User Documents:

    The following documentation with the following sections called out should be on the wiki with links to rest of the sections as applicable. We prefer that the entire doc is on the wiki but we do not require it.

    Architecture  - Blue print Overview and overall architecture

    Release Notes – Summary and What is released

    Installation Doc – Introduction and deployment architecture

    Test Document – Introduction and Overall Test Architecture

    Developer Documents:

    We are also recommending that Blueprints include via ReadtheDocs, with each Blue Print given their own repo, but we do not require it

  7. API Sub-Committee Requirements  (Note: See this link for requirements: Blueprint Projects API Reporting Requirements)
  8. Community Sub-Committee Requirements  (Note: no mandatory requirements for Incubation self-certified or Maturity)
  9. Process Sub-Committee Requirements (Note: See the Process Sub Committee page defining the TSC approved Maturity review process and requirements for those requesting inclusion in R3 at Mature level BP Graduation Review Processes and Criteria)
  10. Upstream Sub-Committee Requirements (Note: no mandatory requirements for Incubation self-certified or Maturity). Here is the R6 release Upstream BP review status Release 6 Upstream Review Status, Release Upstream Compliance. Also please refer to the page for the R6 requirement as well.


Blue Prints Participating in Release 6

Internal Target date to meet Rel 6 Criteria is April 30th

(To be updated)

No.Project NameTSC Subgroup Release StatusIs this your first release 

Blue Print Stage

  • Self-Certify
  • Incubation
  • Mature
  • Core

CD Logs URL to be used for review

(Column filled in by PTLs)

How to: Push Logs to Nexus

Jenkins Master for Private Lab

Jenkins Peering Guide

Example: 

KubeEdge BP Test Documents

Link to executive one pager

(editable doc format)

(Column filled in by PTLs)

API Info Reporting Review

(Column filled in by API Subcommittee)

(note for PTLs – go here for steps to fill in project API info form)

BluVal

BlueVal Logs or Manual Logs

Bluval User Guide


Security

Certification

(TO be filled by Security Subcommittee)

Pass/Fail Criteria:  Steps To Implement Security Scan Requirements

Exception requests should be filed at:

Release 6: Akraino CVE and KHV Vulnerability Exception Request

Upstream Review (Column filled by Upstream Subcommittee and PTLs)


(note PTL can go to Release 6 Upstream Review Status to find details)

Date ready for TSC review

(Column filled in by PTLs)

 TSC Review Date

(Column filled in by TSC)


1
NoMature



https://nexus.akraino.org/content/sites/logs/parserlabs/r4/



2
NoMature

No API changes expected from R5, per Bart Dong in TSC meeting . Waiting for e-mail from Bart to confirm this


https://nexus.akraino.org/content/sites/logs/parserlabs/r4/



3














4
NoIncubationICN R6 Datasheet

No API changes from R5, per e-mail from Kural Ramakrishnan

BluVal Results

  

lynis results: Accepted

vuls results: Accepted

kube-hunter results: Accepted


Approved

 



5
NoIncubation

No API changes from R5, per e-mail from Salvador Fuentes  







6
NoIncubationhttps://nexus.akraino.org/content/sites/logs/huawei/job/Eliot-aio-log/19/

No API changes from R5, per e-mail from Khemendra Kumar 

Info for ELIOT IOTGateway APIs:

https://wiki.akraino.org/display/AK/ELIOT+R6+IOTGateway+API+documentation

https://nexus.akraino.org/content/sites/logs/huawei/job/Eliot-security-test/31/results/

lynis results: Accepted

vuls results: Accepted

kube-hunter results:

pod:

KHV043 - Cluster Health Disclosure
Disable --enable-debugging-handlers kubelet flag.

Approved


7
NOIncubation
ELIOT R6 - SD-WAN / WAN Edge / uCPE Data Sheet






8
NoMature










9
NoIncubation








10
NoIncubation










11

Micro-MEC

Ferenc Székely







 







12
Noincubation

No API changes expected from R5, per Liya Yu in TSC meeting . Waiting for e-mail from Liya to confirm this.

Confirmed in e-mail sent by Liya  







13
No
  • Incubation


No API changes from R5, per e-mail from ZhuMing Zhang  

https://nexus.akraino.org/content/sites/logs/fate/job/I-VICS/5/No new features or bugs have been added after R4 release



14
NoIncubation









15
NoIncubationhttps://nexus.akraino.org/content/sites/logs/ysemi/job/v1/upload/iec-tox-verify-master_334/https://wiki.akraino.org/download/attachments/24084647/IEC%20Release3-IEC%20Type3-datasheet.docx?version=5&modificationDate=1591272863000&api=v2

API form uploaded by Davy Zhang , scheduled for review at API subcommittee meeting

Approved by API subcommittee at weekly meeting  

 

https://nexus.akraino.org/content/sites/logs/ysemi/job/v1/validation_results_v5/

 

https://nexus.akraino.org/content/sites/logs/ysemi/job/v1/validation_results_v6/ 

  

lynis results: Accepted

vuls results: Accepted

kube-hunter results: Accepted

Approved


16
NoIncubationhttps://dev.socnoc.cn/#/homeSOCNOC Release 6 One pag - Akraino - Akraino Confluence

No API changes expected from R5, per Leo Li in TSC meeting . Waiting for e-mail from Leo to confirm this

Leo confirmed by mail  



socnoc - Akraino - Akraino Confluence




17
NoIncubationhttps://nexus.akraino.org/content/sites/logs/huawei/job/Ealtedge-aio-log/15/EALTEDGE Release 6 Datasheet

No API changes from R5, per e-mail from Khemendra Kumar  

Info for EALTEdge APIs:

https://wiki.akraino.org/pages/viewpage.action?pageId=53478299

https://nexus.akraino.org/content/sites/logs/huawei/job/Ealt-edge-security-test/26/results/

 

lynis results: Accepted

vuls results: Accepted

kube-hunter results:

pod:KHV043 - Cluster Health Disclosure
Disable --enable-debugging-handlers kubelet flag.


Approved


18


TSC 2022-05-12 (Thursday) 7:00 am PacificNoIncubationhttps://nexus.akraino.org/content/sites/logs/cmti/job/pcei-daily/https://wiki.akraino.org/x/SC0wAw

Revised API info form sent to Oleg per his requirements (see API Subcommittee meeting minutes for details)


Note - PCEI Blueprint R6 API documentation located here (as of ):

https://wiki.akraino.org/x/Qy0wAw

 

lynis results: Accepted

vuls results: Accepted

kube-hunter results: Accepted


Approved per the upstream review


https://wiki.akraino.org/x/Ui0wAw

 

 


19

TSC 2022-03-17 (Thursday) 7:00 am Pacific

No
  • Mature
https://nexus.akraino.org/content/sites/logs/fate/job/Fate_test/15/Akraino R6 Federated ML blueprint datasheet.docx

No API changes from R5, per e-mail from HaiHui Wang

Incubation Level Review Results:

 

VulsAccepted with exceptions shown at:

Release 5 Vuls Exception Request

__________________________________________________________

LynisAccepted

__________________________________________________________

Kube-Hunter:  Exception granted:  K8s not used by this BP.

 







20
NoIncubation








21

Private LTE/5G ICN Blueprint

Prem Sankar G

has been merged with PCEI blueprint













22
YesIncubation








23

Smart Cities

Olivier Bernard Cindy Xing Alexander Su (alexander@nexcom.com)

Jason Wen

Jack Liu

TSC 2022-05-12 (Thursday) 7:00 am Pacific

NoIncubationhttps://nexus.akraino.org/content/sites/logs/myais/job/smartcities/8

No API changes expected from R5, per TSC meeting discussion . Waiting for e-mail from Jason or Jack to confirm this.

Update - API form uploaded by Jason , scheduled for review at API subcommittee meeting  

Approved by API subcommittee at weekly meeting

https://nexus.akraino.org/content/sites/logs/myais/validation/1/

 

https://nexus.akraino.org/content/sites/logs/myais/validation/2

fix lynis issue, in pb use k3s, add kube-hunter test.

 

https://nexus.akraino.org/content/sites/logs/myais/validation/3

fix kube-hunter issue ,except CAP_NET_RAW.

 

 

lynis results: Accepted

vuls results: Accepted

kube-hunter results:  Accepted

Smart Cities R6 Upstream.


Approved

 

 


24
NoIncubation









25
NoIncubation









26
No









27
NoIncubation








28


Yes

Incubation

BluVal:

https://nexus.akraino.org/content/sites/logs/fujitsu/job/sdt-bluval/2/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/sdt-lynis/3/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/sdt-vuls/2/

Other:

https://nexus.akraino.org/content/sites/logs/fujitsu/job/edgex-install/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/edgex-lora/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/lfedge-cluster/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/lfedge-install/

SDT Datasheet.docx

Per e-mail from Colin Peters  , blueprint consumes Kubernetes and EdgeX APIs. They are uploading API info form

API info form uploaded  

Scheduled for review by API subcommittee review 

Reviewed and approved by API subcommittee  

https://nexus.akraino.org/content/sites/logs/fujitsu/job/sdt-bluval/2/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/sdt-lynis/3/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/sdt-vuls/2/

 

sdt-lynis results: Accepted

sdt-vuls results: Accepted

All Exceptions are granted

Release 6: Akraino CVE Vulnerability Exception Request

Smart Data Transaction for CPS Release Notes

Approved

2022/04/132022/04/14
29
YesIncubation


https://nexus.akraino.org/content/sites/logs/fujitsu/job/robot-family/sses-lynis/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/robot-family/sses-lynis/

Robot basic architecture based on SSES One Pager

Per e-mail from Inoue Reo , blueprint does not export or consume APIs. They are uploading an API info form to indicate this, along with comments about future / possible API plans

Inoue Reo uploaded an API info form . Review by API subcommittee is scheduled for  

Reviewed and approved by API subcommittee

https://nexus.akraino.org/content/sites/logs/fujitsu/job/robot-family/sses-lynis/

https://nexus.akraino.org/content/sites/logs/fujitsu/job/robot-family/sses-lynis/









  

robot Lynis results: Accepted 

iotgateway Lynis results: Accepted   

robot vuls resultsAccepted
All exceptions are granted

iotgateway vuls resultsAccepted
All exceptions are granted

Release 6: Akraino CVE Vulnerability Exception Request

Approved per the BP upstream review

2022/04/132022/04/14
  • No labels