Skip to end of metadata
Go to start of metadata

The content of this template is expected to be fill out for M1 Release Planning Milestone.


Overview

Project NameEnter the name of the project
Target Release NameKohn
Project Lifecycle StateMature
Participating Companies AT&T, Bell Canada, CapGemini, Fujitsu, Ericsson, IBM, Huawei, Nokia, Orange, Samsung, Tech Mahindra, Wipro

Scope

What is this release trying to address?

The Jakarta release contains a number of enhancements primarily centered around 5G use cases and ORAN integration.

We are completing work begun in the Guilin release to create a springboot-based microservice which will offer the SLI-API (used by healthcheck) and GENERIC-RESOURCE-APIs.  We will regression test our GR-API flows against both the current, OpenDaylight based implementation and the springboot-based version to validate that backward compatibility has been maintained. 

Requirements

The following table lists the new functional requirements SDNC is committing to support for the Kohn Release:

RequirementsCompanies Supporting Requirement

REQ-1212 - Getting issue details... STATUS

CapGemini

REQ-1215 - Getting issue details... STATUS

Wipro

REQ-1268 - Getting issue details... STATUS

Huawei

Minimum Viable Product

The following epics represent the minimum viable product of the SDNC Kohn Release:

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

The following epics are also in scope for Jakarta, 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

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

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 SDNC Kohn Release:

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

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 Istanbul.

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Stories

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh


Bugs

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

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 NameDeliverable DescriptionDeliverable Location
SDNC Source CodeSource code for SDNC projectONAP gerrit
SDNC Maven ArtifactsCompiled code that can be referenced in other projects as maven dependenciesONAP Nexus
SDNC Docker Containers

Docker containers associated with SDNC project:

  • Controller (OpenDaylight) container
  • Database container
  • Directed Graph Builder container
ONAP Nexus
DocumentationUser and developer guidesONAP Wiki
SDNC CI/CD automationScripts 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:sdnc


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

The following diagram shows the high level architecture of SDNC:

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

Please fill out the centralized wiki page: Kohn Release Platform Maturity

API Incoming Dependencies


API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
A&AI : VNFAPI used to read/write information about VNFsDefined in seed codeIncluded in seed codeTBD
SDC : distributionAPI used to distribute artifacts from SDC to subscribersDefined in seed codeIncluded in seed codeTBD
DMaaPAPI used to receive DHCP event notification8/23/178/23/17DMaaP API


API Outgoing Dependencies


API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
HealthcheckAPI used to verify that platform is available and healthyIncluded in seed codeDelivered in seed codeTBD (requested Confluence OPEN API to be installed so this can be published on ONAP Wiki)
Generic Resource APIAPI used to request resources for VNFs. This API is a superset of the generic VNF API, which it replacesIncluded in Amsterdam releaseDelivered in AmsterdamTBD (requested Confluence OPEN API to be installed so this can be published on ONAP Wiki)

Third Party Products Dependencies

NameDescriptionVersion
OpenDaylightOpenDaylight SDN Controller PlatformSulfur 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.

By M3,

  • All review comments addressed / reviews merged
  • All repos >= 55% code coverage
  • Healthchecks pass
  • CSIT tests pass

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 identifiedImpact
To fill outTo fill out

Known Defects and Issues

Please refer to the "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:sdnc

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


MilestoneDescription DateComments
M2Spec Freeze

 


M3Final Code Submission

 

Last date for code reviews to be submitted for Kohn user stories

M4Feature Freeze


  • Code ready for release build

 

  • All review comments addressed / reviews merged
  • All repos >= 55% code coverage
  • Healthchecks pass
  • CSIT tests pass

  • M4 release builds complete, helm charts updated to M4 version

 



  • TSC M4 approval vote

 

Released dockers must be built and code reviews submitted to OOM to bump to Jakarta M4 versions
RCRelease Candidate


  • Code due for RC fixes

 

Last date to submit code fixes for Kohn RC

  • RC release builds complete, helm charts updated to M4 version

 



  • TSC RC approval vote

 


Release Sign-OffFinal TSC Sign-Off

 

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.