Approved ONAP Model Governance

As approved on the November 6th modeling subcommittee meeting, following is the approved process for governing the ONAP information and data models.

Objective:  To establish a ‘reasonably light’, efficient, well communicated, repeatable and traceable model approval process.

Current Model States

INPUT – This is optional as not all modeling groups implement this. It is where one puts ideas (a contribution) they might have, and should ONLY contain pages that have NOT been discussed.
The contributor also must provide use-cases, requirements, or relevant material articulating why the model change is required.
DISCUSSION – This is mandatory. Note that to be a discussion wiki page, the contribution / page must have first been in “INPUT” (assuming the INPUT state was used). These are pages (contributions) that get reviewed in weekly meetings.  If the contribution did not originate in the Input State, the contributor also must provide use-cases, requirements or relevant material articulating why the model change is required.

• A model lead MUST also “call for an official review” of the page (contribution) via an email to: onap-modelingsub@lists.onap.org.
• Reviews & Comments
  • Comments should be captured directly on the wiki page either at the bottom or preferably “in line”.   
  • Responses must be made to EACH comment with heading: 
    • <AGREE> agree with the comment and provide description of action,
    • <DISCUSS> no action will be taken until discussed by the team,
    • <INFORMATION> additional information provided,
    • <DEFER>  no action until some later time.
  • Note: review decisions are captured on the wiki, NOT in meeting minutes, emails, or other means.

CLEAN – Only officially reviewed and approved (by subteam and modeling team) pages (contributions) are put here. For conditions for transitioning to CLEAN, see State Transitions below. Note: previous release versions of CLEAN are NOT automatically put into CLEAN for the next release. They must undergo the same process and start out in DISCUSSION.

State Transitions

INPUT => DISCUSSION

• A page (contribution)  stays in INPUT until it is discussed and transitions to DISCUSSION
• The transition to discussion implies the page must be MOVED into the discussion wiki

DISCUSSION=> CLEAN

• Being in the discussion phase implies the page (contribution) has undergone the review process (possibly multiple times).
• In order to transition to clean, the following occurs
  • At the sub-team level
    • The sub-team lead must assure there is general consensus within the Subteam before asking for asking for subcommittee approval.  General consensus includes:
      • All WIKI comments addressed (nothing left in discussion).
      • Call for Subteam agreement made in meeting and within sub-team WIKI meeting minutes.
  • Once the discussion comments have all been addressed and resolved, the sub-team lead does a “call for approval” of the wiki discussion page to onap-modelingsub@lists.onap.org. providing a 2-week time period for approval of the page. People respond “Approved” or “Not Approved”
  • The Model Chair counts the votes at the end of 2 weeks and publishes the results to the same mailing list.  Approval requires 2/3 of those voting approving the contribution
  • If approved, the DISCUSSION wiki goes to CLEAN. If not approved, there is no transition
• The CLEAN pages must clearly state in an introduction what changes occurred to a model between one release to the next.

Wiki Comment Examples & Handling