...
- The requirement must be uniquely numbered (ex R-XXXXX). Please refer to VNFRQTS How to Contribute for more information on how requirement numbers are assigned.
- The requirement must use RFC 2119 keywords (MUST | MUST NOT | SHOULD | SHOULD NOT | MAY), and these keywords must be in uppercase and in bold. In RST, bold is achieved by wrapping the text in double asterisks (ex: **MUST**)
- The requirement should start off with the subject of the requirement and refer to one of the following:
VNF
VNFC
VNF Provider
VNF HEAT Orchestration Template
VNF Package
PNF
xNF (NOTE: xNF is a requirement that applies to both PNF and VNFs)
- The requirement should include the metadata as defined in
...
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.
...
The following table outlines the proposed standard metadata elements that will be associated with the requirements. This list may change over time.
Table 2: Requirement MetadataAnchor requirement_metadata requirement_metadata
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 |
...