The content of this template is expected to be fill out for M1 Release Planning Milestone.
Info
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki.
Use the Wiki to document the release plan. Don't provide PowerPoint.
Use as much diagrams and flow charts as you need, directly in the wiki, to convey your message.
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Guilin |
| Project Lifecycle State | Incubation |
| Participating Companies | AT&T, Bell Canada, Fujitsu, Ericsson, IBM, Huawei, Nokia, Orange, Samsung, Tech Mahindra, Wipro |
Scope
What is this release trying to address?
The Guilin release contains a number of enhancements primarily centered around 5G use cases.
We also plan enhancements to the Service Logic Interpreter (SLI) - which currently runs within the OpenDaylight Karaf container - to allow it to run in a separate container, independent of OpenDaylight. This work was begun in the Frankfurt release and continues in Guilin. In Guilin, 2 new microservices will be developed that run outside OpenDaylight:
- sliboot - which runs the SLI-API interface
- generic-resource-api which runs the GENERIC-RESOURCE-API interface
The latter of these 2 is actually part of the SDNC project, but we include it here since we anticipate some associated CCSDK changes will be needed to support that work.
The Guilin release also includes a major release upgrade in OpenDaylight to the OpenDaylight Sodium release. This release is considered a "sea change" release - meaning it is a major, BREAKING release. Consequently, the CCSDK Giulin release numbering will roll to 1.0.x, reflecting that we cannot guarantee full backward compatibility with previous releases.
Requirements
The following table lists the new functional requirements CCSDK is committing to support for the Frankfurt Release:
| Requirements | Companies Supporting Requirement |
|---|---|
REQ-325 - Getting issue details... STATUS | Fujitsu |
REQ-345 - Getting issue details... STATUS | IBM |
REQ-342 - Getting issue details... STATUS | Huawei, IBM, Wipro |
REQ-347 - Getting issue details... STATUS | Huawei, CMCC, Wipro |
REQ-322 - Getting issue details... STATUS | IBM |
REQ-341 - Getting issue details... STATUS | T-Mobile, Orange |
REQ-352 - Getting issue details... STATUS | Ericsson, IBM |
Minimum Viable Product
The following epics represent the minimum viable product of the CCSDK Guilin Release:
The following epics are also in scope for Guilin, but are not considered of the minimum viable product. In the event of unanticipated resource constraints, these could be reduced in scope or deferred without impacting any functionality deemed by the TSC as critical for Guilin.
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
Epics
The following epics are committed for the CCSDK Guilin Release:
The following epics are also in scope for Guilin, but are not considered of the minimum viable product. In the event of unanticipated resource constraints, these could be reduced in scope or deferred without impacting any functionality deemed by the TSC as critical for Guilin.
Stories
Bugs
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
| Deliverable Name | Deliverable Description | Deliverable Location |
|---|---|---|
| CCSDK Source Code | Source code for CCSDK project | ONAP gerrit |
| CCSDK Maven Artifacts | Compiled code that can be referenced in other projects as maven dependencies | ONAP Nexus |
| CCSDK Docker Containers | Docker containers associated with SDNC project:
| ONAP Nexus |
| Documentation | User and developer guides | ONAP Wiki |
| CCSDK CI/CD automation | Scripts to automate compilation and deployment of maven artifacts and docker containers | ONAP gerrit ONAP Jenkins |
Sub-Components
Subcomponents of each ONAP project may be found on the Resources and Repositories page on this wiki. Please see the CCSDK section of that page for subcomponent list of CCSDK.
Architecture
High level architecture diagram
CCSDK is delivered as a set of libraries accessible as Maven dependencies, as well as a set of base Docker containers. The docker containers themselves are intended to be used by other projects as a basis for their own controller-specific docker containers.
The following diagram illustrates how CCSDK is used by the controller projects:
Platform Maturity
Please fill out the centralized wiki page: Guilin Release Platform Maturity
API Incoming Dependencies
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| A&AI : schemas | A&AI schemas used by CCSDK aaa-service module | Defined in seed code | Included in seed code | TBD |
| SDC : distribution client | API used by ueb-listener (in CCSDK sdnc-northbound repo) to receive artifacts from SDC | Defined in seed code | Included in seed code | TBD |
API Outgoing Dependencies
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| Maven libraries | Libraries used as dependencies by SDN-C, APP-C, DCAE and OOM | Included in seed code | Delivered in seed code | Javadoc will be provided |
| Docker containers | Base docker containers will be provided which can be used by SDN-C and APP-C as a basis for their docker containers | Included in seed code | Delivered in seed code |
Third Party Products Dependencies
| Name | Description | Version |
|---|---|---|
| OpenDaylight | OpenDaylight SDN Controller Platform | Sodium SR3 |
Testing and Integration Plans
Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.
Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.
Gaps
This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.
| Gaps identified | Impact |
|---|---|
| To fill out | To fill out |
Known Defects and Issues
Please refer to
Risks
List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).
Please update any risk on the centralized wiki page - Guilin Risks
Resources
Fill out the Resources Committed to the Release centralized page.
Release Milestone
The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.
Team Internal Milestone
| Milestone | Description | Date | Comments |
|---|---|---|---|
| M2/M3 | Functionality Freeze / API Freeze | ||
| July 31, 2020 | Last day to submit Guilin swagger / Yang changes to Gerrit | |
| Aug 3, 2020 | Release manager reviews worksheets to assess readiness for M2/M3 milestone | |
| Aug 6, 2020 | ||
| M4 | Code Freeze | ||
| Sept 4, 2020 | Last day to submit Frankfurt code changes to Gerrit | |
| Sept 7, 2020 | Release manager reviews worksheets to assess readiness for M4 milestone, including the following checks:
| |
| Sept 7, 2020 | ||
| Sept 10, 2020 | ||
| RC0 | Release Candidate 0 | ||
| Sept 25, 2020 | Last date to submit code fixes for release candidate 0 | |
| Sept 28, 2020 | ||
| Sept 28, 2020 | ||
| Oct 1, 2020 | ||
| RC1 | Release Candidate 1 | ||
| Oct 9, 2020 | Last date to submit code fixes for Frankfurt release candidate 1 | |
| Oct 12, 2020 | ||
| Oct 12, 2020 | ||
| Oct 15, 2020 | ||
| RC2 | Release Candidate 2 | ||
| Oct 23, 2020 | Last date to submit code fixes for final Frankfurt release (RC2) | |
| Oct 26, 2020 | ||
| Oct 26, 2020 | ||
| Oct 29, 2020 | ||
| Release Sign-Off | Final TSC Sign-Off | May 7, 2020 | Frankfurt Release Sign-Off |
Documentation, Training
Please update the following centralized wiki: Frankfurt Documentation
That includes
- Team contributions to the specific document related to he project (Config guide, installation guide...).
- Team contributions to the overall Release Documentation and training asset
- High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
- Documentation includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
Note
The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.
Other Information
Vendor Neutral
If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.
Free and Open Source Software
FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.
Each project must edit its project table available at Project FOSS.
Charter Compliance
The project team comply with the ONAP Charter.