DRAFT PROPOSAL FOR COMMENTS

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 SDN-C project provides a global network controller, built on the Common Controller SDK, which manages, assigns and provisions network resources.   As a "global" controller, the SDN-C project is intended to run as one logical instance per enterprise, with potentially multiple geographically diverse virtual machines / docker containers in clusters to provide high availability.  The project also will support the ability to invoke other local SDN controllers, including third party SDN controllers.

In the Amsterdam release, the SDN-C project will be used to manage, assign and provision network resources for the Amsterdam release use cases, listed in the Use Cases section below.

Use Cases

The use cases supported in the Amsterdam release are:

• Virtual Domain Name Server (vDNS)
• Virtual Firewall (vFW)
• Virtual Voice over LTE (vVoLTE)
• Virtual Customer Premise Equipment (vCPE)

Minimum Viable Product

The Minimum Viable Product for Amsterdam is the set of capabilities needed to support the use cases listed above. 

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

Stories

Longer term roadmap

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 Amsterdam release, since our primary goal is to support the user cases identified above, 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.

Sub-Components

Subcomponents of each ONAP project may be found on the Resources and Repositories (Deprecated) page on this wiki.  Please see the 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
  • Note: not sure if this applies to release 1.  Will depend on whether needed to support release 1 use cases

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

API Incoming Dependencies

List the API this release is expecting from other releases.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.

Prior to the delivery date, it is a good practice to organize an API review with the API consumers.

API Outgoing Dependencies

API this release is delivering to other releases.

Third Party Products Dependencies

Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

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

Provide a link toward the list of all known project bugs.

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

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.

Documentation, 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
  • ...

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.

Release Key Facts

Fill out and provide a link toward the centralized Release Artifacts.