Table of Contents
...
Here is an example of a requirement that adheres to the standards.
You may use the VNFRQTS Requirement Generation Tool to generate properly RST formatted requirements with unique ID numbers.
Requirement Example
|
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 | ||||
|---|---|---|---|---|---|---|---|---|
| id | Required | String | R-##### | The unique requirement ID for this requirement. See VNFRQTS How to Contribute for more details. | ||||
| target | Required | String | VNF, VNFC, VNF PROVIDER, VNF HEAT ORCHESTRATION TEMPLATE, VNF PACKAGE, PNF, VNF or PNF | 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. New requirements should always have this. | ||||
| updated | Optional | String | lower case release name | The release the requirement was last modified. Any updated requirements going forward should have this. | ||||
| 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. | ||||
| links | Optional | List of String | Comma or semi-colon separated list of requirement IDs | This is a list of IDs that this requirement is dependent on. When the HTML documentation is produced, linkages will be provided between the requirements. | ||||
| test_case | Optional | RST Link |
| |||||
| notes | Optional | String | Free form text |
|
...