Page History

...

• M3 (API Freeze)
  

  • M3 MODELING SUBCOMMITTEE ACTIVITIES-
    • REFINEMENTS TO THE RELEASE INFO MODEL - The Release Information Model is clean at M3. It is considered "base-lined" and "final", hence it is marked clean. Though, updates can still happen to the release information model and the model contributions therein. This means that certain elements within the model(s) could go to back to an experimental state. Note that only certain elements (e.g. attributes, ranges) are likely to go to the experimental state NOT the entire contribution. More often though, new additions could be added to a contribution model. In general, there would likely be just minor tweaks on the model. So when a contribution is clean it has to be at least preliminary. A contribution cannot be clean and experimental. Clean has a relationship to the IISOMI states. For an entity to be clean it must be either preliminary or mature (see the IISOMI state diagram link).
      
      • IISOMI STATES - A link to the IISOMI state diagram can be found here: Stereotypes 
      • NEW ADDITIONS - A contribution model could be clean, but things added afterwards and those elements would come in as experimental. 
    • STILL IN PROGRESS ITEMS IN RELEASE INFO MODEL - It is possible that as the modeling team enters the M3 milestone that there are still some things in progress, that are expected to be in the current release. They might still be marked experimental even though the release information model is clean. Thus, to open item are continue to be work; and it is expected it would not affect software if code were already associated to it.
      
      • ITEMS IN DISCUSSION - e.g. when root contribution was done, with root party is an example as it was not agreed to, we made the decision to leave that experimental until a future date. There were aspects agreed, and other things left experimental to pursue in the future. The main contribution was split. These parts everyone agreed with and these part left experimental which would be taken up in a future contribution and re-discussed. This would likely occur at M2, and they might be discussed at M3. There was a conscious decision and agreement by the modeling team that the parts of the model still open would be pushed to the next release. So only theoretical discussion would happen at this point of how to proceed in the future release.
      • FUTURE WORK - Things originally planned to be in a release could potentially transform into future work items. Some modeling work could be pushed to the next release if need be, if it is decided that it could not be completed in the current release.
    • FUTURE WORK- Future work is typically identified as such at the start of a release at M0 in the release modeling planning page. Future Work can still proceed. For example, in R6 the geo-location modeling work is not tied to any active development yet. The location work is a good example of work that was worked in ADVANCE of when it is expected to be used (Future Work). It is also possible that some of the future work is building upon a foundation of work that had already been started (or was looked at) or implemented in a prior release.
      
      • DEFER WORK - It might be decided the the future work could be deferred to the next release. On the current modeling high level requirements page to indicate that a particular future work has been deferred to a future release. In order not to lose the activity, it would be expected that it would be rolled into the next release's Modeling High-Level Requirements.
      • CONTINUE WORK - Future Model work may continue to proceed in the current release..
    • DOCUMENTATION AFTER IMPLEMENTATION IN PRIOR RELEASE WORK- This type of work is the model is catching up to already implemented software. It has already been identified as something that would be worked on for that release at M0. It is expected that it wouldn't immediately impact the current software. However, it may be extended eventually to incorporate new work. The way to proceed with this category of work is handled the same way as the future work (i.e. Defer or to Continue the work) given modeling improvement recommendations on how better to model a given concept.
    • M3 CHECKLIST - The M3 check list modeling updates discussion is used by the modeling sub-committee. It is used as a vehicle to engage the Use Case (project teams) and reconcile the Use Case Teams with the modeling S/C team's work. See also the Use Case Team Engagement (section below). The Check list can be found here: Proposed M3 Checklist modeling updates discussion
  • Architecture Engagement - By M3, the architecture team has base-lined the release Functional Architecture. There may still be some component architecture and Architecture proposed enhancements in progress
    
    • SYNC - Work underway still by the modeling sub-committee, such as refinements to the release information model, items still in progress, future work, and work documented after implement should be communicated to the architecture sub-committee in a sync-up before M3. The modeling sub-committee lead should reach out to the Architecture PTL either for a quick sync, a separate 1-off presentations, or reserved slots on either of the two regular weekly team calls.
  • Use Case Teams Engagement -
    • API Freeze - M3 is characterized by the API freeze. The main thing that happens at M3, the API is frozen by the Use Case Teams.
    • Data Model Freeze - Developers identify a problem in the data model which affects the information model.
      • SYNC UP - Since the Modeling S/C is familiar with the info-model; the Use Case Teams should present at the Modeling S/C their proposed data model that might be frozen so that the modeling S/C can assess it to see if might have impact to the Info-model. There should be some collaboration or check-point at M3 to discuss and potential ripple affects back to the information model.
      • DATA MODEL IMPACTING INFO MODEL - If changes in the Data Model impact the information model, those changes need to be worked by the model S/C. The Modeling S/C would evaluate the change to the Information model and possibly make updates.
      • USE CASE TEAMS INDICATE CHANGE - The Use Case teams may have enough knowledge of the info-model that they identify a data model change that may impact the information model. This presumes that the use case teams know that their changes in a data model may have impact to the information model.
      • CONSIDER DATA MODEL - START: Input Data Model > verb Consider > END: Data Model in Discussion State
        • The data model is a model that is used in a Use Case and is based on the Information Model. It is generally a self-contained model which depicts a particular capability or function of the system. The data model starts as a "input data model" and undergoes consideration by the Use Case teams. Consideration means that the Use Case teams is entertains & assesses if the input data model. If the Use Case teams think that the contribution is not ready for the current release that contribution it might postponed. It would be noted in the Release Management Project page as such.
      • REVIEW & REFINE CONTRIBUTION - START: Data Model in Discussion State > verb Reviewing & Refine > END: Data Model in Discussion state
        • The data model undergoes reviewing & refining during the discussion state. Reviewing & refining means that the Use Case Teams are discussing the data model and updating their data model based on feedback and comments from the Use Case team and modeling team. Each data model can be reviewed and refined independently and concurrently with other use case projects. Things in the discussion state are classes, attributes and relationships are tagged as IISOMI experimental.
        • ENGAGE the Modeling Sub-Committee - The modeling sub-committee should be engaged during the review and refinement stage. Ideas should be solicited to see if the data model is in-line with the release information model
      • MODELING S/C ENGAGEMENT - The Use Case teams may wish to solicit the opinion of the modeling S/C and present their data model for discussion and socialization.
      • FINAL CALL FOR COMMENTS & INITIATE POLLING - START: Data Model in Discussion State > verb Approving/Poll > END: Data Model in Discussion state
        • (a) FINAL PRESENTATION - When the data model has gotten to a point where the use case team feels that it can start to undergo the approval process, the data model is brought one final time the use case team.
        • (b) FINAL CALL FOR COMMENTS - After that, a final call for comments is issued by a use case lead to the modeling team whereby final thoughts & input can be given. This final call for comments signals that the discussion is wrapping up for this contribution and will soon go to a poll.
        • (c) INITIATING POLL - After final call and no further outstanding comments exist, the contribution is brought to a poll by a use case lead. A poll is created whereby use case team members can give the contribution a vote of "yes" or "no". 
      • APPROVING CONTRIBUTION - START: Data model is in Discussion State Post-Poll > verb Approving > Data model in Clean State
        • After the poll has concluded, the data model has finished the approval process. The data model is now considered to be in the clean state. The items that are in the IISOMI experimental state get promoted to a preliminary state. A gendoc is generated and put on the wiki page. The gendoc would be translated and published on the readthedocs site.
    • Use Case Data Model Final - After each of the Use Case teams have reached a clean (approved) state, the use case teams can proceed to API freeze.
    • RECONCILE Info Model & Data Model - Any inconsistencies identified by the modeling sub-committee should be reconciled with the data model. The info-model with the data-model after clean state should be congruent. M3 checklist. (API Freeze)
    • M3 CHECKLIST - The M3 check list is used during the M3 milestone by the Use Case team. This is a vehicle to engage the Use Case and reconcile the Use Case Teams with the modeling S/C team's work. The Check list can be found here: Proposed M3 Checklist modeling updates discussion
  • ONAP Platform Components & PTL Engagement - Platform components (A&AI, DCAE, SO, SDN-C etc) are finalizing the APIs in various components hand-in-hand with the Use Case teams (which are either co-developing these APIs or using them directly).
    
    • The ONAP Platform Components provide the functionality that is used by the Use Case Teams and require commensurate changes to support the API and Data Model needs of each of the Use Case Teams.
    • A checklist for the platform components (AAI, DCAE, SO, SDN-C) should be used: Proposed M3 Checklist modeling updates discussion
    • Information Exchanges - Verify that the information exchanges of the Platform component is satisfied
    • Data Model - Verify that the data model for Shared Information from the Component-side is completed.
    • Mapping - Verify that the data elements in platform component data models have been mapped to ONAP common information model
    • Review - Review Data Models & Use case artifacts with the modeling sub-committee
    • Tracking - Verify that issues arising from data/information model review are tracked.

