Sukhdev Kapur

Jeff Brower - added items in red

Release 5 target date is June 30th 2021.  

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

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 4 to Release 5

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

• Did you make any improvements in release 5 - 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 3 to Release 5

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

Note that in release 4, 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 2 or earlier to Release 5

If the blueprint is already part of release 1 or 2 and not release 3 or 4 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 5

Please follow the requirements specified in release 4 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.

1. Self Certified Milestones Achievement Due Date May 31st 2021 ( Milestone 4) 

2. Maturity Review Milestone Achievement  Due date May 31st 2021

Please add targeted and achieved R4 milestones at:

BP Incubation Stage Reporting R4 (To be updated)

Define area of focus

(to be updated)

1. Virtual meeting to start to have a session to discuss all of the agenda items.
2. Different patches from different blueprints need to be up-streamed.
3. Need a consistent framework
4. New blueprints have been committed for R5.
5. Want to increase standards on Release 5.
6. Validation Project test layers and test cases
7. Self Certification in R4?

Release 5 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 R4 and R5 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 R4 release Upstream BP review status, Release Upstream Compliance. Also please refer to the page for the R4 requirement as well.

Blue Prints Participating in Release 5

Internal Target date to meet Rel 5 Criteria is June 30th ( please add your target/achieved date at the BP Incubation Stage Reporting R2 (To Be Updated))

(To be updated)