OpenStack DefCore Process 2015A
|Status:||Superseded (by 2015B)|
This document describes the DefCore process required by the OpenStack bylaws and approved by the OpenStack Technical Committee and Board.
Expected Time line:
|Time Frame||Milestone||Activities||Lead By|
|-3 months||S-3||"Preliminary" draft (from current)||DefCore|
|-2 months||S-2||ID new Capabilities||Community|
|-1 month||S-1||Score Capabilities||DefCore|
|Advisory/Deprecated items selected||DefCore|
|+2 months||S+2||Test Flagging||DefCore|
|+3 months||S+3||Approve Guidance||Board|
Note: DefCore may accelerate the process to correct errors and omissions.
The DefCore Guideline process has two primary phases: Draft and Review. During the Draft phase (A), the DefCore Committee is working with community leaders to update and score the components of the guideline. During the Review phase (B), general community and vendors have an opportunity to provide input and check the guidelines (C) against actual implementations. Review phase ends with Board approval of the draft guideline (D).
This section provides specific rules and structure for each phase.
NOTE: To ensure continuity of discussion, process components defined below must _not_ reuse numbers in future revisions. The numbering pattern follows draft, section and sub-item numbering, e.g.: 2015A.B2.2. This requirement may create numbering gaps in future iterations that will help indicate changes.
Guidelines Draft Phase (A)
A1. New Guidelines Start From Previous Guidelines
- New Guidelines start from the previous Board approved document.
- New Guidelines are given the preliminary name of the target year and .next. (ref section D4)
A2. Community Groups Tests into Capabilities
- DefCore Committee coordinates community activities with the Technical Leadership to revise the capabilities based on current technical needs and functionality.
- Capabilities must correspond to projects which are part of the "TC-approved release" as designated by the TC (see bylaws of the Foundation, section 4.1(b)(iii)).
- Groupings may change between iterations.
- Tests must have unique identifiers that are durable across releases and changes in grouping.
- Tests must be under OpenStack Technical Committee governance.
- The DefCore committee will provide the test groupings in JSON format for scoring.
- The DefCore committee will provide a human-readable summary of the Guideline generated from the JSON version.
A3. DefCore Collects Recommendations for Designated Sections
- Designated Sections will not be removed without being deprecated in the previous Guideline.
- Designated Sections will not be added without being advisory in the previous Guideline.
- Designated Sections will not be added or be made advisory unless the corresponding code base is designated as part of the "TC-approved release" by the Technical Committee (see bylaws of the Foundation, section 4.1(b)(iii)).
- Technical leadership may, but is not required to, assist DefCore with defining advisory sections for projects that have advisory or required capabilities.
- Designated Sections may be sufficiently defined for Guidelines using general descriptions.
- DefCore will present A3.4 descriptions to the Board for approval.
- Technical leadership may, but is not required to, provide more specific details describing the Designated Sections for a project.
- Designated Sections will be included in the JSON Guideline.
A4. DefCore Committee identifies required capabilities
- DefCore uses Board approved DefCore scoring criteria to evaluate capabilities.
- DefCore needs Board approval to change scoring criteria.
- Scoring criteria factor or weights cannot change after Draft is published.
- DefCore identifies cut-off score for determining that a capability is required.
- Capabilities will not be removed without being deprecated in the previous Guideline.
- Capabilities will not be added without being advisory in the previous Guideline.
- A5. Foundation Staff recommends OpenStack Components and OpenStack Platform
- Foundation Staff recommends capabilities to include in each OpenStack Component.
- Foundation Staff recommends which Components are required for the OpenStack Platform.
A6. Additional Capabilities and Tests
- DefCore will work with the community to define new capabilities.
- Test grouping for new capabilities will be included in the DefCore documents.
- DefCore will publish a list of missing capabilities and capabilities with inadequate test coverage.
A7. DefCore Committee creates recommendation for Draft.
- DefCore Committee coordinates activities to create draft.
- DefCore Committee may choose to ignore recommendations with documented justification.
Guidelines Review Phase (B)
B1. All Reference Artifacts are reviewed via Gerrit
- Draft Guideline
- Designated sections
- Test-Capability groupings
- Flagged Test List
- Capability Scoring criteria and weights
- Not in Gerrit: Working materials (spreadsheets, etc)
B2. Presentation of Draft Guidelines for Review
- DefCore will present Draft Guidelines to the Board for review.
- DefCore will distribute Draft Guidelines to the community for review.
- Foundation Staff will provide Draft Guidelines to vendors for review.
- A link to the Gerrit document must be provided with the review materials.
B3. Changes to Guideline made by Gerrit Review Process
- Community discussion including vendors must go through Gerrit.
- All changes to draft must go through Gerrit process.
- DefCore will proxy for users who do not participate in the Gerrit process with attribution.
B4. For Gerrit reviews, DefCore CoChairs act as joint PTLs
- Board committee members of DefCore serve as "core" reviewers (+2).
- Requests for changes must be submitted as patches by the requesting party.
- DefCore Committee members may proxy change requests as long as the requesting party is explicitly acknowledged.
Community Review & Vendor Self-Test (C)
Starting: S and continues past S+3
C1. Vendor Self-Tests
- Vendors are responsible for executing tests identified by the DefCore committee.
- The Foundation may, but is not required to, provide tooling for running tests.
- The Foundation may, but is not required to, define a required reporting format.
- Self-test results may be published by Vendors in advance of Foundation review, but must be clearly labeled as "Unofficial Results - Not Yet Accepted By The OpenStack Foundation".
- Vendors who publish self-tests MUST provide them in the same format that would be submitted to the OpenStack Foundation but MAY provide additional formats if they choose to do so.
- Self-test results cannot be used as proof of compliance.
C2. Vendor submits results to Foundation for review
- The Foundation determines the acceptable format for submissions.
- The Foundation has final authority to determine if Vendor meets criteria.
- The Foundation will provide a review of the results within 30 days.
C3. Vendor Grievance Process
- Vendors may raise concerns with specific tests to the DefCore committee.
- The DefCore committee may choose to remove tests from a Guideline (known as flagging).
- The DefCore committee will acknowledge vendor requests to flag tests within 30 days.
- Vendors may not request flagging all tests in a capability.
C4. Results of Vendor Self-Tests will be open
- The Foundation will make the final results of approved vendors available to the community.
- The Foundation will not publish incomplete or unapproved results.
- Only "pass" results will be reported. Skipped and failed results will be omitted from the reports.
- Reports will include individual test results, not just capability scoring.
C5. API Usage Data Report
- The Foundation will provide DefCore committee with an open report about API usage based on self-tests.
- To the extent the data is available, capabilities beyond the DefCore list will be included in the report.
Guideline Approval (D)
D1. Board will review and approve DefCore Guideline from draft
- Guidelines are set at the Platform, Component and Capability level only.
- The DefCore Committee will submit the human-readable summary of capabilities (see section A2) to the Board for approval.
- By voting to approve the summary, the Board delegates responsibility for maintaining test groupings to the DefCore committee subject to the limitations described in section D2.
- Guidelines only apply to the identified releases (a.k.a. release tags).
D2. DefCore Committee has authority on test categorization
- DefCore Committee can add flagged tests before and after Guideline approval.
- DefCore Committee cannot add additional Tests to Capability mappings after approval.
- DefCore Committee maintains the test to capability mappings in the JSON representation.
D3. Designated sections only enforced for projects with required capabilities
- Designated sections may be defined for any project.
- Designated sections apply to the releases (a.k.a. release tags) identified in the Guideline.
- Designated sections will be included in the JSON Capabilities file to ensure a single source of identification.
D4. Guidelines are named based on the date of Board approval
- Naming pattern will be: 4-digit year, dot (period), and 2-digit month.