summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorguochuyicmri <guochuyi@chinamobile.com>2018-10-09 18:35:42 +0800
committerguochuyicmri <guochuyi@chinamobile.com>2018-10-09 18:56:05 +0800
commit9e399dd92adf0f0851a7855783ce3dd8673aa4db (patch)
tree21bcb5decaa75f7815e16aad4d88d11223a40ae9 /docs
parent17ea15a6d40cc9bb1e3acb6ee4e52e6f61dc23a0 (diff)
NSD and ServiceDescriptor
Issue-ID: MODELING-108 Change-Id: I56ccda1a8fff9b583c9295ed1fb105b4f6ec856b Signed-off-by: guochuyicmri <guochuyi@chinamobile.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/ONAP Model Spec/im/NSD.rst698
-rw-r--r--docs/ONAP Model Spec/im/ServiceDescriptor.rst583
-rw-r--r--docs/ONAP Model Spec/im/index.rst4
3 files changed, 1284 insertions, 1 deletions
diff --git a/docs/ONAP Model Spec/im/NSD.rst b/docs/ONAP Model Spec/im/NSD.rst
new file mode 100644
index 0000000..0f3bea3
--- /dev/null
+++ b/docs/ONAP Model Spec/im/NSD.rst
@@ -0,0 +1,698 @@
+.. Copyright 2018 (China Mobile)
+.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+
+.. contents::
+ :depth: 3
+..
+
+
+ NetworkServiceDescriptorModel
+
+===============================
+
+|image0|
+
+Classes
+=======
+
+NetworkServiceDescriptor
+------------------------
+
+The NSD class is a deployment template whose instances are used by the
+NFVO for the lifecycle management of NSs. For all attributes in this
+class, the Producer is SDC and the Consumer is SDC/UUI/VFC
+
+Applied stereotypes:
+
+- OpenModelClass
+
+- support: MANDATORY
+
+- Preliminaryry
+
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| **AttributeName** | **Type** | **Mult.** | **Stereotypes** | **Description**|
+| | | | | |
++==========================+============================+=============+===================+================+
+| nsdIdentifier | Identifier | 1 | Preliminary | Identifier |
+| | | | | of this NSD |
+| | | | OpenModelAttribute| class. It |
+| | | | | globally |
+| | | | | uniquely |
+| | | | - isInvariant: | identifies |
+| | | | true | an instance |
+| | | | | of the NSD. |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| designer | String | 1 | Preliminary | Identifies |
+| | | | | the |
+| | | | OpenModelAttribute| designer of |
+| | | | | the NSD. |
+| | | | | |
+| | | | - isInvariant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| version | Version | 1 | Preliminary | Identifies |
+| | | | | the version |
+| | | | OpenModelAttribute| of the NSD. |
+| | | | | |
+| | | | | |
+| | | | - isInvariant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| nsdName | String | 1 | Preliminary | Provides |
+| | | | | the human |
+| | | | OpenModelAttribute| readable |
+| | | | | name of the |
+| | | | | NSD. |
+| | | | - isInvariant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| nsdInvariantId | Identifier | 1 | Preliminary | Identifies |
+| | | | | an NSD in a |
+| | | | OpenModelAttribute| version |
+| | | | | independent |
+| | | | | manner. |
+| | | | - isInvariant: | This |
+| | | | false | attribute is |
+| | | | | invariant |
+| | | | - valueRange: | across |
+| | | | no | versions of |
+| | | | range | NSD. |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| autoScalingRule | Rule | 0..\* | Preliminary | Specifies a |
+| | | | | rule to |
+| | | | OpenModelAttribute| trigger a |
+| | | | | scaling |
+| | | | | action on a |
+| | | | - isInvariant: | NS |
+| | | | false | instantiated |
+| | | | | according |
+| | | | - valueRange: | to the NSD. |
+| | | | | NOTE 1: The |
+| | | | no | rule is |
+| | | | range | based on a |
+| | | | constraint | combination |
+| | | | | of |
+| | | | | assertions |
+| | | | - support: | on the |
+| | | | MANDATORY | values of |
+| | | | | virtualised |
+| | | | | resource- |
+| | | | | related |
+| | | | | performance |
+| | | | | metrics and |
+| | | | | VNF |
+| | | | | Indicators |
+| | | | | identified |
+| | | | | by the |
+| | | | | monitoredInfo |
+| | | | | attribute. |
+| | | | | NOTE 2: |
+| | | | | There may |
+| | | | | be multiple |
+| | | | | data |
+| | | | | sources |
+| | | | | (each |
+| | | | | identified |
+| | | | | as |
+| | | | | monitoredInfo) |
+| | | | | per rule |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| monitoredInfo | MonitoredData | 0..\* | Preliminary | Identifies |
+| | | | | either a |
+| | | | OpenModelAttribute| virtualised |
+| | | | | resource- |
+| | | | | related |
+| | | | - isInvariant: | performance |
+| | | | false | metric or a |
+| | | | | VNF |
+| | | | | Indicator. |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| lifeCycleManagementScript| NsLifeCycleManagementScript| 0..\* | Preliminary | Provides a |
+| | | | | life cycle |
+| | | | OpenModelAttribute| management |
+| | | | | script |
+| | | | | written in |
+| | | | - isInvariant: | a Domain |
+| | | | | Specific |
+| | | | false | Language |
+| | | | | (DSL). |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| \_virtualLinkDesc | NsVirtualLinkDesc | 0..\* | Preliminary | Provides |
+| | | | | the |
+| | | | OpenModelAttribute| constituent |
+| | | | | VLDs. |
+| | | | | Cardinality |
+| | | | - isInvariant: | of 0 means |
+| | | | | that the NS |
+| | | | false | is a NF set |
+| | | | | with |
+| | | | - valueRange: | unspecified |
+| | | | | connectivity. |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| \_vnfdId | Vnfd | 0..\* | Preliminary | References |
+| | | | | the VNFD of |
+| | | | OpenModelAttribute| a |
+| | | | | constituent |
+| | | | | VNF. |
+| | | | - isInvariant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
+| | | | | |
+| | | | PassedByReference | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+| \_pnfdId | Pnfd | 0..\* | Experimental | References |
+| | | | | the PNFD of |
+| | | | | a |
+| | | | OpenModelAttribute| constituent |
+| | | | | PNF. |
+| | | | | |
+| | | | - isInvariant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
+| | | | | |
+| | | | PassedByReference | |
++--------------------------+----------------------------+-------------+-------------------+----------------+
+
+NsVirtualLinkDesc
+-----------------
+
+The NsVirtualLinkDesc class provides general information enabling the
+instantiation of virtual links. For all attributes in this class the
+Producer is SDC and the Consumer is SDC/UUI/VFC.
+
+**Parent class:** VirtualLinkDesc
+
+Applied stereotypes:
+
+- OpenModelClass
+
+- support: MANDATORY
+
+- Preliminaryry
+
++------------------------+-----------------+-------------+-------------------+----------------+
+| **Attribute Name** | **Type** | **Mult.** | **Stereotypes** | **Description**|
++========================+=================+=============+===================+================+
+| vitualLinkDescProvider | String | 0..1 | Preliminary | Defines the |
+| | | | | organization |
+| | | | OpenModelAttribute| generating |
+| | | | | the VLD. |
+| | | | | |
+| | | | - isInvariant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++------------------------+-----------------+-------------+-------------------+----------------+
+| virtuaLinkDescVersion | Version | 1 | Preliminary | Specifies |
+| | | | | the version |
+| | | | OpenModelAttribute| of the VLD. |
+| | | | | |
+| | | | - isInvariant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++------------------------+-----------------+-------------+-------------------+----------------+
+| VirtualLinkDf | VirtualLinkDf | 1 | Preliminary | Specifies |
+| | | | | properties |
+| | | | OpenModelAttribute| for |
+| | | | | instantiating |
+| | | | - isInvariant: | a VL |
+| | | | false | according |
+| | | | | to a |
+| | | | | specific |
+| | | | - valueRange: | flavour. |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++------------------------+-----------------+-------------+-------------------+----------------+
+| virtualLinkDescId | Identifier | 1 | Preliminary | Uniquely |
+| | | | | identifies |
+| | | | OpenModelAttribute| a VLD in |
+| | | | | the parent |
+| | | | | descriptor. |
+| | | | - isInvariant: | For |
+| | | | | VnfVirtualL |
+| | | | false | inkDesc, |
+| | | | | the parent |
+| | | | - valueRange: | descriptor |
+| | | | | is the |
+| | | | no | VNFD. For |
+| | | | range | NsVirtualLi- |
+| | | | constraint | nkDesc, |
+| | | | | the parent |
+| | | | | descriptor |
+| | | | - support: | is the NSD. |
+| | | | MANDATORY | Note: the |
+| | | | | description |
+| | | | | of this |
+| | | | | class are |
+| | | | | different |
+| | | | | in ETSI GS |
+| | | | | NFV IFA 011 |
+| | | | | and ETSI GS |
+| | | | | NFV IFA |
+| | | | | 014. The |
+| | | | | present |
+| | | | | definition |
+| | | | | merges the 2 |
+| | | | | definitions. |
++------------------------+-----------------+-------------+-------------------+----------------+
+| connectivityType | ConnectivityType| 1 | Preliminary | Specifies |
+| | | | | the |
+| | | | OpenModelAttribute| protocol |
+| | | | | exposed by |
+| | | | | a VL and |
+| | | | - isInvariant: | the flow |
+| | | | | pattern |
+| | | | false | supported |
+| | | | | by the VL. |
+| | | | - valueRange: | |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++------------------------+-----------------+-------------+-------------------+----------------+
+| description | String | 0..1 | Preliminary | Provides |
+| | | | | human-readable |
+| | | | OpenModelAttribute| information |
+| | | | | on the |
+| | | | - isInvariant: | purpose of |
+| | | | | the VL |
+| | | | false | (e.g. |
+| | | | | control |
+| | | | - valueRange: | plane |
+| | | | | traffic). |
+| | | | no | |
+| | | | range | |
+| | | | constraint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDATORY | |
++------------------------+-----------------+-------------+-------------------+----------------+
+
+Pnfd
+----
+
+The Pnfd class is a deployment template enabling on-boarding PNFs and
+referencing them from an NSD. It focuses on connectivity aspects only.
+
+**Parent class:** NetworkFunctionDesc
+
+Applied stereotypes:
+
+- OpenModelClass
+
+- support: MANDATORY
+
+- Experimental
+
+
+
+Vnfd
+----
+
+The Vnfd class is a deployment template enabling on-boarding VNFs and
+referencing them from an NSD.
+
+Data Types
+==========
+
+ConnectivityType
+----------------
+
+The ConnectivityType datatype specifies the protocol exposed by a VL and
+the flow pattern supported by the VL.
+
++--------------+--------------+-----------+-----------+-------------------+----------------+
+| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**|
+| Name** | | | | | |
++==============+==============+===========+===============================+================+
+| layerProtocol| LayerProtocol| 1 | RW | Preliminary | identifies |
+| | | | | | the |
+| | | | | OpenModelAttribute| protocol |
+| | | | | | this VL |
+| | | | | | gives |
+| | | | | - isInvariant: | access to |
+| | | | | false | (IPV4, IPV6). |
+| | | | | | |
+| | | | | - valueRange: | |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++--------------+--------------+-----------+-----------+-------------------+----------------+
+| flowPatternrn| String | 0..1 | RW | Preliminary | Identifies |
+| | | | | | the flow |
+| | | | | OpenModelAttribute| pattern |
+| | | | | | of the |
+| | | | | - isInvariant: | connectivity |
+| | | | | | (Line, |
+| | | | | false | Tree, |
+| | | | | | Mesh). |
+| | | | | - valueRange: | |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++--------------+--------------+-----------+-----------+-------------------+----------------+
+
+MonitoredData(TBD)
+------------------
+
+The MonitoredData datatype identifies information to be monitored during
+the lifetime of a network service instance.
+
+NsLifeCycleManagementScript
+---------------------------
+
+The LifeCycleManagementScript information element specifies a script for
+the NS.
+
++-------------+-----------+-----------+-----------+-------------------+----------------+
+| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**|
+| Name** | | | | | |
++=============+===========+===========+===============================+================+
+| event | String | 1..\* | RW | OpenModelAttribute| Describes NS |
+| | | | | | lifecycle |
+| | | | | - isInvarriant: | event(s) |
+| | | | | | or an |
+| | | | | false | external |
+| | | | | | stimulus |
+| | | | | | detected |
+| | | | | | on an |
+| | | | | - valueRange: | NFVO |
+| | | | | no | reference |
+| | | | | range | point. |
+| | | | | constraint | NOTE 1: A |
+| | | | | | minimum |
+| | | | | | set of NS |
+| | | | | | lifecycle |
+| | | | | - support: | events |
+| | | | | | triggered |
+| | | | | MANDATORY | internally |
+| | | | | | by the NFVO |
+| | | | | | includes: |
+| | | | | | start |
+| | | | | | instantiation, |
+| | | | | | end |
+| | | | | | instantiation, |
+| | | | | | start |
+| | | | | | scaling, |
+| | | | | | end |
+| | | | | | scaling, |
+| | | | | | start |
+| | | | | | healing, |
+| | | | | | end |
+| | | | | | healing, |
+| | | | | | start |
+| | | | | | termination, |
+| | | | | | end |
+| | | | | | termination, |
+| | | | | | start |
+| | | | | | update, |
+| | | | | | end |
+| | | | | | update. |
+| | | | | | NOTE 2: A |
+| | | | | | minimum |
+| | | | | | set of |
+| | | | | | external |
+| | | | | | stimulus |
+| | | | | | includes: |
+| | | | | | the |
+| | | | | | receipt |
+| | | | | | of |
+| | | | | | request |
+| | | | | | message |
+| | | | | | of |
+| | | | | | instantiation, |
+| | | | | | scaling, |
+| | | | | | healing, |
+| | | | | | termination, |
+| | | | | | update of NS. |
++-------------+-----------+-----------+-----------+-------------------+----------------+
+| script | String | 1 | RW | OpenModelAttribute| Includes |
+| | | | | | an NS LCM |
+| | | | | | script |
+| | | | | - isInvarriant: | (e.g., |
+| | | | | | written |
+| | | | | false | in a DSL) |
+| | | | | | triggered |
+| | | | | | to react |
+| | | | | - valueRange: | to one of |
+| | | | | | the |
+| | | | | no | events |
+| | | | | range | listed in |
+| | | | | constraint | the event |
+| | | | | | attribute. |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++-------------+-----------+-----------+-----------+-------------------+----------------+
+
+NsQoS
+-----
+
+The NsQoS datatype specifies quality of service parameters applicable to
+a NS VL.
+
++---------------------+-----------+-----------+-----------+-------------------+----------------+
+| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**|
++=====================+===========+===========+===========+===================+================+
+| priority | Integer | 0..1 | RW | Preliminary | Specifies |
+| | | | | | the |
+| | | | | | priority |
+| | | | | OpenModelAttribute| level in |
+| | | | | | case of |
+| | | | | | congestion |
+| | | | | - isInvariant: | on the |
+| | | | | false | underlying |
+| | | | | | physical |
+| | | | | - valueRange: | links. |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++---------------------+-----------+-----------+-----------+-------------------+----------------+
+| latency | Number | 1 | RW | Preliminary | Maximum |
+| | | | | | latency |
+| | | | | | in ms. |
+| | | | | OpenModelAttribute| |
+| | | | | | |
+| | | | | - isInvariant: | |
+| | | | | false | |
+| | | | | | |
+| | | | | - valueRange: | |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++---------------------+-----------+-----------+-----------+-------------------+----------------+
+| packetDelayVariation| Number | 1 | RW | Preliminary | Maximum |
+| | | | | | jitter in |
+| | | | | | ms. |
+| | | | | OpenModelAttribute| |
+| | | | | | |
+| | | | | - isInvariant: | |
+| | | | | false | |
+| | | | | | |
+| | | | | - valueRange: | |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++---------------------+-----------+-----------+-----------+-------------------+----------------+
+| packetLossRatio | Number | 0..1 | RW | Preliminary | Maximum |
+| | | | | | packet |
+| | | | | | loss |
+| | | | | OpenModelAttribute| ratio. |
+| | | | | | Cardinality |
+| | | | | - isInvariant: | is 0 if |
+| | | | | | no |
+| | | | | false | packetLossRatio|
+| | | | | | requirement |
+| | | | | - valueRange: | exists. |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++---------------------+-----------+-----------+-----------+-------------------+----------------+
+
+VirtualLinkDf
+-------------
+
+The VirtualLinkDf datatype specifies properties for instantiating a VL
+according to a specific flavour.
+
++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+
+| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**|
++=======================+==========================+===========+===========+===================+================+
+| flavourId | Identifier | 1 | RW | Preliminary | Identifies |
+| | | | | | this |
+| | | | | OpenModelAttribute| VirtualLinkDF |
+| | | | | | datatype |
+| | | | | - isInvariant: | within a |
+| | | | | false | VLD. |
+| | | | | | |
+| | | | | - valueRange: | |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+
+| qos | NsQoS | 0..1 | RW | Preliminary | Specifies |
+| | | | | | quality |
+| | | | | | of |
+| | | | | OpenModelAttribute| service |
+| | | | | | parameters |
+| | | | | - isInvariant: | applicable |
+| | | | | false | to a VL. |
+| | | | | | |
+| | | | | - valueRange: | |
+| | | | | no | |
+| | | | | range | |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+
+| serviceAvaibilityLevel| ServiceAvailabilityLevel | 0..1 | RW | Preliminary | Specifies |
+| | | | | | one of |
+| | | | | | the three |
+| | | | | OpenModelAttribute| levels |
+| | | | | | defined |
+| | | | | | in ETSI |
+| | | | | - isInvariant: | GS NFV-REL |
+| | | | | false | 001: |
+| | | | | | |
+| | | | | | - Level1 |
+| | | | | | |
+| | | | | - valueRange: | - Level2 |
+| | | | | no | |
+| | | | | range | - Level3 |
+| | | | | constraint | |
+| | | | | | |
+| | | | | - support: | |
+| | | | | MANDATORY | |
++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+
+
+Enumerations
+============
+
+ ServiceAvailabilityLevel
+
+-------------------------
+
+Specifies one of the three levels defined in ETSI GS NFV-REL 001:
+Level 1 Level 2 Level 3
+
+Contains Enumeration Literals:
+
+- LEVEL_1:
+
+- LEVEL_2:
+
+- LEVEL_3:
+
+.. |image0| image:: media/image1.png
diff --git a/docs/ONAP Model Spec/im/ServiceDescriptor.rst b/docs/ONAP Model Spec/im/ServiceDescriptor.rst
new file mode 100644
index 0000000..b321b14
--- /dev/null
+++ b/docs/ONAP Model Spec/im/ServiceDescriptor.rst
@@ -0,0 +1,583 @@
+.. contents::
+ :depth: 3
+..
+
+ ServiceDescriptor
+===================
+
+Classes
+=======
+
+Attachment
+----------
+
+Applied stereotypes:
+
+- OpenModelClass
+
+- support: MANDATORY
+
++-------------+-------------+-------------+-------------+-------------+
+| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti |
+| Name** | | | es** | on** |
++=============+=============+=============+=============+=============+
+| id | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| name | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| description | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| type | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| url | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+
+ResourceDescriptor
+------------------
+
+Applied stereotypes:
+
+- OpenModelClass
+
+- support: MANDATORY
+
++-------------+-------------+-------------+-------------+-------------+
+| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti |
+| Name** | | | es** | on** |
++=============+=============+=============+=============+=============+
+| id | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| href | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| name | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| description | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| type | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| resourceTyp | String | 1 | OpenModelAt | |
+| e | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| resourceRol | String | 1 | OpenModelAt | |
+| e | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| version | String | 1 | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+
+.. _servicedescriptor-1:
+
+ServiceDescriptor
+-----------------
+
+ServiceDescriptor is used to model the design time representation of a
+service.
+
+Applied stereotypes:
+
+- OpenModelClass
+
+- support: MANDATORY
+
++-------------+-------------+-------------+-------------+-------------+
+| **Attribute | **Type** | **Mult.** | **Stereotyp | **Descripti |
+| Name** | | | es** | on** |
++=============+=============+=============+=============+=============+
+| invariantUu | Uuid | 1 | OpenModelAt | Constant |
+| id | | | tribute | identifier |
+| | | | | of the |
+| | | | - isInvari | service |
+| | | | ant: | model. |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| uuid | Uuid | 1 | OpenModelAt | Versioned |
+| | | | tribute | identifier |
+| | | | | of the |
+| | | | - isInvari | service |
+| | | | ant: | model (this |
+| | | | false | uuid is |
+| | | | | changed for |
+| | | | - valueRan | every major |
+| | | | ge: | version of |
+| | | | no | the |
+| | | | range | service) |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| name | String | 1 | OpenModelAt | The name of |
+| | | | tribute | the service |
+| | | | | model |
+| | | | - isInvari | designed. |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| description | String | 1 | OpenModelAt | The |
+| | | | tribute | description |
+| | | | | of the |
+| | | | - isInvari | service |
+| | | | ant: | model |
+| | | | false | designed. |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| category | String | 1..\* | OpenModelAt | A |
+| | | | tribute | predefined |
+| | | | | list which |
+| | | | - isInvari | identifies |
+| | | | ant: | the |
+| | | | false | construct's |
+| | | | | category. |
+| | | | - valueRan | There is a |
+| | | | ge: | predefined |
+| | | | no | list of |
+| | | | range | service |
+| | | | const | categories. |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| version | String | 1 | OpenModelAt | The service |
+| | | | tribute | model |
+| | | | | version. |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| serviceType | String | 1 | OpenModelAt | An optional |
+| | | | tribute | string |
+| | | | | field |
+| | | | - isInvari | defining a |
+| | | | ant: | generic |
+| | | | false | type (like |
+| | | | | category) |
+| | | | - valueRan | of the |
+| | | | ge: | service. |
+| | | | no | E.g. this |
+| | | | range | field can |
+| | | | const | be used for |
+| | | | raint | defining |
+| | | | | the service |
+| | | | - support: | as |
+| | | | MANDA | "TRANSPORT" |
+| | | | TORY | . |
++-------------+-------------+-------------+-------------+-------------+
+| serviceRole | String | 0..1 | OpenModelAt | An optional |
+| | | | tribute | string |
+| | | | | field for |
+| | | | - isInvari | shortcode |
+| | | | ant: | that |
+| | | | false | defines the |
+| | | | | function |
+| | | | - valueRan | that the |
+| | | | ge: | service is |
+| | | | no | providing. |
+| | | | range | E.g. |
+| | | | const | "MISVPN" or |
+| | | | raint | "AIM". |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| icon | String | 1 | OpenModelAt | The icon |
+| | | | tribute | path of the |
+| | | | | service. |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| serviceComp | Uuid | 1 | OpenModelAt | The service |
+| onentUuid | | | tribute | component |
+| | | | | descriptor |
+| | | | - isInvari | UUIDs that |
+| | | | ant: | the service |
+| | | | false | includes |
+| | | | | (relationhi |
+| | | | - valueRan | p |
+| | | | ge: | to Service |
+| | | | no | Component). |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| \_serviceDe | ServiceDesc | 0..\* | OpenModelAt | |
+| scriptor | riptor | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| \_serviceIn | ServiceInst | 0..\* | OpenModelAt | |
+| stance | ance | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| \_serviceCo | ServiceComp | 1..\* | OpenModelAt | |
+| mponentDesc | onentDescri | | tribute | |
+| riptor | ptor | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+| attachment | Attachment | 0..\* | OpenModelAt | |
+| | | | tribute | |
+| | | | | |
+| | | | - isInvari | |
+| | | | ant: | |
+| | | | false | |
+| | | | | |
+| | | | - valueRan | |
+| | | | ge: | |
+| | | | no | |
+| | | | range | |
+| | | | const | |
+| | | | raint | |
+| | | | | |
+| | | | - support: | |
+| | | | MANDA | |
+| | | | TORY | |
++-------------+-------------+-------------+-------------+-------------+
+
+Data Types
+==========
+
+Enumerations
+============
+
+ OrderState
+-----------
+
+Contains Enumeration Literals:
+
+- Acknowledged:
+
+- InProgress:
+
+- Pending:
+
+- Held:
+
+- Cancelled:
+
+- Completed:
+
+- Failed:
+
+- Partial:
+
+- Rejected:
+
+Primitives
+==========
+
+Interfaces
+==========
+
+Signals
+=======
+
+Operations
+==========
diff --git a/docs/ONAP Model Spec/im/index.rst b/docs/ONAP Model Spec/im/index.rst
index 65d6a8d..db5dbc3 100644
--- a/docs/ONAP Model Spec/im/index.rst
+++ b/docs/ONAP Model Spec/im/index.rst
@@ -12,4 +12,6 @@ ONAP Information Model Specifications
.. toctree::
:titlesonly:
- VnfdAndVnfInstance \ No newline at end of file
+ VnfdAndVnfInstance
+ NSD
+ ServiceDescriptor \ No newline at end of file