Overview
Project Name | VNFSDK |
---|---|
Target Release Name | Casablanca |
Project Lifecycle State | Incubation |
Participating Company | Huawei, Intel, AT&T, Gigaspaces, China Mobile, Wind River, Orange, Amdocs, Nokia, ZTE, IBM, VMWare, Cisco, ARM |
Scope
What is this release trying to address?
VNF SDK's mission is to simplify the process of developing and onboarding VNFs and expanding ONAP's VNF ecosystem. For Service Providers, VNFSDK will reduce the time and level of testing required to identify, select, and onboard a VNF. For vendors, VNFSDK will reduce integration efforts by defining a standard for VNF packaging with widespread operator acceptance. VNFSDK can be used in a validation/conformance testing program in the future.
The Casablanca release will enhance existing functionality, introduce security, integrate with ONAP use-case flow and progress towards being carrier grade with high quality.
- Enhance dovetail integration so we can use it in LFN Compliance/Verification testing
- Improvements to function test for better integration into the framework
- Incorporate vnfreqs testable requirements
- consistent support for HEAT/TOSCA VNFs (as defined in VNFReqs) - may not be 100% common
- NB. HEAT tests will be developed by VVP, but may be implemented in VNFSDK for VNF Compliance Testing
- consistent support for HEAT/TOSCA VNFs (as defined in VNFReqs) - may not be 100% common
- modular marketplace framework to make it easier to plug in tests (maybe configurable per application such as compliance testing, operator-vendor engagement, 3rd party enhancements, etc.)
- Support SDC on boarding tests (maybe allow SDC to replace refrepo portal, but use vnfmarket-be for their own onboarding test engine
- Package data model enhancements (internal and onboarding models?)
- VES: multivim enhancements, PNF registration, notification, and RAN metrics (5G use case)
- Enhance HPA, SOL-004 certificate, and other carry-over items
Use Cases
- VNF provider uses VNFSDK for VNF Compliance Testing
- Support operator use of VNFSDK for vendor engagement/acceptance testing
- 3rd Party Lab uses VNFSDK for extended VNF testing (may include functional, non-functional, and/or performance tests developed by 3rd party labs)
- HPA
- Enhance Security
Minimum Viable Product
Describe the MVP for this release.
- Support the VNF packaging model & VNF Requirements defined in Beijing
- Support VNF Compliance under LFN CVC umbrella
- HPA
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
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
- Support VNF lifecycle tests
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
---|---|
Compliance Tool | Executable |
Model | UML info model and TOSCA model |
Packaging tool | Executable |
Reference Repo/Marketplace | Executable |
API : Deliver API for external Project. The API will deliver such as uploading/downloading/Updating/etc functionality | |
Validation Tools | Executable |
Lifecycle Test Framework (future) | Executable/Library |
Function Test Framework | Executable |
VES Agent | code/libraries that can be included in VNFs |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
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.
Indicate where your project fit within the ONAP Archiecture diagram.
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.
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 | design-time component |
|
Stability | 1 | 1 | design-time component |
|
Resiliency | 1 | 1 | system run as-needed |
|
Security | 0 | 1 | increase test coverage to 50%. Implement https and aspects of SOL-004 |
|
Scalability | 0 | 0 | not a runtime component. VNF SDK will be run as-needed in constrained environment. |
|
Manageability | 1 | 1 |
| |
Usability | 1 | 1 | onap.readthedocs.io |
|
API Incoming Dependencies
List the API this project is expecting from other projects.
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) |
---|---|---|---|---|
none |
API Outgoing Dependencies
API this project is delivering to other projects.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|---|---|---|---|
Upload API | API for vendors to upload VNF packages to marketplace | M1 | M3 | API Documentation |
Download API | API for downloading VNF Package from marketplace | M1 | M3 | API Documentation |
Query VNF information | API to query information on VNFs uploaded to the marketplace | M1 | M3 | API Documentation |
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, ...).
Name | Description | Version |
---|---|---|
OPNFV Dovetail | To fill out | To fill out |
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.
We will enhance unit tests and CSIT tests for validation tools, packaging tools, and certification tools.
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.
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.
It is not expected to have a detailed project plan.
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.