...
| 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 | Amsterdam |
| Project Lifecycle State | Incubation |
| Participating Company | AT&T, AMDOCS, Huawei, China Mobile |
Scope
What is this release trying to address?
Describe the problem being solved by this release
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
Minimum Viable Product
Describe the MVP for this release.
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.
This project provides a common set of reusable code that can be used across multiple controllers. The code could be used in other components but would not be an end solution for use cases by itself and would not be deployed on its own.
- For example, the SDN-C , APP-C, DCAE, ONAP Operations Manager and ONAP controller can reuse common pieces from this framework.
While controllers are encouraged to use the common controller SDK libraries, usage of this common code is optional. Our goal is to provide code that is sufficiently flexible that there is no need for controllers to implement their own custom solutions, but we recognize that there are valid reasons why specific controllers might need to implement their own solutions and would not prevent them from doing so.
The following is a list of libraries that CCSDK plans to support:
- SDN-C core : core platform needed to execute directed graphs
- SDN-C adaptors : set of adaptors used by directed graphs to talk to other ONAP components or external services, including other controllers
- SDN-C northbound : northbound interfaces to SDN-C
- SDN-C plugins : add-on functionality used by directed graphs
- SDN-C oam : tools for operations, administration and maintenance of controller
- Common microservice / VF lifecycle management capabilities
- Common health checks
- Common APIs
- Common logging
- Common model management (e.g. Yang, TOSCA)
- Common resource management (e.g. IP management, DNS naming, keystore, containers)
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
TBD
Epics
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox ccsdk and issuetype in (epic) 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=sanbox ccsdk and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspectiveThe intent of the CCSDK project is to provide a common set of libraries that can be used to create new types of controllers. We anticipate that over time, the set of common functionality will grow as functionality that was originally delivered as part of a specific controller is generalized and migrated to the CCSDK project.
We also recognize that there will be times when a specific controller might need to develop its own implementation of functionality that is contained within CCSDK. It is not the intent of this project to preclude controllers from doing so if that project sees such a need.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| To fill out | To fill out |
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
ONAP Dependencies
...
| Deliverable Location | ||
|---|---|---|
| CCSDK Source Code | Source code for CCSDK project | ONAP gerrit |
| CCSDK Maven Artifacts | Compiled code that can be referenced in other projects as maven dependencies | ONAP Nexus |
| CCSDK Docker Containers | Docker containers associated with SDNC project:
| ONAP Nexus |
| Documentation | User and developer guides | ONAP Wiki |
| CCSDK 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 CCSDK section of that page for subcomponent list of CCSDK.
ONAP Dependencies
CCSDK depends on the following projects:
- Active and Available Inventory (A&AI)
- Service Design and Creation (SDC)
- Data Movement as a Platform (DMaaP)
- Documentation
- Integration
- External API
- Modeling
Architecture
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Anyone reading this section should have a good understanding of all the interacting modules.CCSDK will be 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:
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) |
|---|---|---|---|---|
| To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description |
API Outgoing Dependencies
API this release is delivering to other releases.
| A&AI : schemas | A&AI schemas used by CCSDK aaa-service module | Defined in seed code | Included in seed code | TBD |
| SDC : distribution client | API used by ueb-listener (in CCSDK sdnc-northbound repo) to receive artifacts from SDC | Defined in seed code | Included in seed code | TBD |
.API Outgoing Dependencies
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description |
Third Party Products Dependencies
...
| Maven libraries | Libraries used as dependencies by SDN-C, APP-C, DCAE and OOM | Included in seed code | Delivered in seed code | Javadoc will be provided |
| Docker containers | Base docker containers will be provided which can be used by SDN-C and APP-C as a basis for their docker containers | Included in seed code | Delivered in seed code |
Third Party Products Dependencies
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).
| Name | Description | Version |
|---|---|---|
| To fill out | To fill out | To fill out |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
| OpenDaylight | OpenDaylight SDN controller platform | Carbon |
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 |
|---|---|---|
| To fill out | To fill out | 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.