diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Chapter3/index.rst | 30 | ||||
| -rw-r--r-- | docs/Chapter5/Tosca.rst | 55 |
2 files changed, 66 insertions, 19 deletions
diff --git a/docs/Chapter3/index.rst b/docs/Chapter3/index.rst index 72bec23..a60592a 100644 --- a/docs/Chapter3/index.rst +++ b/docs/Chapter3/index.rst @@ -22,11 +22,31 @@ Introduction to VNFs and within the control of the VNF provider. The current list of VNF Requirement targets is: - - The VNF - - The VNFC - - The VNF Provider - - The VNF Heat Orchestration Template - - The VNF Package ++---------------------+-------------------------------------------------------+ +| 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}| Something the provider of the VNF, PNF, or VNF/PNF | +| Provider | 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}| A requirement related to the contents of what should | +| CSAR PACKAGE | 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. | ++---------------------+-------------------------------------------------------+ - Chapter 4 contains the xNF requirements involving the design and development of xNFs. These requirements help VNFs/PNFs operate efficiently within a cloud environment. Requirements cover design, diff --git a/docs/Chapter5/Tosca.rst b/docs/Chapter5/Tosca.rst index 274a48c..88f531e 100644 --- a/docs/Chapter5/Tosca.rst +++ b/docs/Chapter5/Tosca.rst @@ -108,17 +108,25 @@ VNF Package Structure and Format .. req:: :id: R-87234 - :target: VNF - :keyword: MAY + :target: VNF or PNF + :keyword: MUST :introduced: casablanca + :updated: dublin - The VNF package provided by a VNF vendor **MAY** be either with - TOSCA-Metadata directory (CSAR Option 1) or without TOSCA-Metadata - directory (CSAR Option 2) as specified in ETSI GS NFV-SOL004. On-boarding - entity (ONAP SDC) must support both options. + The VNF or PNF package provided by a VNF or PNF vendor **MUST** be with + TOSCA-Metadata directory (CSAR Option 1) as specified in + ETSI GS NFV-SOL004. + + **Note:** SDC supports only the CSAR Option 1 in Dublin. The Option 2 + will be considered in future ONAP releases. + +.. req:: + :id: R-506221 + :target: VNF or PNF CSAR PACKAGE + :keyword: MUST + :introduced: dublin - **Note:** SDC supports only the CSAR Option 1 in Casablanca. The Option 2 - will be considered in future ONAP releases, + The VNF or PNF TOSCA CSAR file **MUST** be a zip file with .csar extension. VNF Package Contents @@ -126,14 +134,15 @@ VNF Package Contents .. req:: :id: R-10087 - :target: VNF + :target: VNF or PNF CSAR PACKAGE :keyword: MUST :introduced: casablanca + :updated: dublin - The VNF package **MUST** contain all standard artifacts as specified in - ETSI GS NFV-SOL004 including Manifest file, VNFD (or Main TOSCA/YAML - based Service Template) and other optional artifacts. CSAR Manifest - file as per SOL004 - for example ROOT\\ **MainServiceTemplate.mf** + The VNF or PNF CSAR package **MUST** include all artifacts required by + ETSI GS NFV-SOL004 including Manifest file, VNFD or PNFD (or Main + TOSCA/YAML based Service Template) and other optional artifacts. CSAR + Manifest file as per SOL004 - for example ROOT\\ **MainServiceTemplate.mf** .. req:: :id: R-01123 @@ -180,12 +189,30 @@ VNF Package Contents :keyword: MUST :introduced: casablanca - The VNF provider MUST enumerate all of the open source licenses + The VNF provider **MUST** enumerate all of the open source licenses their VNF(s) incorporate. CSAR License directory as per ETSI SOL004. for example ROOT\\Licenses\\ **License_term.txt** .. req:: + :id: R-293901 + :target: VNF or PNF CSAR PACKAGE + :keyword: MUST + :introduced: dublin + + The VNF or PNF CSAR PACKAGE with TOSCA-Metadata **MUST** include following + additional keywords pointing to TOSCA files: + + - ETSI-Entry-Manifest + + - ETSI-Entry-Change-Log + + Note: For a CSAR containing a TOSCA-Metadata directory, which includes + the TOSCA.meta metadata file. The TOSCA.meta metadata file includes block_0 + with the Entry-Definitions keyword pointing to a TOSCA definitions YAML + file used as entry for parsing the contents of the overall CSAR archive. + +.. req:: :id: R-146092 :target: VNF or PNF :keyword: MUST |