...
| Info | ||
|---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Frankfurt |
| Project Lifecycle State | Incubation |
| Participating Companies | AT&T, Bell Canada, EricssonFujitsu, Ericsson, IBM, Huawei, Nokia, Orange, Samsung, Tech Mahindra, Wipro |
Scope
What is this release trying to address?
The Frankfurt 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. We believe this effort will span 2 releases - so we will begin in Frankfurt, and with the goal of being able to run the SLI as an independent container in Guilin.
Requirements
The following table lists the new functional requirements CCSDK is committing to support for the Frankfurt Release:
| Requirements | Companies Supporting Requirement | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Fujitsu | ||||||||||
| AT&T Bell Canada Ericsson Huawei Orange | ||||||||||
| IBM | ||||||||||
| Ericsson Huawei | ||||||||||
| Huawei | ||||||||||
| Huawei | ||||||||||
| Ericsson IBM | ||||||||||
| Huawei | ||||||||||
| Tech Mahindra | ||||||||||
| Wipro | ||||||||||
| AT&T | ||||||||||
| Orange Samsung |
Minimum Viable Product
...
Describe the MVP for this release.
The following epics represent the minimum viable product of the CCSDK Frankfurt Release:
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=CCSDK and issuetype in (epic) and fixversion="Frankfurt Release" and priority >= high serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
The following epics are also in scope for Frankfurt, 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 Frankfurt.
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=CCSDK and issuetype in (epic) and fixversion="Frankfurt Release" and priority< high serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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 Frankfurt Release:
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox CCSDK and issuetype in (epic) and fixversion="Frankfurt Release" and priority >= high serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
The following epics are also in scope for Frankfurt, 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 Frankfurt.
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=CCSDK and issuetype in (epic) and fixversion="Frankfurt Release" and priority < high serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox CCSDK and issuetype in (story) and fixVersion = "Frankfurt Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Bugs
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=CCSDK and issuetype in (bug) and fixVersion = "Frankfurt Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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 |
|---|---|
| To fill out | To fill out |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
...
| 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 (Deprecated) page on this wiki. Please see the CCSDK section of that page for subcomponent list of CCSDK.
Architecture
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Indicate where your project fit within the ONAP Architecture diagram.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Anyone reading this section should have a good understanding of all the interacting modules.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: Frankfurt Release Platform Maturity v1
API Incoming Dependencies
...
| API |
|---|
...
Prior to the delivery date, it is a good practice to organize an API review with the API consumers.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description|
|---|---|---|---|---|---|---|---|---|---|
| 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) |
|---|
Third Party Products Dependencies
...
| 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 |
|---|---|---|
| To fill out | To fill out | To fill out |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
| OpenDaylight | OpenDaylight SDN Controller Platform | Neon SR1 |
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 Frankfurt Defect Status
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 - Frankfurt 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
| Anchor | ||||
|---|---|---|---|---|
|
| Milestone | Description | Date | Comments |
|---|---|---|---|
| M2/M3 | Functionality Freeze / API Freeze | ||
| Jan 17, 2020 | Last day to submit Frankfurt swagger / Yang changes to Gerrit | |
| Jan 20, 2020 | Release manager reviews worksheets to assess readiness for M2/M3 milestone | |
|
...
This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is erecommended to provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
| Date | Project | Deliverable | ||
|---|---|---|---|---|
| To fill out | To fill out | To fill out | Jan 21, 2020 | |
| Jan 31, 2020 | Last day to submit code for initial release | ||
| Feb 4, 2020 | |||
| M4 | Code Freeze | |||
| Feb 28, 2020 | Last day to submit Frankfurt code changes to Gerrit | ||
| March 2, 2020 | Release manager reviews worksheets to assess readiness for M4 milestone, including the following checks:
| ||
| March 2, 2020 | |||
| March 5, 2020 | |||
| RC0 | Release Candidate 0 | |||
| March 20, 2020 | Last date to submit code fixes for release candidate 0 | ||
| March 23, 2020 | |||
| March 23, 2020 | |||
| March 26, 2020 | |||
| RC1 | Release Candidate 1 | |||
| April 2, 2020 | Last date to submit code fixes for Frankfurt release candidate 1 | ||
| April 6 2020 | |||
| April 6, 2020 | |||
| April 9, 2020 | |||
| RC2 | Release Candidate 2 | |||
| April 17, 2020 | Last date to submit code fixes for final Frankfurt release (RC2) | ||
| April 20, 2020 | |||
| April 20, 2020 | |||
| April 23, 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
...
| 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.
...