CCSDK Kohn Release Planning
- Dan Timoney
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Overview
Project Name | Enter the name of the project |
|---|---|
Target Release Name | Kohn |
Project Lifecycle State | Mature |
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 Kohn release contains a number of enhancements primarily centered around 5G use cases and ORAN integration.
We are continuing work on OpenDaylight Decoupling in Kohn by refactoring our installation packages to allow us to deploy the same CCSDK artifacts unaltered on different OpenDaylight releases, with only a separate release-specific installation bundle for Karaf feature dependency declarations (karaf "feature.xml" files).
The Kohn release also includes a major release upgrade in OpenDaylight to the OpenDaylight Sulfur release. We are also adding a new repository to allow CCSDK to maintain its own copy of OpenDaylight code that is still needed but which is no longer supported by the OpenDaylight community. We plan to use this to maintain our own version of the original internet-draft version of the OpenDaylight RESTCONF interface, which is deprecated in Sulfur and scheduled for removal in Chlorine, the next OpenDaylight release after Sulfur.
As a proof of concept of OpenDaylight Decoupling, we plan to install the same CCSDK maven artifacts in OpenDaylight Phosphorus (the release before Sulfur), only varying the Karaf feature declarations to match Silicon versions. This POC had originally been planned for Jakarta but was delayed due to resource constraints.
Requirements
The following table lists the new functional requirements CCSDK is committing to support for the Kohn Release:
Requirements | Companies Supporting Requirement |
|---|---|
Ericcson, AT&T | |
Ericcson |
Minimum Viable Product
The following epics represent the minimum viable product of the CCSDK Kohn Release:
The following epics are also in scope for Kohn, 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 Kohn.
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 Kohn Release:
The following epics are also in scope for Kohn, 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 Kohn.
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
Please see the INFO.yaml files associated with each repo as the authoritative sources of information - https://gerrit.onap.org/r/admin/repos/q/filter: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: Kohn 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 | Sulfur 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.
N/A - CCSDK does not have direct interfaces of its own. It is tested as part of its client (SDNC)
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.
None
Known Defects and Issues
Please refer to "Bugs" section above
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 - Kohn Risks
Resources
Please see the INFO.yaml files associated with each repo as the authoritative sources of information - https://gerrit.onap.org/r/admin/repos/q/filter:ccsdk
Release Milestone
The milestones are defined at the Release Planning: Kohn and all the supporting project agreed to comply with these dates.
Team Internal Milestone
Milestone | Description | Date | Comments |
|---|---|---|---|
M2 | Spec Freeze | Jul 21, 2022 | |
M3 | Final Code Submission | Sep 1, 2022 | Last date for code reviews to be submitted for Kohn user stories |
M4 | Feature Freeze | ||
| Sep 9, 2022 |
| |
| Sep 13, 2022 | ||
| Sep 15, 2022 | Released dockers must be built and code reviews submitted to OOM to bump to Istanbul M4 versions | |
RC | Release Candidate | ||
| Oct 14, 2022 | Last date to submit code fixes for Kohn RC | |
| Oct 18, 2022 | ||
| Oct 20, 2022 | ||
Release Sign-Off | Final TSC Sign-Off | Nov 10, 2022 | Kohn Release Sign-Off |
Documentation, Training
Please update the following centralized wiki: Kohn 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.