...
| Info | ||
|---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Beijing |
| Project Lifecycle State | Incubation |
| Participating Company | AT&T, Huawei, ZTE, China Mobile, AMDOCS, Intel, Orange, Coriant, Bell Canada, Tech Mahindra, Brocade |
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 Beijing release, the SDN-C project will be used to manage, assign and provision network resources for the Beijing release use cases, listed in the Use Cases section below.
Use Cases
The use cases supported in the Beijing 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 Beijing 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
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sdnc and issuetype in (epic) and fixVersion="Beijing Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sdnc and issuetype in (story) and status!=CLOSED serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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 Beijing 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 |
|---|---|---|
| SDNC Source Code | Source code for SDNC project | ONAP gerrit |
| SDNC Maven Artifacts | Compiled code that can be referenced in other projects as maven dependencies | ONAP Nexus |
| SDNC Docker Containers | Docker containers associated with SDNC project:
| ONAP Nexus |
| Documentation | User and developer guides | ONAP Wiki |
| 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 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
The following diagram shows the high level architecture of SDNC:
...
- 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 |
|
| Stability | 0 | 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. |
|
| Resiliency | 1 | 2 | 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 |
|
| Security | 0 | 1 | SDNC will improve test coverage to > 50% |
|
| Scalability | 0 | 1 | SDNC can be scaled either by adding additional OpenDaylight containers and/or database containers, or by deploying multiple instances of SDNC cluster. |
|
| Manageability | 1 | 1 | SDNC will support ONAP standard logging. |
|
| Usability | 1 | 1 | See readthedocs and wiki. |
|
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 Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| A&AI : VNF | API used to read/write information about VNFs | Defined in seed code | Included in seed code | TBD |
| SDC : distribution | API used 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 this release is delivering to other releases.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| Healthcheck | API used to verify that platform is available and healthy | 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 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
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.
| 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 Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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 |
|---|---|---|
| Functional requirements are incompletely defined | Functional requirements that are not sufficiently defined for sizing by 1/18 will not accepted into Beijing release | 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.
...
| Date | Project | Deliverable |
|---|---|---|
| To fill out | To fill out | To fill out |
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
- ...
| 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.
Release Key Facts
Fill out and provide a link toward the centralized Release Artifacts.