OpenStack Interop Working Group Process 2021A
Approved #June 29, 2021 OIF board meeting
This document describes the Interop Working Group's working process as required by the OpenStack bylaws (see https://www.openstack.org/legal/bylaws-of-the-openstack-foundation/) and approved by the OpenStack Technical Committee and Open Infrastructure Foundation Board.
Expected Time line
|Time Frame||Activities||Lead By|
|-1 month||Draft of next guidelines.||Interop WG|
|PTG||Review next guidelines||Community|
|PTG||Review status||Interop WG|
|+1 month||Update draft of guidelines||Interop WG|
|+2 months||Testing draft guidelines||Refstack, Vendors|
|+3 months||Approve Guidance||approval_committee|
Note: Time line is aligned with releases schedules. See https://releases.openstack.org/xena/schedule.html as example of Xena schedule. Draft is done during the release for which guideline is being developed, while its completion is done during next release schedule. The Interop Working Group may accelerate the process to correct errors and omissions.
The Guideline process has four primary phases: Draft, Review, Validation and Approval. - During the Draft phase (A), the Interop Working Group creates new draft of guideline with input from the community with updated coverage, scores of the components, and other details. - During the Review phase (B), guidelines for each project are reviewed during the PTG with that project, input from refstack community, and general feedback from the community and vendors. - During the Validation phase (C) Guidelines go through and implementation and testing cycle. - Finally, Approval by approval_committee
The Open Infrastructure Board of Directors is not involved in the guideline process and review, and approve only changes to the Interop WG process.
This section provides specific rules and structure for each phase.
Guidelines Draft Phase (A)
A1. New Guidelines Start From Previous Guidelines
- New Guidelines start from the previously approved Guidelines document.
- New Guidelines are given the preliminary name of "next.json".
- For each of the new Guidelines add-on component there is a separate "next.json" document.
A2. Community Groups Tests for Capabilities
- The Interop Working Group coordinates community activities with the Technical Leadership to revise the capabilities based on current technical needs and functionality.
- Capabilities must be a subset of the OpenStack Technical Committee Approved Release as determined by the Board of Directors (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 Interop Working Group will provide the test groupings in JSON format for scoring.
- The Interop Working Group optionally will provide a human-readable summary of the Guideline generated from the JSON version.
A3. Interop Working Group 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 a subset of the OpenStack Technical Committee Approved Release as determined by the Board of Directors (see bylaws of the Foundation, section 4.1(b)(iii)).
- TC & PTLs may, but is not required to, assist the Interop Working Group with defining advisory Designated Sections for projects that have advisory or required Capabilities.
- Designated Sections may be sufficiently defined for Guidelines using general descriptions.
- The Interop Working Group will present A3.4 descriptions to approval_committee for approval.
- TC & PTLs 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. Interop Working Group identifies required capabilities
- The Interop Working Group uses Board approved scoring criteria scoring criteria to evaluate Capabilities.
- The Interop Working Group needs Board approval to change scoring criteria.
- Scoring criteria factors or weights cannot change after Draft is published.
- The Interop Working Group identifies a 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.
- For the "widely deployed" adoption criteria, the size of the pool being considered will match the scope of the community being considered. Capabilities will be evaluated based on their use in their Component. Components will be evaluated based on their use in the Platform.
A5. The Interop Working Group recommends OpenStack Components and OpenStack Platform Scope
- The Interop Working Group recommends Capabilities to include in each OpenStack Component.
- The Interop Working Group recommends which Components are required for the OpenStack Powered Platform.
- The Interop Working Group will apply the approved scoring criteria to evaluate if a component should be included in the Platform (see A4).
A6. Additional Capabilities and Tests
- The Interop Working Group will work with the OpenStack community to define new Capabilities.
- Test grouping for new Capabilities will be included in the Interop Working Group documents.
- The Interop Working Group will publish a list of missing Capabilities and Capabilities with inadequate test coverage.
- Interop Working Group in conjuction with TC and Foundation Marketplace product owner can propose additional Add-on component guidelines.
- Each Add-on is provided as a seperate additional guideline, that follows the same process as "OpenStack powered" ones as defined by this document.
A7. The Interop Working Group creates recommendation for Draft.
- The Interop Working Group coordinates activities to create the Guideline draft.
- The Interop Working Group 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
- May not be in Gerrit: Working materials (spreadsheets, etc)
B2. Presentation of Draft Guidelines for Review
- The Interop Working Group will distribute Draft Guidelines to the OpenStack community for review.
- A link to the Gerrit document must be provided with the review materials.
- The draft Guidelines will consist of single document for "OpenStack-Powered" Logo and separate document for each of the add-ons components.
B3. Changes to Guideline made by Gerrit Review Process
- Guidelines proposal and review must go through Gerrit.
- The Interop Working Group will proxy for users who do not participate in the Gerrit process with attribution.
B4. For Gerrit reviews, Interop Working Group Co-Chairs act as core reviewers.
- Interop Working Group Co-Chairs serve as "core" reviewers (+2).
- Requests for changes must be submitted as patches by the requesting party.
- Interop Working Group members may proxy change requests as long as the requesting party is explicitly acknowledged.
- All Interop Working Group Co-Chair will be elected by the Interop Working Group. Election quorum is composed of attendees present during the election meeting.
- Additional core reviewers (+2) can be appointed by Co-Chairs.
- Election meetings must be posted at least one meeting prior.
B5. Projects Interlocks
- For the PTG, the Interop Working Group requests a meeting with each project under the "OpenStack Powered" guideline and each of the add-on guidelines.
- Project meeting covers a review of the current guidelines for the projects, any changes/addition/deprecation/removal of APIs. Tests must be available in repositories under OpenStack TC governance. The tests cannot be in repositories outside of list in the openstack governance repository: https://opendev.org/openstack/governance/src/branch/master/reference/projects.yaml
- Project meeting covers any test result for specific drivers of that project to ensure consistent functionality coverage for all required and designated interoperability functionality of the project.
B6. Draft Guidelines update
- Following the PTG meeting the Interop Working Group updates draft Guidelines using feedback from each of the projects.
- Ensure any new or modified guidelines must have the corresponding test(s) in Tempest or Tempest plugins, and Refstack wrapper include it.
- For any new add-on program Refstack need to be able to collect submissions for marketplace.
- For any new add-on programs Foundation Marketplace product owner need to prepare ability to issue, record and administer new add-on Logo under Marketplace program.
Starting: S and continues until S+2
C0. RefStack validation
- Refstack makes necessary changes to Page
- Refstack makes necessary changes to handle new guidelines.
- Refstack representative share test results of new guidelines on default platform with Interop Working Group.
- Refstack flags any tests that do not pass on the default platform.
C1. Vendor Self-Tests
- Vendors are responsible for executing tests identified by the Interop Working Group.
- The Interop Working Group may, but is not required to, provide tooling for running tests through Refstack.
- The Interop Working Group may, but is not required to, define a required reporting format.
- Self-test results may be published by Vendors in advance of Open Infrastructure Foundation Marketplace manager review, but must be clearly labeled as "Unofficial Results - Not Yet Accepted By The Open Infrastructure Foundation".
- Vendors who publish self-tests MUST provide them in the same format that would be submitted to the Open Infrastructure 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 Open Infrastructure Foundation Marketplace manager determines the acceptable format for submissions.
- The Open Infrastructure Foundation Marketplace manager has final authority to determine if Vendor meets criteria.
- The Open Infrastructure Foundation Marketplace manager will provide a review of the results within 30 days.
- Vendors can submit results for "OpenStack Powered" Logo and any of the add-on programs together or separately.
- The Open Infrastructure Foundation Marketplace manager can provide review of the results for all vendor submissions together or separately for each Logo.
C3. Vendor Grievance Process
- Vendors may raise concerns with specific tests to the Interop Working Group.
- The Interop Working Group may choose to remove tests from a Guideline (known as flagging).
- The Interop Working Group will acknowledge vendor requests to flag tests within 30 days.
C4. Results of Vendor Self-Tests will be open
- The Open Infrastructure Foundation Marketplace manager will make the final results of approved vendors available to the community.
- The Open Infrastructure Foundation Marketplace manager 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.
- Vendors are required to submit a description of the system and configuration used to achieve the results.
C5. API Usage Data Report
- The Open Infrastructure Foundation Marketplace manager will provide the Interop Working Group with an open report about API usage based on self-tests based on Refstack submitted results.
- To the extent the data is available, Capabilities beyond the Interoperability Guideline list will be included in the report.
C6. Only Two Approved Guidelines at a time:
- Vendors seeking validation are limited to using the two latest approved Guidelines.
- Since past validations are respected, older Guidelines will be maintained as superseded for historical reference.
- Guideline status progresses as follows:
initial work, pre-PTG discussion material
as presented at the PTG (S) for community review
Committee approved, one of the two official guidelines
Committee approved, now superseded by two latest guidelines
Guideline Approval (D)
Starting: S+3 or earlier
D0. Approval Committee
- Approval Committee consists of representatives from 4 bodies
- Interop Working Group Co-chairs are approval authority of this committee.
- Refstack core member or repesentative(s) as advisory member
- Open Infrastructure Foundation Marketplace product owner as advisory member
- OpenStack TC representative(s) as advisory member
D1. Committee will review and approve Interoperability Guidelines from draft
- Interop Working Group must approve the proposed guidelines.
- Foundation staff member(s) and OpenStack TC member(s) vote in advisory capacity but do not have veto power.
- The approval is done through formal vote and its results recorded with the date of Approval.
- Upon approval guideline document is marked as approved with the date of approval.
- approval_committee members may request delay of the formal vote till foundation staff and/or Refstack is capable of handling new guidelines.
- Delay of the vote can be resolved by at most 1 month prior to next PTG meeting, which is the start of work on the new guidelines.
- Guidelines are set at the Platform, Component and Capability level only.
- The Interop Working Group will submit the summary of Capabilities (see section A2) to the Committee for approval. The human-readable format of the summary is encouraged but optional.
- By voting to approve the summary, the Committee delegates responsibility for maintaining test groupings to the Interop Working Group subject to the limitations described in section D2.
- Guidelines only apply to the identified releases (a.k.a. release tags).
- The Add-on Guidelines are set for OpenStack projects in addition to "OpenStack Powered" ones.
- All guidelines follow the same review and approval process irrespective if they are "OpenStack Powered" or "OpenStack Add-on" guidelines.
D2. Interop Working Group has authority on test categorization
- The Interop Working Group can add flagged tests before and after Guideline approval.
- The Interop Working Group cannot add additional Tests to Capability mappings after approval.
- The Interop Working Group 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.
E1. Process Draft
- Any process change follows the process of draft, review and approval.
- Any process changes are handled thru gerrit process.
- Proposed changes submitted to Gerrit for review by Interop Working Group as a draft document.
- Interop Working Group adds all Committee members for review of the draft.
- Once that draft is approved, Interop Working Group co-chairs present it to Open Infrastructure Board for approval.
- Once Board approved the changes the new process is marked as approved and is linked from Interop WG wiki page.