Add NSD Requirements and Definitions

Issue-Id: MODELING-28

Change-Id: I189fb02e4c48b7db9278095f817250afcf82966e
Signed-off-by: Lingli Deng <denglingli@chinamobile.com>

1 files changed, 140 insertions, 17 deletions

diff --git a/docs/ONAP release 1 spec/im/ns-im.rst b/docs/ONAP release 1 spec/im/ns-im.rst
index 627cf02..20ed3a2 100644
--- a/docs/ONAP release 1 spec/im/ns-im.rst
+++ b/docs/ONAP release 1 spec/im/ns-im.rst
@@ -28,46 +28,169 @@ For the purposes of the present document, the following abbreviations apply:
 +------------+--------------------------------------------+
 |     DSL    |       Domain Specific Language             |
 +------------+--------------------------------------------+
-|     GS     |       Group Specification                  |
-+------------+--------------------------------------------+
-|    MANO    |       Management and Orchestration         |
-+------------+--------------------------------------------+
-|    MPLS    |       Multi-Protocol Label Switching       |
-+------------+--------------------------------------------+
 |     NCT    |       Network Connectivity Topology        |
 +------------+--------------------------------------------+
-|     NFP    |       Network Forwarding Path              |
-+------------+--------------------------------------------+
-|    NFPD    |       Network Forwarding Path Descriptor   |
-+------------+--------------------------------------------+
 |     NSD    |       Network Service Descriptor           |
 +------------+--------------------------------------------+
 |     UML    |       Unified Modeling Language            |
 +------------+--------------------------------------------+
 |     VL     |       Virtual Link                         |
 +------------+--------------------------------------------+
-|     VLD    |       Virtual Link Descriptor              |
-+------------+--------------------------------------------+
 
 NSD Infomration Model Overview
 ------------------------------
 
-An Network Service (NS), as defined by ETSI NFV ISG is a composition of Network Functions (NF) arranged as a set of functions with unspecified connectivity between them or according to one or more forwarding graphs.
+Network Service (NS) is a set of functions with unspecified connectivity between them or according to one or more forwarding graphs.
 
 The Network Service Descriptor (NSD) is a deployment template which consists of information used by the NFV Orchestrator (NFVO) for life cycle management of an NS.
 
-As illustrated in the following figure, the description of a NS as used by the NFV Management and Orchestration (MANO) functions to deploy an NS instance includes or references the descriptors of its constituent objects:
+As illustrated in the following figure, the description of a NS used to deploy an NS instance includes or references the description of its constituent objects:
 
-* Zero, one or more Virtualized Network Function Descriptors (VNFD);
+* Zero, one or more Virtualized Network Function Nodes Descriptors;
 * Zero, one or more Physical Network connect PNFs to VLs;
 * Zero, one or more nested NSD;
-* Zero, one or more Virtual Link Descriptor (VLD) used by the NFVO to deploy Virtual Links (VL) ; and
-* Zero, one or more VNF Forwarding Graph Descriptors (VNFFGD).
+* Zero, one or more Virtual Link Description used by the NFVO to deploy Virtual Links (VL) ; and
+* Zero, one or more VNF Forwarding Graph Descriptions.
 
 Functional Requirements
 -----------------------
 
+The following table specifies requirements to the templates for NSD instances in R1.
+
++-----------------+-----------------------------------------------------------------+
+|  Numbereing     |                  Requirement Description                        |
++-----------------+-----------------------------------------------------------------+
+|  NST_NSD001     | The NSD shall reference the VNF Node description of constituent |
+|                 | VNFs.                                                           |
++-----------------+-----------------------------------------------------------------+
+|  NST_NSD002     | The NSD shall include the VLDs applicable to the VLs used by the|
+|                 | NS to interconnect its constituent NFs.                         |
++-----------------+-----------------------------------------------------------------+
+|  NST_NSD003     | The NSD shall include a globally unique identifier for identify-|
+|                 | ing each descriptor instance.                                   |
++-----------------+-----------------------------------------------------------------+
+|  NST_NSD004     | The NSD shall include an identifier to select the controller co-|
+|                 | mpatible with the NSD.                                          |
++-----------------+-----------------------------------------------------------------+
+|  NST_NSD005     | The NSD shall support the capability to include or reference NS |
+|                 | life cycle management scripts describing how to react upon spec-|
+|                 | ific life cycle events, fault detection, performance threshold  |
+|                 | crossing detection and other events.                            | 
++-----------------+-----------------------------------------------------------------+
+|  NST_NSD006     | The NSD shall support the capability to provide monitoring para-|
+|                 | meters to be tracked during the lifetime of a NS instance.      |
++-----------------+-----------------------------------------------------------------+
+
+
+The following table specifies requirements to the templates for VLD instances.
+
++-----------------+-----------------------------------------------------------------+
+|  Numbereing     |                  Requirement Description                        |
++-----------------+-----------------------------------------------------------------+
+|  NST_VLD001     | A VLD shall enable specifying the type of connectivity provided |
+|                 | by the link between VNFs.                                       |
+|                 | In the R1, the VL should support ELAN type at least.            |
++-----------------+-----------------------------------------------------------------+
+
+
+
 NSD Information Model Definitions
 ---------------------------------
 