• M4 (Code Freeze)

  • M4 MODELING SUBCOMMITTEE ACTIVITIES-
    • PLATFORM INFORMATION UPDATES FROM SWAGGER UPDATES - The modeling subcommittee would update the platform information model possibly due to updates in the ONAP platform swagger files. It is anticipated that no new API changes would occur at M4, but rather description updates which would then subsequently affect the corresponding platform information model.
    • DOCUMENT GENERATION- 

  • Code Freeze

  • Kickoff Information Model Requirements for Next Release

  • READ THE DOCS - (M3 or M4?)
    • The model editor provides a final gendoc word document which serves as the basis for what will be incorporated into the readthedocs.
    The read the docs can be found here: https://onap.readthedocs.io/en/latest/index.html . The word
    •   The word document is fed into
    some
    • tools which
    generates
    • generate the readthedocs output (RST file). The tool to generate the readthedocs is pandoc. This is done by the model area lead. The gerrit master model is periodically updated, and a snapshot of the eclipse/papryus model is taken and that is called the release model.
  • DOCUMENT GENERATION - The RST documentation that only contains things in the current release or everything that is approved.
  • PAPYRUS GENERATION -
    • A link to the read the docs can be found here: x. A tutorial for the process can be found here: RST Document Generation Tutorial After each approval, the model editor will update the latest gendoc. The Papyrus snapshot is generated.
    The RST document is created. The readthedocs documentation is generated.
    •  Note: that the papyrus model includes what was/had accepted into the previous release and also anything that is still a work in progress.
    • NEXT RELEASE - The M0 for the next release is generally synchronized with the sign-off of the previous release. So, the modeling sub-committee is  assessing new model requirements for new requirements or use cases in the next release during this time. See above for the M0 process related to model proposals process
    Note that the papyrus model includes what was/had accepted into the previous release and also anything that is still a work in progress
    • .
  • Architecture Engagement -
    • S-P - B-
  • Use Case Engagement -
    • D-T - D-p.
    • Code Freeze - Possible updates to Swagger files, additional updates. For example descriptions, licensing information without impact to API.
  • Platform Components (PTL) Engagement -
    • Code Freeze - Possible updates to Swagger files, additional updates. For example descriptions, licensing information without impact to API.

• RCx

  • Runtime Compliance

• Observations

  • Establishes and Evolves a Common Model

  • Project (Component) Team Involvement in Modeling Solution

  • Governance of Common Model and Corresponding Component Models

  • Update possible in M3 and M4 (bug fixes) per exception process

...