Versions Compared

Old Version 23

changes.mady.by.user Hagop Bozawglanian

Saved on

compared with

New Version Current

changes.mady.by.user Trevor Lovett

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...


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 a consistent experience for VNF providers across the VNF lifecycle.  See the VNF Requirements Charter for more information.

...


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.

On a new requirement, this attribute can be left off and the tox -e docs or check.py script generate and ID and populate this field.

targetRequiredString

VNF, PNF, VNF OR PNF, VNF|PNF|
PNF
VNF or PNF
VNF DOCUMENTATION PACKAGE
PNF DOCUMENTATION PACKAGE
VNF or PNF DOCUMENTATION PACKAGE
VNF PROVIDER
PNF PROVIDER
VNF or PNF PROVIDER,
VNF HEAT CSAR PACKAGE
PNF CSAR PACKAGE",
VNF |PNF|VNF or PNF CSAR PACKAGE", VNF|PNF|VNF or PNF DOCUMENTATION
VNF HEAT PACKAGE

The component to which the requirement applies.
keywordRequiredString

MUST

,

MUST NOT

,

SHOULD

,

SHOULD NOT

,

MAY

The 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.

When adding a new requirement, this can be left off and  the tox -e docs or check.py script will add this for you.

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 use case section of the document affords a way to provide a VNF Provider a VNF-centric view of certain  use cases.  It is not required that every use case supported by ONAP be documented in this section.  Instead, key use cases that require discrete actions and coordination with the VNF can be described here to provide a clearer understanding of potentially multi-step complex interactions.   

...