...
| 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 |
General Standards
The following standards apply to all sub-projects within the VNF Requirements Project.
- As VNF Requirements project is an ONAP project, all content must adhere to the general documentation standards defined in Creating Documentation section of the ONAP Developer Guide.
- All content must be written in reStructuredText (RST) with all warnings and errors resolved.
- Wherever possible, let RST handle numbering of content. This includes ordered lists, section numbers, footnotes, etc. This ensure content can be re-arranged easily with less likelihood of breaking numbering conventions.
Guideline Standards
TODO
Requirement Standards
This proposal aims to address the following objectives:
...
Here is an example of a requirement after the conversion:
Requirement Example
|
These requirement definitions can be processed by the sphinxcontrib-needs extension and used in a variety of ways.
...
The following table outlines the proposed standard metadata elements that will be associated with the requirements. This list may change over time.
Field Name | Required vs. Optional | Data Type | Valid Values/Format | Notes |
|---|---|---|---|---|
| target | Required | String | VNF, VNFC, VNF PROVIDER, VNF HEAT ORCHESTRATION TEMPLATE, VNF PACKAGE, PNF, XNF | The component to which the requirement applies. |
| keyword | Required | String | MUST, MUST NOT, SHOULD, SHOULD NOT, MAY | The RFC 2119 keyword for the requirement |
| introduced | Optional | String | lower case release name (ex: bejing, casablanca) | The release the requirement was initially introduced |
| updated | Optional | String | lower case release name | The release the requirement was last modified |
| impacts | Optional | List of String | Comma separated list of ONAP components (ex: so, sdc) | The various ONAP components that need to be aware of any changes to the requirement |
| validation_mode | Optional | String | static, stand_alone, in_service | How the requirement is validated: static - validated by statically inspecting the VNF package data stand_alone - validated by running tests against the VNF itself in_service - validated in the context of a full or partial ONAP deployment |
| validated_by | Optional | List of String | Comma separated list: vvp, vnfsdk, sdc | Projects that implement validations of this requirement. |
| test_case | Optional | RST Link | Link to source file that implement the test case | |
| notes | Optional | String | Free form text | Short notes about the requirement |
ONAP/VNFRQTS VNF Requirements Discussion
...