+NSD
+^^^
+
+The NSD information element is a template whose instances are used by the VF-C for the lifecycle management of NSs.
+
++---------------+-----------+-------------+----------+--------------------------------------------+
+|   Attribute   | Qualifier | Cardinality |  Content |                 Description                |
++---------------+-----------+-------------+----------+--------------------------------------------+
+|    id         |     M     |      1      |Identifier| Identifier of this NSD information element.|
+|               |           |             |          | It globally uniquely identifies an instance|
+|               |           |             |          | of the NSD.                                |
++---------------+-----------+-------------+----------+--------------------------------------------+
+|   name        |     M     |      1      | String   | The name of the NSD.                       |
++---------------+-----------+-------------+----------+--------------------------------------------+
+|  serviceType  |     M     |      1      | String   | Identifies the type of the SD.             |
+|               |           |             |          | enum:E2E Service, Network                  |
++---------------+-----------+-------------+----------+--------------------------------------------+
+|controllerinfo |     M     |      1      | String   | Identifies controller(s) conmpatible with  |
+|               |           |             |          | the NS described in this version of the NSD|
+|               |     M     |             |          | default: VF-C.                             |
++---------------+-----------+-------------+----------+--------------------------------------------+
+|     vnfd      |     M     |     0..N    |  VNF id  | Consituent VNF node information of this NSD|
++---------------+-----------+-------------+----------+--------------------------------------------+
+|virtualLinkDesc|     M     |     0..N    |  VLD     | Speficies the constituent VLDs.            |
++---------------+-----------+-------------+----------+--------------------------------------------+
+
+VL Description
+^^^^^^^^^^^^^^
+
+The VL information element provides general information enabling the instantiation of virtual links.
+
++------------------+-----------+-------------+----------+--------------------------------------------+
+|      Attribute   | Qualifier | Cardinality |  Content |                 Description                |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|       id         |     M     |      1      |Identifier| Identifier of this VirtualLinkDesc informa-|
+|                  |           |             |          | tion element. It globally uniquely identif-|
+|                  |           |             |          | ies a VL Description.                      |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|       name       |     M     |      1      | String   | Specifies the name of the VL Description.  |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|     description  |     M     |     0..1    | String   | Specifies human-readable information on the|
+|                  |           |             |          | purpose of the VL (e.g. control plane traf-|
+|                  |           |             |          | fic).                                      |
++------------------+-----------+-------------+----------+--------------------------------------------+
+| isExternalNetwork|     M     |      1      | Boolean  | Whether the VL is external network.        |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|    shared        |     O     |     0..1    | Boolean  | Whether the VL is shared.                  |
++------------------+-----------+-------------+----------+--------------------------------------------+
+| network_type     |     O     |     0..1    | String   | Network type of the VL.                    |
++------------------+-----------+-------------+----------+--------------------------------------------+
+| segmentation_id  |     O     |     0..1    | String   | Network segmentation id of the VL.         |
++------------------+-----------+-------------+----------+--------------------------------------------+
+| physical_network |     O     |     0..1    | String   | Physical network of the VL.                |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|      mtu         |     O     |     0..1    | Integer  | Network MTU of the VL.                     |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|      cidr        |     O     |     0..1    | String   | Subnetwork cidr of the VL.                 |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|    ip_version    |     O     |     0..1    | String   | Subnetwork IP protocol version of the VL.  |
++------------------+-----------+-------------+----------+--------------------------------------------+
+| enable_dhcp      |     O     |     0..1    | Boolean  | Whether or not th subnetwork enables DHCP. |
++------------------+-----------+-------------+----------+--------------------------------------------+
+|   gateway_ip     |     O     |     0..1    | String   | Subnetwork gateway IP address.             |
++------------------+-----------+-------------+----------+--------------------------------------------+
+
+VNF Node Description Information
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|     Attribute   | Qualifier | Cardinality |  Content |                 Description                |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|      id         |     M     |      1      |Identifier| Identifier of this VNF Descriptjion.       |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|      name       |     M     |      1      | String   | Specifies the name of the VNF Description. |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|     description |     M     |     0..1    | String   | Specifies human-readable information on the|
+|                 |           |             |          | purpose of the VNF.                        |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|     vnfminfo    |     M     |     0..1    | String   | Identifies VNFM(s) compatible with the VNF |
+|                 |           |             |          | described in the VNF Description.          |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|   vnfExtCpd     |     M     |     0..N    | vnfExtCpd| VNF External Connection Points.            |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+
+
+vnfExtCpd
+^^^^^^^^^
+
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|     Attribute   | Qualifier | Cardinality |  Content |                 Description                |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|      cpdid      |     M     |     1..N    |Identifier| Reference to the correspondent internal CPD|
++-----------------+-----------+-------------+----------+--------------------------------------------+
+|      vldid      |     M     |     1..N    |Identifier| Reference to the external VLD(s).(TBD)     |
++-----------------+-----------+-------------+----------+--------------------------------------------+
+