Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated VNF Guidelines and Requirements Standards

Page Status: 

Status
colourYellow
titleDraft

Table of Contents

Table of Contents
maxLevel4


VNF Requirements Project Overview

...


The following table outlines the proposed standard metadata elements that will be associated with the requirements. This list may change over time.


Anchor
requirement_metadata
requirement_metadata
Table 2: Requirement Metadata

Field Name

Required

vs. Optional

Data Type

Valid Values/Format

Notes

idRequiredStringR-#####The unique requirement ID for this requirement. See VNFRQTS How to Contribute for more details.
targetRequiredString

VNF, VNFC, VNF PROVIDER, VNF HEAT ORCHESTRATION TEMPLATE,

VNF PACKAGE, PNF, XNF

The component to which the requirement applies.
keywordRequiredStringMUST, MUST NOT, SHOULD, SHOULD NOT, MAYThe RFC 2119 keyword for the requirement
introducedOptionalStringlower case release name (ex: bejing, casablanca)The release the requirement was initially introduced. New requirements should always have this.
updatedOptionalStringlower case release nameThe release the requirement was last modified. Any updated requirements going forward should have this.
impactsOptionalList of StringComma separated list of ONAP components (ex: so, sdc)The various ONAP components that need to be aware of any changes to the requirement
validation_modeOptionalStringstatic, 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_byOptionalList of String

Comma separated list:

vvp, vnfsdk, sdc

Projects that implement validations of this requirement.
linksOptionalList of StringComma or semi-colon separated list of requirement IDsThis 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_caseOptionalRST Link

Status
titledeprecated
Link to source file that implement the test case. This is included temporarily. Traceability from test case to requirement is now being provided by the VVP project.

notesOptionalStringFree form text

Status
titledeprecated
Short notes about the requirement. This was included to track some existing notes and metadata, but it will be retired in a future release.


Use Case Standards

The VNF and PNF Use Cases define high-level capabilities that guide how end users, the VNF, and the various ONAP components collaborate to support a given use case. 


Test Case Standards

TODO