The VNF Requirements Project maintains repos for the source documentation of various deliverable:
Repo | Published for | Description | EPIC supported | Deliverable document Title(s) |
---|---|---|---|---|
/guidelines | External audience | This includes objectives and motivations for the VNF Requirements work as well as aspirational, forward looking, narrative text for use in prototype RFP text. | VNFRQTS-6 |
|
/requirements | External Audience | This is narrative text for use in prototype RFP text. | VNFRQTS-6 |
|
/epics | Internal Audience | Formalized requirements descriptions e.g. "As a ROLE I need SOMETHING so that SOME PURPOSE IS REALIZED" | see Project Charter | |
/usecases | Internal audience | This is a template structure providing a context for specific requirements. This illustrates behavior, sequences of operation, variants, error conditions, etc. There may be multiple use cases associated with a single requirement. Documents VNF specific use cases in support of ONAP E2E use cases. | see Project Charter |
|
/testcases | Internal Audience | This expands the use case template structure to supply the additional fields necessary to describe a test scenario. There may be multiple test case descriptions associated with a single use case | VNFRQTS-8 |
|
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 |
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 |
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 |
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 |
VNF Management Requirements for Open-O | 1. Introduction | VNF Requirements | N/A |
VNF Management Requirements for Open-O | 2.1 VNF Develop Steps | VNF Guidelines | 5.a VNF Development |
VNF Management Requirements for Open-O | 2.2 VNF Rest API | VNF Requirements | 7.c Configuration Management |
VNF Management Requirements for Open-O | 3.1 VNFM Driver Develop Steps | VNF Guidelines | 5.a VNF Development |
VNF Management Requirements for Open-O | 3.2 Create SVNFM Adaptor Mircoservice | VNF Guidelines | 5.a VNF Development |
VNF TOSCA Template Requirements | 1 Introduction | VNF Requirements | 5.a TOSCA YAML |
VNF TOSCA Template Requirements | 4 NFV TOSCA Template | VNF Requirements | 5.a TOSCA YAML |
EPIC statement structure for requirements
For each requirement adopt a standardized numbering scheme, and format
Reqt # | Requirement text |
---|---|
xxx | As a ROLE I need SOMETHING so that SOME PURPOSE IS REALIZED |
Use Case Template
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 )