DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Overview
| Project Name | VNF Requirements Project |
|---|---|
| Target Release Name | A |
| Project Lifecycle State | Incubation (Refer to ONAP Charter, section 3.3 Project Lifecycle for further information) |
| Participating Company | AT&T, China Mobile, Orange, Bell Canada, Amdocs, VMWare, Huawei, ZTE, Intel |
Scope
What is this release trying to address?
- This project will deliver a unified set of VNF Guidelines and Requirements.
- The VNF Guidelines and Requirements must be versioned to enable evolution based on operational experience
- The VNF Guidelines and Requirements will support the ONAP Architecture Principles.
- Identify a list of features and functionality will be developed.
- The VNF Guidelines and Requirements will support the Release 1 Use Cases.
- Use cases focused on VNF Requirements may be developed in this project, and they will need to be aligned with the ETE Platform use cases.
- It will be incorporating and integrating the source material on VNF Guidelines and Requirements from OPEN-O and ECOMP in Release 1
- VNF Guidelines and Requirements are to be refined beyond prototype text (e.g. through EPIC statements, use cases) to deliver test cases and test procedures for us in VNF onboarding & validation. VNF Requirement level use cases to be aligned with ETE platform use cases
- Identify what is in or out of scope. During the development phase, it helps reduce discussion.
- VNF Guidelines may be forward looking, or include best practices in VNF design and VNF lifecycle processes.
- VNF Requirements from ONAP APIs should be linked to the ONAP Release
- VNF Requirements may include:
- expected operational characteristics ( e.g. security, resilience, upgradeability)
- conditional requirements (e.g. When configured for deployment on High Availability Network Cloud Infrastructure, the VNF Shall …)
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
The TSC identified the following Use cases for Release A:
| TSC Use Case | VNFs identified in TSC Use case |
|---|---|
| (obselete)Use Case: VoLTE (vIMS + vEPC) | N/A |
| Use Case: Residential Broadband vCPE (Approved) | vBNG, vG_MUX, vG, vAAA, vDHCP, vDNS |
| Use Case: vFW/vDNS (Approved) | vFW, vPacketGenerator, vDataSink, vDNS, vLoadBalancer, all VPP based. |
| Use Case: VoLTE(approved) | vSBC, vPCSCF, vSPGW, vPCRF, VI/SCSCF, vTAS, VHSS, vMME |
The VNF Requirements developed by this project are applicable to the VNFs identified in the TSC E2E use cases.
- a VNF Provider (developer) using VNF Requirements in designing, testing, and certifying a VNF for use on ONAP
- a Service Provider using VNF Requirements as prototype text for RFPs to acquire VNFs to run in an ONAP context see VNFRQTS-16
- VNF Validation Project uses VNF Test Descriptions developed by this project to implement VNF testing for validation purposes.
Minimum Viable Product
- A set of Integrated VNF Requirements for use as prototype RFP text.
- VNF Test Descriptions for use by VNF Validation project
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
As an ONAP project we will Create and maintain VNF Requirements targeted to ONAP user audiences and the tasks they perform so that we can enable a viable ecosystem of VNF developers using the ONAP platform.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
VNF Guidelines VNF Requirements VNF EPICs VNF Use Cases VNF Test Descriptions | Documentation Documentation Documentation Documentation Documentation |
Sub-Components
VNF Guidelines:
VNF Requirements:
VNF EPICs:
VNF Use Cases:
VNF Test Descriptions:
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
Other ONAP projects that this VNF Requirements project depends on?
- SDN-C (for API requirements on VNFs)
- APPC (for VNF configuration requirements)
- VF-C (for VNF life cycle managment and configuration)
- Service Design & Creation (for VNF onboarding)
- DCAE (for VNF reporting requirements)
- Authentication and authorization Framework (for VNF Security Requirements)
- Modeling (for Tosca Data Modeling for VNF)
- Multi-VIM/ MultiCloud (for network cloud infrastructure requirements)
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.
Incoming Dependencies
The VNF Requirements project (as a non-code project) does not directly interface with APIs, however, it is expected that VNF Requirements may reference APIs that VNFs may be required to support.
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 |
| SDN-C | API requirements on VNFs | M2 | M3 | |
| APPC | VNF configuration requirements | M2 | M3 | |
| VF-C | VNF life cycle management and configuration | M2 | M3 | |
| Service Design & Creation | VNF onboarding | M2 | M3 | |
| DCAE | VNF reporting requirements | M2 | M3 | |
| Authentication and authorization Framework | VNF Security Requirements | M2 | M3 | |
| Modeling | Tosca Data Modeling for VNF | N/A | ||
| Multi-VIM/ MultiCloud | network cloud infrastructure requirements | N/A |
Outgoing Dependencies
The VNF Requirements Project does not generate code APIs, however, other projects are dependent on the outputs of this project. This release is delivering the following to other projects.
| Project 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 |
| VNF SDK | VNF tooling should support the development and packaging of VNFs that are conformant to the VNF Requirements | N/A | ||
| VNF Validation program (ICE) | VNF Validation should be traceable against the VNF Requirements | N/A see the VNFRQTS <> VNF Validation project Workflow wiki page | ||
| Documentation | References to deliverables produced by this project may be included in various ONAP release documents maintained through the documentation project | N/A see the VNFRQTS <> Documentation Project Workflows wiki page | ||
Reference VNFs (now Integration Project) | Reference VNFs should be VNF Requirement compliant. The Integration Project maintaining those Reference VNFS would be dependent on the VNF Requirements for validating compliance. | N/A see the VNFRQTS <> Integration Project Workflow wiki page |
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 |
|---|---|---|
| N/A | N/A | N/A |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Testing and Integration Plans
This VNF Requirements project does not generate code to be integrated by the Integration project.
However, the Integration project may be integrating VNFs, and those VNFs should have documented their degree of compliance against the published VNF Requirements.
refer to the VNFRQTS <> Integration Project Workflow wiki page.
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 recommended to provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
| Date | Project | Deliverable |
|---|---|---|
| July 21 | VNF Requirements | seed contributions in proper formats and repos |
| July 28 | VNF Requirements | documentation tool chain generating:
|
| August 1 | VNF Requirements | Sprint 1 defined |
| August 3 | VNF Requirements | M2: Test Cases Defined |
| August 15 | VNF Requirements | Sprint 1 complete, Sprint 2 Defined |
| August 24 | VNF Requirements | M3: |
| August 29 | VNF Requirements | Sprint 2 complete, Sprint 3 Defined |
| September 12 | VNF Requirements | Sprint 3 complete, Sprint 4 Defined |
| September 14 | VNF Requirements | M4: |
| September 26 | VNF Requirements | Sprint 4 complete, Sprint 5 Defined |
| September 28 | VNF Requirements | RC0 |
| October 10 | VNF Requirements | Sprint 5 complete, Sprint 6 Defined |
| October 12 | VNF Requirements | RC1 |
| October 24 | VNF Requirements | Sprint 6 complete. |
| October 26 | VNF Requirements | RC2 |
| November 2 | VNF Requirements | Signoff |
Documentation, Training
The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset. The VNF project generates primarily documentation assets of various forms.
Refer to the wiki page on VNFRQTS <> Documentation Project Workflows
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.
The VNF Requirements Project generates documentation, not code. As such it does not directly include any code directly. It may incorporate references to APIs etc generated by other ONAP projects. Any Open Source dependencies within those APIs should be documented by those projects.
Charter Compliance
The project team comply with the ONAP Charter.