When introducing significant changes to the VNF Requirements project or changes that may require discussion. It recommended that a Proposal be created. The wiki page will be the place to collaborate and track changes as the proposal is reviewed, revised, and ultimately accepted or rejected.
Please follow these steps when creating a proposal.
- Copy the Proposal Template and create a page under the Proposals section of the VNF Requirements Wiki.
- Update the content of your proposal and set the status to Draft
- Create a JIRA ticket in the VNF Requirements project announcing the ticket, and put a reference to the ticket on the Proposals page
- Project: VNF Requirements
- Issue Type: Task
- Summary: Proposal Review:Title of Proposal
- Description: Link to proposal
The VNF Requirements Project maintains repos for the source documentation of various deliverable:
...
- ONAP VNF Guidelines
...
- ONAP VNF Requirements
...
- Mapping VNF use cases and with E2E Release A use cases
...
- ONAP VNF Requirements Test Descriptions
VNF Guidelines Document Outline - Wenyao Guan
- Purpose
- Scope
- Introduction
- Motivation
- Audience
- Program and Document structure
- VNF Context
- Business Process Impacts
- VNF View of ONAP integration
- Evolving towards VNFs
- VNF Characteristics
- VNF Development
- ONAP Ready
- Virtualization Environment Ready
- Summary
- Appendix
- Glossary
- References
- Comparison between VNF Guidelines and ETSI GS NFV-SWAxxx
VNF Requirements Document Outline - Herb Patten
- Purpose
- Scope
- Introduction
- Overview of the document, use of the requirements for
- VNF Development Requirements
- VNF Design
- VNF Resiliency
- VNF Security
- VNF Modularity
- Devops
- VNF Modeling Requirements
- TOSCA YAML
- HEAT
- Infrastructure Requirements
- OpenStack
- Azure
- ONAP Management Requirements
- Service Design
- VNF On-boarding and package management
- Configuration Management
- Monitoring & Management
- Appendix
- Data Record Formats
Seed Document mapping for VNF Requirements
...
Seed Document
...
Section
...
ONAP Document
...
Section
...
VNF Cloud Readiness Requirements for ONAP
...
Title, Document Revision History, Table of Contents, Definitions, 1. Introduction
...
N/A
...
N/A - this content is not applicable because it is document specific content including title pages, revision history and ToC. The introduction is only relevant to the set of seed documents.
...
VNF Cloud Readiness Requirements for ONAP
...
2. VNF Design
...
VNF Requirements
...
4.a VNF Design
...
VNF Cloud Readiness Requirements for ONAP
...
3. Resiliency
...
VNF Requirements
...
4.b VNF Resiliency
...
VNF Cloud Readiness Requirements for ONAP
...
4. Security
...
VNF Requirements
...
4.c VNF Security
...
VNF Cloud Readiness Requirements for ONAP
...
5. DevOps
...
VNF Requirements
...
4.e Devops
...
VNF Management Requirements for ONAP
...
Title, Document Revision History, Table of Contents, 1. Introduction
...
N/A
...
N/A - this content is not applicable because it is document specific content including title pages, revision history and ToC. The introduction is only relevant to the set of seed documents.
...
VNF Management Requirements for ONAP
...
2. Design Definition
...
VNF Requirements
...
7.b VNF On-boarding and package management
...
VNF Management Requirements for ONAP
...
3. Configuration Management
...
VNF Requirements
...
7.c Configuration Management
...
VNF Management Requirements for ONAP
...
4. Monitoring & Management
...
VNF Requirements
...
7.d Monitoring & Management
...
VNF Management Requirements for ONAP
...
Appendix A - Chef JSON Key Description
...
VNF Requirements
...
8.a Data Records
...
VNF Management Requirements for ONAP
...
Appendix B - Ansible JSON Key Value Description
...
VNF Requirements
...
8.a Data Records
...
VNF Management Requirements for ONAP
...
Appendix C - VNF License Information Guidelines
...
VNF Requirements
...
8.a Data Records
...
VNF Management Requirements for ONAP
...
Appendix D – Ansible Server Specification
...
VNF Requirements
...
8.a Data Records
...
VNF Heat Template Requirements for ONAP
...
Title, Document Revision History, Table of Contents, Definitions, Introduction sections 1, 1.1, 1.2, 1.3, Appendix A Glossary, Last page – creative common license
...
N/A
...
N/A - this content is not applicable because it is document specific content including title pages, revision history and ToC. The introduction is only relevant to the set of seed documents.
...
VNF Heat Template Requirements for ONAP
...
1.4 VNF Modularity
6. Design Pattern: VNF Modularity
7. Scaling Considerations
...
VNF Requirements
...
4.d VNF Modularity
...
VNF Heat Template Requirements for ONAP
...
2. General Guidelines
3. Networking
4. Parameter Naming Convention
5. Heat Template Constructs
...
VNF Requirements
5.b Heat
...
5.a TOSCA YAML
Currently moved as is but need to be updated further with the latest NFV profile reference and introductory wording
...
The content will be updated with a latest decision by the VNF-SDK modeling and moved to
7.b VNF On-boarding and package management
...
5.a TOSCA YAML
The content is currently moved as is but will be updated according to ETSI GS NFV-IFA011 (gs_NFV-IFA011v020101p.pdf) and TOSCA Simple Profile for NVF ver.1.0 (tosca-nfv-v1.0-csd04.pdf)
Seed Document mapping for VNF Guidelines
...
Seed Document
...
Section
...
ONAP Document
...
Section
...
N/A
...
N/A
...
VNF Guidelines
...
Title, Document Revision History, Table of Contents
...
VNF Guidelines for Network Cloud and OpenECOMP
...
2. 1 Motivation
...
VNF Guidelines
...
3.a Motivation
...
VNF Guidelines for Network Cloud and OpenECOMP
...
2.2 Audience
...
VNF Guidelines
...
3.b Audience
...
VNF Guidelines for Network Cloud and OpenECOMP
...
2.3 Program and Document structure
...
VNF Guidelines
...
3.c Program and Document structure
...
VNF Guidelines for Network Cloud and OpenECOMP
...
3 VNF Context
...
VNF Guidelines
...
4 VNF Context
...
VNF Guidelines for Network Cloud and OpenECOMP
...
3.1 Business Process Impacts
...
VNF Guidelines
...
4.a Business Process Impacts
...
VNF Guidelines for Network Cloud and OpenECOMP
...
3.2 VNF View of ONAP integration
...
VNF Guidelines
...
4.b VNF View of ONAP integration
...
VNF Guidelines for Network Cloud and OpenECOMP
...
3.3 Evolving towards VNFs
...
VNF Guidelines
...
4.c Evolving towards VNFs
...
VNF Guidelines for Network Cloud and OpenECOMP
...
4 VNF Characteristics
...
VNF Guidelines
...
5 VNF Characteristics
...
VNF Guidelines for Network Cloud and OpenECOMP
...
4.1 VNF Development
...
VNF Guidelines
...
5.a VNF Development
...
VNF Guidelines for Network Cloud and OpenECOMP
...
4.2 ONAP Ready
...
VNF Guidelines
...
5.b ONAP Ready
...
VNF Guidelines for Network Cloud and OpenECOMP
...
4.3 Virtualization Environment Ready
...
VNF Guidelines
...
5.c Virtualization Environment Ready
...
VNF Guidelines for Network Cloud and OpenECOMP
...
5 Summary
...
VNF Guidelines
...
6 Summary
...
Appendix C Comparison between VNF Guidelines and ETSI GS NFV-SWAxxx
...
EPIC statement structure for requirements
For each requirement adopt a standardized numbering scheme, and format
...
For each use case adopt a standardized format
- Title
- Requirement #
- summary
- Actors (VNF, Operator, ONAP Platform etc.)
- Preconditions
- Operational sequence ( e.g. Message Sequence chart + text explanations)
- Post conditions
Test Case Description Template
- Title
- Requirement #
- Use Case #
- summary
- ONAP Actors (VNF, Operator, ONAP Platform components etc.)
- Preconditions ( ONAP, VNF states, test equipment/ data patterns, measurements)
- Operational sequence ( e.g. Message Sequence chart + text explanations)
- Post conditions (any post processing of the measurements, any cleanup of the ONAP configuration, reset of the test equipment etc.)
- Test Result decision ( measurement decision criteria )