...
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. |
OverviewProject Name | Enter the name of the project |
---|
Target Release Name | Dublin |
Project Lifecycle State | Incubation |
Participating Company | AMDOCS, AT&T, Bell Canada, Ericsson,Huawei, IBM, Tech |
MahendraScope
What is this release trying to address?
The primary focus of the ONAP release 4 (Dublin) is to advance platform maturity, with a focus on S3P (Scalabllity, Stability, Security and Performance).
Use Cases
CCSDK SDNC will support the following use cases from previous releases:
CCSDK SDNC will also support the following additional use cases for Dublin:
Minimum Viable Product
Describe the MVP for this release.
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 represent the minimum viable product for the Dublin SDNC release:
Jira |
---|
server | ONAP JIRA |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
maximumIssues | 20 |
---|
jqlQuery | project=SDNC and issuetype in (epic) and fixversion="Dublin Release" and priority in (highest, high) order by priority desc |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
|
The following epics are considered stretch goals for the Dublin SDNC release. These are planned for Dublin, but may be scaled back or removed if necessary due to resource constraints.
Jira |
---|
server | ONAP JIRA |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
maximumIssues | 20 |
---|
jqlQuery | project=SDNC and issuetype in (epic) and fixversion="Dublin Release" and priority < high order by priority desc |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
|
Functionalities
Epics
The following epics are committed for the Dublin release
Jira |
---|
server | ONAP JIRA |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
maximumIssues | 20 |
---|
jqlQuery | project=SDNC and issuetype in (epic) and fixversion="Dublin Release" and priority in (Highest, High) order by priority desc |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
|
The following epics are considered stretch goals for the Dublin release. They are currently planned, but may be scaled back or cut if necessary due to resource constraints.
Jira |
---|
server | ONAP JIRA |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
maximumIssues | 20 |
---|
jqlQuery | project=sanbox SDNC and issuetype in (epic) and fixversion="Dublin Release" and priority < High order by priority desc |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
|
Stories
Jira |
---|
server | ONAP JIRA |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
maximumIssues | 20 |
---|
jqlQuery | project=sanbox SDNC and issuetype in (story) and fixversion="Dublin Release" |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
|
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.One critical long term objective for the SDN-C project is support for integration with other third party SDN Controllers (e.g. Open Contrail), well as integration with the SDN Agent project from Open-O. For the Dublin release, since our primary goal is to support the use cases identified above and to improve platform maturity, the degree to which we support such integration will be dictated by the needs of those use cases. However, we do want to bear in mind that such integration is critical and will be included in our release plans going forward.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description | Deliverable Location |
---|
CCSDK SDNC Source Code | Source code for |
CCSDK CCSDK SDNC Maven Artifacts | Compiled code that can be referenced in other projects as maven dependencies | ONAP Nexus |
CCSDK SDNC Docker Containers | Docker containers associated with SDNC project: |
(OpenDaylight) - container
- Database container
|
Directed Graph Builder | ONAP Nexus |
Documentation | User and developer guides | ONAP Wiki |
CCSDK SDNC 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 SDN-C section of that page for subcomponent list of SDN-C.
ONAP Dependencies
SDN-C depends on the following projects:
- Active and Available Inventory (A&AI)
- Common Controller SDK (CCSDK).
- Service Design and Creation (SDC)
- Data Movement as a Platform (DMaaP)
- Documentation
- Integration
- External API
- Modeling
- Multi VIM/Cloud
- Policy
Architecture
High level architecture diagram
CCSDK will be 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:
...
The following diagram shows the high level architecture of SDNC:
Image Added
The major architectural components of the SDN-C controller are:
- Device Data Models : Yang models that define interfaces to devices (virtual or physical) that the SDNC configures
- Service Network Data Models : Yang models that define data maintained within the SDNC about the network used by the set of services supported by this SDNC instance
- Service Chain Data Models : Yang models that define how services supported by an SDNC instance can be chained
- Service Data Models : Yang models that define data maintained within the SDNC for the set of services it supports
- Directed Graphs : programmable logic, updatable at run time with no restart, that define the behavior of the SDNC
- Service Logic Interpreter : module provided by CCSDK which allows platform to execute directed graphs
- API Handler : code (mostly generate from service Yang models) which implements RESTCONF API into SDNC. Most API handlers should follow the following pattern:
- Call directed graph named after invoked RPC, passing RESTCONF RPC parameters as Java Properties object.
- Return results from directed graph invocation as response to RESTCONF RPC
- Interface adaptors - code that allows directed graphs to invoke external interfaces
Platform Maturity
Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments |
---|
Performance | 0 | 0 | Awaiting guidance from Benchmark subcommittee | - 0 -- none
- 1 – baseline performance criteria identified and measured
- 2 & 3 – performance improvement plans created & implemented
|
Stability | 0 |
N/A | 1 | SDNC will perform 72 hour soak at component level. We assume that integration team will also do a 72 hour ONAP soak which includes SDNC. |
As a project that provides a library framework, CCSDK has no standalone component that can be soaked | - 0 – none
- 1 – 72 hours component level soak w/random transactions
- 2 – 72 hours platform level soak w/random transactions
- 3 – 6 months track record of reduced defect rate
|
Resiliency | 1 | 2 |
While CCSDK itself has no standalone component, it does provide an OpenDaylight docker container used by SDNC and APPC. In Beijing, CCSDK will support a clustered OpenDaylight configuration in Kubernetes, as well as a clustered database, to allow for automated detection and recovery within a site. SDNC will use that configuration to meet this requirement. See SDN-C Clustering on Kubernetes for further details | - 0 – none
- 1 – manual failure and recovery (< 30 minutes)
- 2 – automated detection and recovery (single site)
- 3 – automated detection and recovery (geo redundancy)
|
Security | 0 | 1 |
CCSDK will achieve 50% code coverageSDNC will improve test coverage to > 50% | - 0 – none
- 1 – CII Passing badge + 50% Test Coverage + 50% test coverage
- 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls
- 3 – CII Gold
|
Scalability | 0 |
N/A | | 1 | SDNC can be scaled either by adding additional OpenDaylight containers and/or database containers, or by deploying multiple instances of SDNC cluster |
Scaling does not apply to CCSDK itself, as a set of libraries. | - 0 – no ability to scale
- 1 – single site horizontal scaling
- 2 – geographic scaling
- 3 – scaling across multiple ONAP instances
|
Manageability | 1 | 1 |
CCSDK SDNC will support ONAP standard logging. | - 1 – single logging system across components; instantiation in < 1 hour
- 2 – ability to upgrade a single component; tracing across components; externalized configuration management
|
Usability | 1 | 1 | See readthedocs and wiki. | - 1 – user guide; deployment documentation; API documentation
- 2 – UI consistency; usability testing; tutorial documentation
|
API Incoming Dependencies
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|
A&AI : |
schemasA&AI schemas used by CCSDK aaa-service moduleVNF | API used to read/write information about VNFs | Defined in seed code | Included in seed code | TBD |
SDC : distribution |
client by ueb-listener (in CCSDK sdnc-northbound repo) to receive to distribute artifacts from SDC to subscribers | Defined in seed code | Included in seed code | TBD |
DMaaP | API used to receive DHCP event notification | 8/23/17 | 8/23/17 | DMaaP API |
API Outgoing Dependencies
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|
Maven librariesLibraries used as dependencies by SDN-C, APP-C, DCAE and OOMAPI used to verify that platform is available and healthy | 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 containersTBD (requested Confluence OPEN API to be installed so this can be published on ONAP Wiki) |
Generic VNF API | API used to request resources for VNFs. Will be deprecated in Beijing in favor of Generic Resource API. | Included in seed code | Delivered in seed code | TBD (requested Confluence OPEN API to be installed so this can be published on ONAP Wiki) |
Generic Resource API | API used to request resources for VNFs. This API is a superset of the generic VNF API, which it replaces | Included in Amsterdam release | Delivered in Amsterdam | TBD (requested Confluence OPEN API to be installed so this can be published on ONAP Wiki) |
Third Party Products Dependencies
Name | Description | Version |
---|
OpenDaylight | OpenDaylight SDN Controller Platform | Fluorine |
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
Provide a link toward the list of all known project bugs.
Jira |
---|
server | ONAP JIRA |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
maximumIssues | 20 |
---|
jqlQuery | project=sanbox SDNC and issuetype in (bug) and fixVersion="Dublin Release" |
---|
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
---|
|
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).
Risk identified | Mitigation Plan | Contingency Plan |
---|
To fill out | To fill out | To fill out |
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
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.
The following table shows the major project milestones and intermediate milestones for the Dublin release.
Milestone | Description | Date | Comments |
---|
M1 | End of release planning |
| Formal commitment to release scope |
| - M1 worksheets ready for review
| Jan 22, 2019 | Release manager reviews worksheets to assess readiness for M1 milestone |
| | Jan 24, 2019 |
|
M2 | Functionality Freeze |
|
|
| - Stable user stories baselined
| Feb 15, 2019 |
|
| - M2 worksheets ready for review
| Feb 19, 2019 | Release manager reviews worksheets to assess readiness for M2 milestone |
| | Feb 21, 2019 |
|
M3 | API Freeze |
|
|
| - Final API definitions (swagger, Yang) due
| March 8, 2019 | Last day to submit Dublin swagger / Yang changes to Gerrit |
| - M3 worksheets ready for review
| March 12, 2019 | Release manager reviews worksheets to assess readiness for M3 milestone |
| | March 14, 2019 |
|
M4 | Code Freeze |
|
|
| - Code due for Dublin user stories
| April 4, 2019 | Last day to submit Dublin code changes to Gerrit |
| - M4 worksheets ready for review
| April 9, 2019 | Release manager reviews worksheets to assess readiness for M4 milestone, including the following checks: - All repos must have >= 50% code (line) coverage in Sonar
- No failed Jenkins jobs
- All CSIT tests pass
- Healthchecks pass
|
| | April 11, 2019 |
|
RC0 | Release Candidate 0 |
|
|
| | April 19, 2019 | Last date to submit code fixes for release candidate 0 |
| - RC0 release artifacts available
| April 23, 2019 |
|
| - RC0 worksheets ready for review
| April 23, 2019 |
|
| | April 25, 2019 |
|
RC1 | Release Candidate 1 |
|
|
| | May 3, 2019 | Last date to submit code fixes for release candidate 1 |
| - RC1 release artifacts available
| May 7, 2019 |
|
| - RC1 worksheets ready for review
| May 7, 2019 |
|
| | May 9, 2019 |
|
RC2 | Release Candidate 2 |
|
|
| - Code due for final Dublin fixes
| May 17, 2019 | Last date to submit code fixes for final Dublin release (RC2) |
| - RC2 release artifacts available
| May 21, 2019 |
|
| - RC2 worksheets ready for review
| May 21, 2019 |
|
| | May 23, 2019 |
|
Release Sign-Off | Final TSC Sign-Off | May 30, 2019 | Dublin Release Sign-Off |
Date | Project | Deliverable |
---|
To fill out | To fill out | To fill outDocumentation, Training
- Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
- Highlight the 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
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.
...