...

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 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.

...