Versions Compared

Old Version 47

changes.mady.by.user Benjamin Cheung

Saved on

compared with

New Version 48

changes.mady.by.user Benjamin Cheung

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • M3 API FREEZE

    • USE CASE / REQUIREMENTS PROJECT TEAMS -
      • API FREEZE - M3 is characterized by the API freeze. The main thing that happens at M3, is that the API is frozen by the Use Case / Requirements Teams.
      • DATA MODEL FREEZE - Developers are working to review & finalize the data model in order to develop the API.
        • Info Model - The Modeling S/C is develops 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 provide assistance and assess if info-model impacts.
        • 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.
        • EVALUATE 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 DATA MODEL - 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.
        • FINAL CALL FOR COMMENTS & INITIATE POLLING - START: Data Model in Discussion State > verb Approving/Poll > END: Data Model in Discussion state
          • (a) FINAL DATA MODEL - 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 project team.
          • (b) FINAL CALL FOR COMMENTS - After that, a final call for comments is issued by a use case lead 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.
      • RECONCILE DATA & INFO MODEL - Reconciling the info-model with the data-model. If there are impacts to the information model, it should be captured.
      • SWAGGER - Publish Swagger, Edge Rules.

      • MAINTENANCE RELEASE -

      • INSIGHTS STATISTICS PAGE - https://lfanalytics.io/projects/lfn%2Fonap/dashboard


      • TASKTASK TOPICDESCRIPTION
        1Update API documentation
        2

        Verify that merge requests are code reviewed


        3

        Update the OOM Port list


        4

        Data models are shared with the Modeling subcommittee


        5

        Complete the Architecture Sub-committee Review

        		Go to the Architecture subcommittee and present at the meeting and hold a component review.
        6Integration Blocker
        7Review License Scan Issues
        8Update documented Risks.Update the Project Status Page. Release milestone exceptions. Submit and exception Request.
        9Resolve all high priority bugs in JiraAny high priority bug left by M3 should be resolved if possible. Release notes will be updated with open issues if not completed.


      • Example of A&AI tasks at M3:
    • MODELING S/C ENGAGEMENT at M3-
      • 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.
      • REFINEMENTS TO THE RELEASE INFO MODEL - The Release Information Model is clean (base-lined) at M3. Though, updates can still happen to the release information model and the contributions. Certain elements within the model(s) could go to back to an experimental state. Only certain elements (e.g. attributes, ranges) are likely to go to the experimental state NOT the entire contribution. New additions could be added to a contribution model. 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.  
    • ARCHITECTURE ENGAGEMENT -
      • API FREEZE & ARCHITECTURE - API updates can impact that Component Architecture. That is architecture related to the ONAP components (A&AI, SO, SDC etc). Impacts to the API also affect the architecture landing page portal, and the architecture component descriptions. This is where the architecture team captures links to the API descriptions and documentation. Impacts to the API should have been identified during the architecture sub-committee review at M0.
    • COMPONENT  (PTL) ENGAGEMENT -
      • API FREEZE & COMPONENT IMPACT - The API freeze most directly affects the ONAP components (A&AI, SO, SDC etc). As the project teams working use cases & requirements will directly impact the software used by micro-services or platform components. Software changes are tracked in Jira, and should be coordinated with the PTL platform component technical leads.

