| Status |
|---|
| ||||||||
| Submitter | ||||||||
|---|---|---|---|---|---|---|---|---|
| Contributors | ||||||||
| Proposed Release | Dublin | |||||||
| JIRA Ticket(s) | Each proposal should have at least 1 JIRA ticket for tracking purposes. Please open the ticket as a Task in the VNF Requirements project. |
Abstract
The VNF Requirements project denotes the "target" of the requirement (the entity that is responsible for fulfilling the requirement) in the :target: metadata field on the requirement. In recent commits, there have been a variety of proposed targets outside of the pre-defined targets listed in the Documentation Standards. Also with the introduction of PNF requirements and PNF CSARs the existing requirement targets are no longer sufficient.
...
The following targets are proposed
| Target | When is it used |
|---|---|
| VNF | Functional behavior of a VNF |
| PNF | Functional behavior of a PNF |
| VNF or PNF | Function behavior to both VNFs and PNFs |
| {VNF|PNF| VNF or PNF} |
| PROVIDER | Something the provider of the VNF, PNF, or VNF/PNF must do. This is often used to describe delivering artifacts or specific documentation that may not be part of a standard VNF package format. |
| VNF HEAT PACKAGE | The archive/zip file that includes Heat templates. The subject of the requirement my be further refined (Ex: Heat Environment File), but the metadata stay at the package level. |
{VNF|PNF|VNF or PNF} CSAR PACKAGE | A requirement related to the contents of what should be in the CSAR package. The subject of the requirement might be further refined (ex: CSAR manifest file, VNF Descriptor, etc.), but the :target: metadata would stay at the package level |
{VNF|PNF|VNF or PNF} DOCUMENTATION PACKAGE | VNFs and PNFs are expected to provide human readable documentation. This may come in the form of URLs or pdfs. This documentation may vary by VNF/PNF. The structure of the documentation is intended for human consumption and is not highly structured for machine ingestion. The human readable documentation may be provided through the VNF RFP/acquisition process. |
Additionally, we recommend the tool chain be updated to restrict the list of valid values that can be used if possible. This will prevent users from adding invalid metadata in the future.
...