Page Status: DRAFT
VNF Requirements Project Overview
The intent of the VNF Requirement and Guidelines project is to inform VNF providers of the standards, specifications, and guidlines to which they should adhere when targeting the ONAP platform. These requirements and guidelines will support the ONAP Architecture Principles, and ensure experience for VNF providers across the VNF lifecycle. See the VNF Requirements Charter for more information.
Objectives of This Guide
This guide targets people that may want to contribute content to the project or have a better understanding of the standards that apply to the requirements. These standards will attempt to address the following concerns:
- Ensure the content is appropriate for inclusion within the project deliverables
- Guide contributors on the proper sub-project the provided content should target (e.g. guidelines, requirements, etc.)
- Establish a consistent format for all content
- Standardize the metadata collected for each requirement
Requirement Structure and Repositories
The VNF Requirements Project comprises of several different document repositories (i.e. sub-projects) that provide guidance to VNF Providers from various perspectives. The following table outlines the repository where the content is stored, the location of the latest published version of the content on the official ONAP documentation site, the description of the content. When contributing content, please familiarize yourself with the various projects and target the content to the appropriate repository.
| Repo | Description | Deliverable document Title(s) |
|---|---|---|
| /guidelines | This includes objectives and motivations for the VNF Requirements work as well as forward looking, narrative text for use in prototype RFP text. | |
| /requirements | This includes formalized, uniquely numbered requirements that outline the requirements and specifications to which a VNF provider should adhere. Requirements will strive to be discrete and testable where possible, and will follow the guidance of RFC 2119 of requirement key words (e.g. SHOULD, MAY, etc.) for all numbered requirements. | |
| /usecases | Documents VNF specific use cases in support of ONAP E2E use cases illustrating behavior, sequences of operation, variants, error conditions, etc. There may be multiple use cases associated with a single requirement. | |
| /testcases | 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 |
Guideline Standards
Requirement Standards
ONAP/VNFRQTS VNF Requirements Discussion
Requirements should be single sentences using an RFC 2119 keyword { MUST | MUST NOT | SHOULD | SHOULD NOT | MAY }. The keyword should be bold.
The Subject of the Requirements sentence should be limited to { VNF | VNF Package | VNFC | VDU }
Requirements should be individually numbered. Format initially will be R-xxxxx
Draft example of the .rst format for requirements:
* R-xxxxx VNFs **MUST** meet their own resiliency goals and not rely on the Network Cloud.
The .rst formatting of the requirements should be such that the documentation can extract a complete set of requirements as a table in an appendix.