#@#


  • M4 CODE FREEZE

    • USE CASE / REQUIREMENTS PROJECT TEAMS -

    • CODE FREEZE - The Use Case Teams are delivering the Software for the release. Requirements and use case teams are working to complete their software defined in their jiras and wiki pages. These will include the following tasks listed here.

    • COMPONENT S/W DELIVERY - S/W drops should be coordinated with PTL (components). Sync up with each component and PTLs should be done. Each component that is impact should have already been tracked in M0 and M1. Each of the component S/W impacts should be tracked by Jira tickets. Historically, it is the case that sometimes certain functionality of a component may not be able to be delivered. In this case, an assessment should be made if this will impact other platform components or other aspects of the use case.
    • JIRA TICKETS - Jira tickets should be updated with S/W delivery status. Delayed or Jira tickets that cannot be completed need to be communicated to the ONAP project release manager. Jira tickets that are tracking the overall project, the REQ-tickets need to be updated if there have been changes in content or status.
    • DEFERRED - Deferred elements that could not be delivered in the release should be noted. These can now be scheduled for the next release as generally by M4, the next ONAP release content is already starting to be considered and early planning is occurring.
    • INTEGRATION WORK - Integration work and test-cases should be worked. The integration teams need to be aware of any delays in software component delivery. If there are things can cannot make it into the current release test cases need to be updated.
    • API UPDATES - Swagger updates and API updates should be made if necessary. The API delivery was in M3 however, some things may change going into or during M4 which may cause API updates.

    • JIRA S/W BUGS COMMUNICATED - Tracking new software bugs with Jira tickets as necessary. As new software issues are encountered, they need to be communicated to the release.

    • RELEASE MANAGEMENT REPORTING - During M4, status of the projects are tracked for evaluation and software delivery. Potential delays needs to be communicated to ONAP project management. The TSC will consider and assess the status or each requirement/use case and the health of the release based on the Jira tickets. Any deferrals should be noted with the project management.
    • TSC REPORTING - The TSC is tracking delivery and health of the release at M4
    • MARKETING RELEASE - The marketing report of overall ONAP is being drafted at this point.

    • DOCUMENT GENERATION - Read the docs updates should be made for the Use Case. The read the docs can be found here: https://onap.readthedocs.io/en/latest/index.html

      tASK

    • The following shows some of the key tasks to be completed at M4 by a PTL.

      TASKTASKitem

      		review License Scan Issues

      Refer to most recent license scan, to determine is license scan are issues and resolve license scan issues.

      If your project issues open source software, it may have licensing issues. For example if open source or proprietary software


      		Merge Requests

      		Address all security Issues

      Security Violation page. Some are common vulnerabilities across all of ONAP.

      Depending on libraries used.


      		FOSS Wiki -

      Maven command to show dependency tree and uploaded. 

      Project FOSS


      		High Priority Jira IssuesHigh Priority Jira Issues and document any remaining open issues.

      		Release Platform Maturity & CII

      Platform Maturity Requirements (S3P).

      Performance stability resilience security Scalability manageability scalablity

      Project Maturity Review for AAI

      CII Badging Scorecard.

      The Analytics (what used to be Bitergia) is used to show the different commits, different project committing, and showing that it is an active projects and the span of committers across different companies. To find outliers, and project not being supported to evaluate for maturity review.

      https://lfanalytics.io/projects/lfn%2Fonap/dashboard


      		Test Coverage

      Verify test coverage goals have been met

      This is done in Sonar Cloud. Sonar cloud shows lines of code that are test are not covered.

      J-Unit tests are cross-indexed against the software and statistics are compiled for each component in Sonar Cloud.

      Overall Line coverage. meaning that the tests cover >50% of the code.

      An example: components:

      https://sonarcloud.io/organizations/onap/projects

      Quality profiles are generated. Bugs, Vulnerabilities; Code Smells, Security hotspots; and Active rules are applied

      and identify code duplication. Suggested Bug fixes.


      		Undocumented Risk

      		Integration Weatherboard

      Integration Weatherboard

      0: Integration Weather Board for Frankfurt Release


      		Update the INFO Yaml

      Review and uupdate the INFO. yaml

      Info about project, life cycle state. Comiters.

      Project meta-data. Stating committers, PTLs etc.

      through Oracle VM VirtualBox

      Keep track of project changers.

      , , , , ,

      Each Micro-service of the project has a INFO.yaml

      Apply for project status:


    • MODELING S/C ENGAGEMENT at M4 -

      • f

    • ARCHITECTURE ENGAGEMENT -

      • S-P - B-

    • COMPONENT (PTL) ENGAGEMENT -

      • D-T - D-p.PLATFORM INFORMATION UPDATES FROM SWAGGER UPDATES - Any API changes from Use Cases should also be communicated to the modeling team.
      • DOCUMENT GENERATION-  The model editor provides a final gendoc word document which serves as the basis for what will be incorporated into the Readthedocs.  Model updates from use case teams can be contributed to that subcommittee.
      • NEXT RELEASE - The Use Case teams can feed input into the next release. The High level modeling requirements page for the next releases are usually being worked near the end of a release. For example, in R7 Guilin release, the R8 Honolulu high level model requirements were open: ONAP R8 Modeling High Level Requirements

    • ARCHITECTURE ENGAGEMENT -

      • Architecture Sync - Any API or Platform component architecture impacts coming from M4 development should be communicated to the architecture sub-committee and updates to the platform component diagrams should be made.

    • COMPONENT (PTL) ENGAGEMENT -

      • Component Deliveries - Platform component deliveries are being made by each of the Use Case Teams. Impacts to components and things might be descoped should be considered. Each of the component teams are working to deliver code by M4.

#@#

  • RC0/RC1/RC2 RUN-TIME COMPLIANCE

    • USE CASE / REQUIREMENTS PROJECT TEAMS -
    • MODELING S/C ENGAGEMENT at M4 -
      • f
    • ARCHITECTURE ENGAGEMENT -
      • S-P - B-
    • COMPONENT (PTL) ENGAGEMENT -
      • D-T - D-p.

...