The content of this template is expected to be fill out for M1 Release Planning Milestone.
...
The following table lists the new functional requirements CCSDK is committing to support for the Guilin Honolulu Release:
| Requirements | Companies Supporting Requirement | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Orange, Samsung | ||||||||||
| Ericcson-EST | ||||||||||
| AT&T | ||||||||||
| AT&T | ||||||||||
| AT&T | ||||||||||
| Nokia, Orange, Ericcson, Highstreet |
...
| 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 SDNC section of that page for subcomponent list of SDNC.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
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:
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: Guilin Honolulu Release Platform Maturity
API Incoming Dependencies
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| A&AI : schemasA&AI schemas used by CCSDK aaa-service moduleVNF | API used to read/write information about VNFs | Defined in seed code | Included in seed code | TBD |
| SDC : distribution client | API used by ueb-listener (in CCSDK sdnc-northbound repo) to receive 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 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. Note: This API is deprecated in Frankfurt and will be removed in Guilin | 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
| Name | Description | Version |
|---|---|---|
| OpenDaylight | OpenDaylight SDN Controller Platform | Sodium SR3Aluminum SR2 |
Testing and Integration Plans
...
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.
...
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 - Guilin Risks Honolulu Risks
Resources
Fill out the Resources Committed to the Release centralized page.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 Level and Planning: Honolulu and all the supporting project agreed to comply with these dates.
...
Please update the following centralized wiki:Frankfurt Honolulu 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
- ...
...