1. Problem Statement
Do we need to add another state “Maintenance” as part Project Component Lifecycle (Maintenance)?
What is the difference between the "Archived" state and the "Maintenance" state?
2. Definitions
ONAP Core Component (MVP-Minimum Vital Product): An ONAP component is identified as ONAP Core Component if this component is impacting the ONAP deployment and/or Onboarding, Instantiation, Run-Time, etc. for a particular ONAP release
Common Components: DMaaP (or MSB);
Service Delivery
- SDC or easy Onboarding SDK
- MSO
- AAI
- CCSDK/SDN-C
Service Assurance
- VES Collector + DCAE plug-in/mS
- Policy
Component Dependency Matrix (in progress); Flow matrix
Maintenance:
- Project(s) or sub-project(s) is no more part of any official release, but some parts might still be consumed indirectly by other project teams or some functionalities are still needed but no alternative has been implemented yet.
- These Project(s) or sub-project(s) are no more subject to non-functional compliances. The level of support will be dependent on the ONAP Community willingness to contribute, fast response time is not guaranteed.
- The project will be still part of OOM deployment and High Priority bugs might be fixed to unblock the current and/or maintained releases.
Archived:
- Project can reach "Archived" state for multiple reasons. Either project has successfully been completed and its artifacts provide business values, or project has been cancelled for unforeseen reasons (no value anymore, technical, etc.).
- Project in any state can be "Archived" through a Termination Review.
3. Transition Steps
Transition from “Incubation/Mature/Core” to "Maintenance"
A "Incubation/Mature or Core" project can be moved to “Maintenance” if Project(s) or sub-project(s) is no more part of any official release, but some parts might still be consumed indirectly by other project teams or some functionalities are still needed but no alternative has been implemented yet. The following steps will be performed:
#1 Final call to the ONAP Community raised by the PTL or by the TSC.
#2 Review what is used by the Community and the dependencies to other components and maintain the repositories that are necessary for the ONAP Components
#3 Identify potential remaining committers to maintain the remaining repositories
#4 Verify what (if any) impact the change has on OOM/Integration (CIST)/DOC projects and ensure that is communicated
#5 Update INFO.yaml
#6 In gerrit set the appropriate repositories that are no longer in use to 'Read Only' access
#7 Update the Architecture diagrams and references
#8 Remove Jenkins jobs
#9 Inform Steven Winslow (LFN IP Legal) and disable all the scans (Sonar, FOSSology, NexusIQ) on the unmaintained repos
#10 Identify an alternative path (if any)
#11 Move the project to Maintenance State Projects including Clean-up of other wiki pages, RDT, JIRA, mailing lists, calendars, etc.
#12 Indicate in the release note that the project is in maintenance state i.e. add a hint in the header.
#13 The project information for this component will no more be branched (i.e. master) and will be linked to the latest maintained release.
#14 Any critical, severe or high vulnerability found in the code written by the project team MUST be fixed within 60 days or prior to the inclusion of the project in a new release, whichever occurs first.
Transition from "Maintenance" to "Incubation/Mature": A maintenance project can be moved to “Incubation” or “Mature" if there is a new interest from the ONAP Community and meeting the requirement for the project state while performing a project review, including PTL responsibility and committers engagement. The following steps will be re-initiatied
#0 Communication to the ONAP Community the transition change
#1 Remove the 'Read Only' access on the repositories used by the component
#2 Verify what (if any) impact the transition has on OOM/Integration (CIST)/DOC projects and ensure that is communicated
#3 Update INFO.yaml including PTLs, Committers, etc.
#4 Update the Architecture diagrams and references
#5 Re-Activate Jenkins Jobs
#6 Inform Steven Winslow (LFN IP Legal) and enable all the scans (Sonar, FOSSology, NexusIQ) on the project repositories
#7 Create and/update wiki pages, RDT, JIRA, mailing lists, calendars, etc.
# 8 Remove the hint in the header in the release note
#9 The project information for this component will be branched to the current ongoing release and links in RDT will be updated accordingly
Transition from "Maintenance" to "Archived": A maintenance project can be moved to “Archived" if the project is no more critical for the ONAP Platform (Deployment, Onboarding, Instantiation, Run-Time) or has any dependency to any ONAP component.
The following "Termination" steps will be performed:
#1 Ensure that there is
1.1 No more dependency from the 'retired' project candidate to any component
or 1.2 An alternative architecture is identified to replace the 'retired' project candidate by the Architecture Subcommittee or by a dedicated TSC Task Force
PTL to review and to have an integration plan proposal
PTL integration plan to be part of the ONAP roadmap
#2 Update the Architecture diagrams and references
#3 TSC to inform the ONAP Community that the project will no more be maintained and Termination process will be kicked off, promoting the alternative (if any)
#4 (super-committer or LF RelEng) Update INFO.yaml to reflect the state of the project
#5 Verify what (if any) remaining impact the change has on OOM/Integration (CIST)/DOC projects and ensure that is communicated
#6 In gerrit set the remaining repositories to 'Read Only' access
#7 Remove the remaining Jenkins jobs (if any)
#8 Inform Steven Winslow (LFN IP Legal) and disable all the remaining scans (Sonar, FOSSology, NexusIQ) on the remaining repos (if any)
#9 Move project to Project State: Archived including Clean-up of other wiki pages, RDT, JIRA.
#10 Indicate in the release note that the project is in 'Achieved" state i.e. update the hint in the header.
4. Projects currently under Maintenance:
- AAF, APPC, AAI/ESR, MUSIC (OOF has a dependency on it), Logging incl. Pomba
- Repositiories currently in 'Read Only access': DCAE-D SDC plugin, AAI/Sparky, OOF/FGPS, DCAE/PNDA and
- sdc/dcae-d/ci
- sdc/dcae-d/dt
- sdc/dcae-d/dt-be-main
- sdc/dcae-d/dt-be-property
- sdc/dcae-d/fe
- sdc/dcae-d/rule-engine
- sdc/dcae-d/tosca-lab
gerrit query to identify all the repositories that have been set to "Read only" - GET https://gerrit.onap.org/r/projects/?state=READ_ONLY
The result will be captured in a *.json file
5. Example of Transition from “Incubation/Mature/Core” to "Maintenance"
What has been done i.e. Logging incl. Pomba
#1 Final call to the ONAP Community raised by the PTL or by the TSC.
#2 Review what is used by the Community and the dependencies to other components
Maintain the repositories that are necessary for the ONAP Components:
https://gerrit.onap.org/r/gitweb?p=logging-analytics.git;a=tree;f=pylog;hb=HEAD
#3 Identify potential remaining committers to maintain the remaining repositories: 2 committers for Java Libraries and 1 Committer for Python library
#4 In gerrit set the appropriate repositories that are no longer in use to 'Read Only' access
#5 Verify what (if any) impact the change has on OOM/Integration (CIST)/DOC projects and ensure that is communicated
#6 Update the INFO.yamls for all of the repos
#7 Update the Architecture diagrams and references
#8 moved to the Maintenance State Projects
Next steps:
#8 Remove Jenkins jobs
#9 Inform Steven Winslow and disable all the scans (Sonar, FOSSology, NexusIQ) on the unmaintained logging repos
#10 Identify an alternative path i.e. SDTOUT (REQ-374) for log collection
#11 Move Logging to Project State: Archived following the Termination Review process (incl. Clean-up of other wiki pages, RDT, JIRA, mailing lists, calendars, etc.)
#12 Indicate in the release note that the project is in maintenance i.e. add a hint in the header.
#13 The project information for this component will no more be branched (i.e. master) and will be linked to the latest maintained release.
#14 Any critical, severe or high vulnerability found in the code written by the project team MUST be fixed within 60 days or prior to the inclusion of the project in a new release, whichever occurs first.
6. Additional link(s)/reference(s)
- Diagram for newly proposed lifecycle
- ONAP Project Lifecycle & Review (prior to this maintenance proposal)
7. Remaining action Items
- (SECCOM) Finalize the component dependency Matrix - Flow matrix
- (Architecture Subcommittee) Define ONAP MVP components
- (Task Force): Present to the PTLs (1/25) then to the TSC (1/28) to update Technical Community Document accordingly and vote.
8. Closed action items
- Kenny Paul : <follow up with Jessica Gonzalez to see if there is a query to identify all the repositories that have been set to "Read only"
- Kenny Paul INFO.yaml becomes the true source - plan to deprecate the following wiki page - Resources and Repositories
- (Chaker/Jason) Add Project State Maintenance to the Project Lifecycle deck