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

Overview

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 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:

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.

Sub-Components

Subcomponents of each ONAP project may be found on the Resources and Repositories (Deprecated) page on this wiki.  Please see the SDNC section of that page for subcomponent list of 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: Frankfurt Release Platform Maturity

API Incoming Dependencies

API Outgoing Dependencies

Third Party Products Dependencies

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.

Known Defects and Issues

Please refer to TBD

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

Documentation, Training

Please update the following centralized wiki: Guilin 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
  • ...

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.