Add PNF Descriptor Capability requirements
[vnfrqts/requirements.git] / docs / Chapter5 / Tosca.rst
index 59ff0d0..dfb9b5d 100644 (file)
    limitations under the License.
 
 
-ONAP TOSCA VNFD Requirements
------------------------------
+ONAP TOSCA VNFD or PNFD Requirements
+------------------------------------
 
 
 Introduction
 ^^^^^^^^^^^^
 
-The following sub-clauses describe the numbered requirements
-for VNF Descriptor (VNFD) or in other words the VNF Service Template
-based on the most updated draft of ETSI NFV-SOL001 standard for VNF
-Descriptor. The ETSI standard specifies a NFV specific data model using
-TOSCA/YAML data model constructs specified in TOSCA Simple Profile in
-YAML v.1.2.
+The following sub-clauses describe the numbered requirements for VNF
+Descriptor (VNFD) and PNF Descriptor (PNFD) or in other words the VNF/PNF
+Service Template based on the most updated draft of ETSI NFV-SOL001 standard
+for VNF/PNF Descriptor. The ETSI standard specifies a NFV specific data
+model using TOSCA/YAML data model constructs specified in TOSCA Simple
+Profile in YAML v.1.2.
 
-The requirements for TOSCA/CSAR based VNF package are described as well
+The requirements for TOSCA/CSAR based VNF/PNF package are described as well
 and they are based on ETSI NFV-SOL004 standard.
 
 References
 ^^^^^^^^^^^^^^^^^^
 
-  1. ETSI GS NFV-SOL001 draft v.0.10.0
+  1. ETSI GS NFV-SOL001 v.2.5.1
   2. TOSCA SIMPLE Profile in YAML v.1.2
-  3. ETSI GS NFV-SOL004 v.2.5.1
+  3. ETSI GS NFV-SOL004 v.2.6.1 + NFV CR NFVSOL(18)000746r3.
 
 Intended Audience
 ^^^^^^^^^^^^^^^^^^
@@ -58,24 +58,24 @@ associated with this format.
 Overview
 ^^^^^^^^^^^^^^^^
 
-The document includes three charters to help the VNF providers to use the
-VNF model design tools and understand the VNF package structure and VNF
-TOSCA templates.
+The document includes three charters to help the VNF or PNF providers to
+use the VNF or PNF model design tools and understand the VNF or PNF package
+structure and VNF or PNF TOSCA templates.
 
-In the ONAP, VNF Package and VNFD template can be designed by manually
-or via model designer tools. VNF model designer tools can provide the
-GUI and CLI tools for the VNF provider to develop the VNF Package and VNFD
-template.
+In the ONAP, VNF or PNF Package and VNFD or PNFD template can be designed by
+manually or via model designer tools. VNF or PNF model designer tools can
+provide the GUI and CLI tools for the VNF or PNF provider to develop the
+VNF or PNF Package and VNFD or PNFD template.
 
-The VNF package structure is align to the NFV TOSCA protocol, and
-supports CSAR
+The VNF or PNF package structure is align to the NFV TOSCA protocol,
+and supports CSAR
 
-The VNFD and VNF package are all align to the NFV TOSCA protocol, which
-supports multiple TOSCA template yaml files, and also supports
-self-defined node or other extensions.
+The VNFD or PNFD and VNF or PNF package are all align to the NFV TOSCA
+protocol, which supports multiple TOSCA template yaml files, and also
+supports self-defined node or other extensions.
 
-VNF CSAR Package
-^^^^^^^^^^^^^^^^^^^^
+VNF or PNF CSAR Package
+^^^^^^^^^^^^^^^^^^^^^^
 
 CSAR Overview
 ~~~~~~~~~~~~~~~~
@@ -136,19 +136,16 @@ VNF Package Contents
 
 .. req::
     :id: R-01123
-    :target: VNF
+    :target: VNF or PNF
     :keyword: MUST
     :introduced: casablanca
+    :updated: dublin
 
-    The VNF package Manifest file **MUST** contain: VNF package meta-data, a
-    list of all artifacts (both internal and external) entry’s including
-    their respected URI’s, an algorithm to calculate a digest and a digest
-    result calculated on the content of each artifacts, as specified in
-    ETSI GS NFV-SOL004. The VNF Package MUST include VNF Identification
-    Data to uniquely identify the resource for a given VNF provider. The
-    identification data must include: an identifier for the VNF, the name
-    of the VNF as was given by the VNF provider, VNF description, VNF
-    provider, and version.
+    The VNF or PNF package Manifest file **MUST** contain: VNF or PNF package
+    meta-data, a list of all artifacts (both internal and external) entry's
+    including their respected URI's, an algorithm to calculate a digest and
+    a digest result calculated on the content of each artifacts, as specified
+    in ETSI GS NFV-SOL004.
 
 .. req::
     :id: R-21322
@@ -187,12 +184,40 @@ VNF Package Contents
 
     for example ROOT\\Licenses\\ **License_term.txt**
 
+.. req::
+    :id: R-146092
+    :target: VNF or PNF
+    :keyword: MUST
+    :introduced: dublin
+    
+    The VNF or PNF package Manifest file **MUST** contain: non-mano artifact
+    set with following ONAP public tag:
 
-VNF Package Authenticity
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+      - onap_ves_events
+
+      - onap_pm_dictionary
 
-Will be added in future releases.
+      - onap_yang_module
+
+      - onap_others
+
+VNF or PNF Package Authenticity
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+VNF or PNF package shall support a method for authenticity and integrity
+assurance. Note, Option 2 specified in SOL004 is supported in Dublin release.
+
+.. req::
+    :id: R-444945
+    :target: VNF or PNF
+    :keyword: MUST
+    :introduced: dublin
 
+    The complete CSAR file **MUST** be digitally signed with the VNF or PNF
+    provider private key. The VNF or PNF provider delivers one zip file
+    consisting of the CSAR file, a signature file and a certificate file that
+    includes the VNF or PNF provider public key. The certificate may also be
+    included in the signaturecontainer, if the signature format allows that.
 
 VNF Package ONAP Extensions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -429,7 +454,7 @@ Relationship Types
       **tosca.relationships.nfv.VirtualLinksTo**
 
         This relationship type represents an association relationship between
-        the VduCpds and VirtualLinkDesc node types.
+        the VduCpd's and VirtualLinkDesc node types.
 
 
 Interface Types
@@ -447,6 +472,115 @@ Interface Types
       **tosca.interfaces.nfv.vnf.lifecycle.Nfv** supports LCM operations
 
 
+TOSCA PNF Descriptor
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+General
+~~~~~~~~~~
+
+.. req::
+    :id: R-24632
+    :target: PNF
+    :keyword: MUST
+    :introduced: dublin
+
+    The PNF Descriptor (PNFD) provided by PNF vendor **MUST** comply with
+    TOSCA/YAML based Service template for PNF descriptor specified in ETSI
+    NFV-SOL001.
+
+
+.. req::
+    :id: R-998862
+    :target: PNF
+    :keyword: MUST
+    :introduced: dublin
+
+    The PNFD provided by a PNF vendor **MUST** comply with the following TOSCA
+    Types as specified in ETSI NFV-SOL001 standard:
+
+      - tosca.nodes.nfv.PNF
+
+      - tosca.nodes.nfv.PnfExtCp
+
+
+Data Types
+~~~~~~~~~~~~~~
+
+.. req::
+    :id: R-484843
+    :target: PNF
+    :keyword: MUST
+    :introduced: dublin
+
+    The PNFD provided by a PNF vendor **MUST** comply with the following Data
+    Types as specified in ETSI NFV-SOL001 standard:
+
+      - tosca.datatypes.nfv.CpProtocolData
+
+      - tosca.datatypes.nfv.AddressData
+
+      - tosca.datatypes.nfv.L2AddressData
+
+      - tosca.datatypes.nfv.L3AddressData
+
+      - tosca.datatypes.nfv.LocationInfo
+
+      - tosca.datatypes.nfv.CivicAddressElement
+
+
+Artifact Types
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+No artifact type is currently supported in ONAP.
+
+
+Capability Types
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. req::
+    :id: R-177937
+    :target: PNF
+    :keyword: MUST
+    :introduced: dublin
+
+    The PNFD provided by a PNF vendor **MUST** comply with the following
+    Capabilities Types as specified in ETSI NFV-SOL001 standard:
+
+      - tosca.datatypes.nfv.VirtualLinkable
+
+
+Requirements Types
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+Relationship Types
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+No requirements type is currently supported in ONAP.
+
+
+Interface Types
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+No interface type is currently supported in ONAP.
+
+
+Node Types
+~~~~~~~~~~~~~~
+
+
+Group Types
+~~~~~~~~~~~~~~
+
+No group type is currently supported in ONAP.
+
+
+Policy Types
+~~~~~~~~~~~~~~
+
+
+
 +--------------------------------------------------------------------+
 | +--------------------------------------------------------------+   |
 | | tosca\_definitions\_version: tosca\_simple\_yaml\_1\_0       |   |
@@ -945,7 +1079,7 @@ model as described in YAML 1.1. Pending on Shitao proposal (see
 NFVIFA(17)000110 discussion paper)
 
 **[editor note]** new relationship type as suggested in Matt
-presentation. Slide 8. With specific rules of “valid\_target\_type”
+presentation. Slide 8. With specific rules of "valid\_target\_type"
 
 +---------------------------+--------------------------------------+
 | **Shorthand Name**        | VirtualStorage                       |