summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ONAP release 2 spec/im/virtuallinkprofile.rst183
-rw-r--r--docs/ONAP release 2 spec/im/virtualmemorydata.rst76
-rw-r--r--docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst101
-rw-r--r--docs/ONAP release 2 spec/im/virtualstoragedesc.rst66
-rw-r--r--docs/index.rst10
5 files changed, 436 insertions, 0 deletions
diff --git a/docs/ONAP release 2 spec/im/virtuallinkprofile.rst b/docs/ONAP release 2 spec/im/virtuallinkprofile.rst
new file mode 100644
index 0000000..5e0cfe3
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/virtuallinkprofile.rst
@@ -0,0 +1,183 @@
+.. 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
+..
+
+Class: VirtualLinkProfile
+=========================
+
++--------------------+-------------+------------------+-----------------+--------------------------+
+| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
++====================+=============+==================+=================+==========================+
+| vnfVirtualL | Identifier | 1 | Uniquely | support: |
+| inkDescId | (Reference | | identifies | MANDATORY |
+| | to | | a Vnf VLD. | |
+| | VnfVirtualL | | | |
+| | inkDesc) | | | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| flavourId | Identifier | 1 | Identifies | support: |
+| | (Reference | | a flavour | MANDATORY |
+| | to | | within the | |
+| | VirtualLink | | VnfVirtualL | |
+| | DescFlavour | | inkDesc. | |
+| | ) | | | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| localAffini | LocalAffini | 0..N | Specifies | support: |
+| tyOrAntiAff | tyOrAntiAff | | affinity or | MANDATORY |
+| inityRule | inityRule | | anti-affini | |
+| | | | ty | |
+| | | | rules | |
+| | | | applicable | |
+| | | | between the | |
+| | | | VLs based | |
+| | | | on this | |
+| | | | VnfVirtualL | |
+| | | | inkDesc. | |
+| | | | | |
+| | | | When the | |
+| | | | cardinality | |
+| | | | is greater | |
+| | | | than 1, | |
+| | | | both | |
+| | | | affinity | |
+| | | | rule(s) and | |
+| | | | anti-affini | |
+| | | | ty | |
+| | | | rule(s) | |
+| | | | with | |
+| | | | different | |
+| | | | scopes are | |
+| | | | applicable | |
+| | | | to the VLs | |
+| | | | based on | |
+| | | | this | |
+| | | | VnfVirtualL | |
+| | | | inkDesc. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| affinityOrA | Identifier | 0..N | Identifier( | support: |
+| ntiAffinity | | | s) | MANDATORY |
+| GroupId | | | of the | |
+| | | | affinity or | |
+| | | | anti-affini | |
+| | | | ty | |
+| | | | group(s) | |
+| | | | the | |
+| | | | VnfVirtualL | |
+| | | | inkDesc | |
+| | | | belongs to. | |
+| | | | | |
+| | | | NOTE: Each | |
+| | | | identifier | |
+| | | | references | |
+| | | | an affinity | |
+| | | | or | |
+| | | | anti-affini | |
+| | | | ty | |
+| | | | group which | |
+| | | | expresses | |
+| | | | affinity or | |
+| | | | anti-affini | |
+| | | | ty | |
+| | | | relationshi | |
+| | | | p | |
+| | | | between the | |
+| | | | VL(s) using | |
+| | | | this | |
+| | | | VnfVirtualL | |
+| | | | inkDesc | |
+| | | | and the | |
+| | | | VL(s) using | |
+| | | | other | |
+| | | | VnfVirtualL | |
+| | | | inkDesc(s) | |
+| | | | in the same | |
+| | | | group. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| maxBitRateR | LinkBitrate | 1 | Specifies | support: |
+| equirements | Requirement | | the maximum | MANDATORY |
+| | s | | bitrate | |
+| | | | requirement | |
+| | | | s | |
+| | | | for a VL | |
+| | | | instantiate | |
+| | | | d | |
+| | | | according | |
+| | | | to this | |
+| | | | profile. | |
+| | | | | |
+| | | | NOTE: These | |
+| | | | attributes | |
+| | | | are used to | |
+| | | | control | |
+| | | | scaling | |
+| | | | boundaries. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| minBitRateR | LinkBitrate | 1 | Specifies | support: |
+| equirements | Requirement | | the minimum | MANDATORY |
+| | s | | bitrate | |
+| | | | requirement | |
+| | | | s | |
+| | | | for a VL | |
+| | | | instantiate | |
+| | | | d | |
+| | | | according | |
+| | | | to this | |
+| | | | profile. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| initiationP | KeyValuePai | 0..N | Specifies | support: |
+| arameters | r/NameValue | | initiation | MANDATORY |
+| | Pair | | parameters | |
+| | | | for the | valueRange: |
+| | | | virtual |  specified |
+| | | | link. | values |
+| | | | | include: |
+| | | | | cidr, |
+| | | | | allocationP |
+| | | | | ools |
+| | | | | (represente |
+| | | | | d |
+| | | | | by |
+| | | | | [starting |
+| | | | | ip address, |
+| | | | | ending ip |
+| | | | | address]), |
+| | | | | gatewayIp, |
+| | | | | networkName |
+| | | | | , |
+| | | | | segmentatio |
+| | | | | nId, |
+| | | | | physicalNet |
+| | | | | work. |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| networkType | Enum | 0..1 | Type of the | support: |
+| | | | network. | MANDATORY |
+| | | | | |
+| | | | | valueRange: |
+| | | | | "VLAN", |
+| | | | | "VXLAN" |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| dhcpEnabled | Boolean | 0..1 | Indicating | support: |
+| | | | whether | MANDATORY |
+| | | | DHCP is | |
+| | | | enabled. | |
+| | | | Default is | |
+| | | | "FALSE" if | |
+| | | | not | |
+| | | | specified | |
+| | | | otherwise. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| vlanTranspa | Boolean | 0..1 | Indicating | support: |
+| rent | | | whether | MANDATORY |
+| | | | "VLAN | |
+| | | | Transparent | |
+| | | | Mode" is | |
+| | | | supported. | |
+| | | | Default is | |
+| | | | "FALSE" if | |
+| | | | not | |
+| | | | specified | |
+| | | | otherwise. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
diff --git a/docs/ONAP release 2 spec/im/virtualmemorydata.rst b/docs/ONAP release 2 spec/im/virtualmemorydata.rst
new file mode 100644
index 0000000..6f64b49
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/virtualmemorydata.rst
@@ -0,0 +1,76 @@
+.. 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
+..
+
+Class: VirtualMemoryData/VirtualMemoryDesc
+==========================================
+
++--------------------+-------------+------------------+-----------------+-------------------------+
+| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
++====================+=============+==================+=================+=========================+
+| virtualMemS | Number | 1 | Amount of | support: |
+| ize | (recommende | | virtual | MANDATORY |
+| | d | | Memory | |
+| | DM type: | | (e.g. in | |
+| | Scalar-Unit | | MB). | |
+| | -Size) | | | |
++--------------------+-------------+------------------+-----------------+-------------------------+
+| virtualMemO | String | 0..1 | The memory | support: |
+| versubscrip | | | core | MANDATORY |
+| tionPolicy | | | oversubscri | |
+| | | | ption | |
+| | | | policy in | |
+| | | | terms of | |
+| | | | virtual | |
+| | | | memory to | |
+| | | | physical | |
+| | | | memory on | |
+| | | | the | |
+| | | | platform. | |
+| | | | The | |
+| | | | cardinality | |
+| | | | can be 0 | |
+| | | | during the | |
+| | | | allocation | |
+| | | | request, if | |
+| | | | no | |
+| | | | particular | |
+| | | | value is | |
+| | | | requested. | |
++--------------------+-------------+------------------+-----------------+-------------------------+
+| vduMemRequi | KeyValuePai | 0..N | Array of | support: |
+| rements | r/NameValue | | key-value | MANDATORY |
+| | Pair | | pair | |
+| | | | requirement | |
+| | | | s | |
+| | | | on the | |
+| | | | memory for | |
+| | | | the VDU. | |
++--------------------+-------------+------------------+-----------------+-------------------------+
+| numaEnabled | Boolean | 0..1 | It | support: |
+| | | | specifies | MANDATORY |
+| | | | the memory | |
+| | | | allocation | |
+| | | | to be | |
+| | | | cognisant | |
+| | | | of the | |
+| | | | relevant | |
+| | | | process/cor | |
+| | | | e | |
+| | | | allocation. | |
+| | | | The | |
+| | | | cardinality | |
+| | | | can be 0 | |
+| | | | during the | |
+| | | | allocation | |
+| | | | request, if | |
+| | | | no | |
+| | | | particular | |
+| | | | value is | |
+| | | | requested. | |
++--------------------+-------------+------------------+-----------------+-------------------------+
+ \ No newline at end of file
diff --git a/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst b/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst
new file mode 100644
index 0000000..7f000e7
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst
@@ -0,0 +1,101 @@
+.. 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
+..
+
+Class: VirtualNetworkInterfaceRequirements
+==========================================
+
++--------------------+-------------+------------------+-----------------+--------------------------+
+| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
++====================+=============+==================+=================+==========================+
+| name | String | 0..1 | Provides a | support: |
+| | | | human | MANDATORY |
+| | | | readable | |
+| | | | name for | |
+| | | | the | |
+| | | | requirement | |
+| | | | . | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| description | String | 0..1 | Provides a | support: |
+| | | | human | MANDATORY |
+| | | | readable | |
+| | | | description | |
+| | | | of the | |
+| | | | requirement | |
+| | | | . | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| supportMand | Boolean | 1 | Indicates | support: |
+| atory | | | whether | MANDATORY |
+| | | | fulfilling | |
+| | | | the | |
+| | | | constraint | |
+| | | | is | |
+| | | | mandatory | |
+| | | | (TRUE) for | |
+| | | | successful | |
+| | | | operation | |
+| | | | or | |
+| | | | desirable | |
+| | | | (FALSE). | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| networkInte | KeyValuePai | 0..N | The network | support: |
+| rfaceRequir | r/NameValue | | interface | MANDATORY |
+| ements | Pair | | requirement | |
+| | | | s. | |
+| | | | An element | |
+| | | | from an | |
+| | | | array of | |
+| | | | key-value | |
+| | | | pairs that | |
+| | | | articulate | |
+| | | | the network | |
+| | | | interface | |
+| | | | deployment | |
+| | | | requirement | |
+| | | | s. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
+| nicIoRequir | Identifier | 0..1 | This | support: |
+| ements | (reference | | references | MANDATORY |
+| | to | | (couples) | |
+| | logicalNode | | the CPD | |
+| | Data) | | with any | |
+| | | | logical | |
+| | | | node I/O | |
+| | | | requirement | |
+| | | | s | |
+| | | | (for | |
+| | | | network | |
+| | | | devices) | |
+| | | | that may | |
+| | | | have been | |
+| | | | created. | |
+| | | | Linking | |
+| | | | these | |
+| | | | attributes | |
+| | | | is | |
+| | | | necessary | |
+| | | | so that so | |
+| | | | that I/O | |
+| | | | requirement | |
+| | | | s | |
+| | | | that need | |
+| | | | to be | |
+| | | | articulated | |
+| | | | at the | |
+| | | | logical | |
+| | | | node level | |
+| | | | can be | |
+| | | | associated | |
+| | | | with the | |
+| | | | network | |
+| | | | interface | |
+| | | | requirement | |
+| | | | s | |
+| | | | associated | |
+| | | | with the | |
+| | | | CPD. | |
++--------------------+-------------+------------------+-----------------+--------------------------+
diff --git a/docs/ONAP release 2 spec/im/virtualstoragedesc.rst b/docs/ONAP release 2 spec/im/virtualstoragedesc.rst
new file mode 100644
index 0000000..d245675
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/virtualstoragedesc.rst
@@ -0,0 +1,66 @@
+.. 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
+..
+
+Class: VirtualStorageDesc
+=========================
+
++-------------------+-------------+------------------+-----------------+-------------------------+
+| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
++===================+=============+==================+=================+=========================+
+| id | Identifier | 1 | Unique | support: |
+| | | | identifier | MANDATORY |
+| | | | of this | |
+| | | | VirtualStor | |
+| | | | ageDesc | |
+| | | | in the | |
+| | | | VNFD. | |
++-------------------+-------------+------------------+-----------------+-------------------------+
+| typeOfStora | String | 1 | Type of | support: |
+| ge | | | virtualised | MANDATORY |
+| | | | storage | |
+| | | | resource | |
+| | | | (e.g. | |
+| | | | volume, | |
+| | | | object). | |
++-------------------+-------------+------------------+-----------------+-------------------------+
+| sizeOfStora | Number | 1 | Size of | support: |
+| ge | (recommende | | virtualised | MANDATORY |
+| | d | | storage | |
+| | DM type: | | resource | |
+| | Scalar-Unit | | (e.g. size | |
+| | -Size) | | of volume, | |
+| | | | in GB). | |
++-------------------+-------------+------------------+-----------------+-------------------------+
+| vduStorageR | KeyValuePai | 0..N | An array of | support: |
+| equirements | r/NameValue | | key-value | MANDATORY |
+| | Pair | | pairs that | |
+| | | | articulate | |
+| | | | the storage | |
+| | | | deployment | |
+| | | | requirement | |
+| | | | s. | |
++-------------------+-------------+------------------+-----------------+-------------------------+
+| rdmaEnabled | Boolean | 0..1 | Indicate if | support: |
+| | | | the storage | MANDATORY |
+| | | | support | |
+| | | | RDMA. | |
++-------------------+-------------+------------------+-----------------+-------------------------+
+| swImageDesc | Identifier | 0..1 | Software | support: |
+| | (Reference | | image to be | MANDATORY |
+| | to | | loaded on | |
+| | SwImageDesc | | the | |
+| | ) | | VirtualStor | |
+| | | | age | |
+| | | | resource | |
+| | | | created | |
+| | | | based on | |
+| | | | this | |
+| | | | VirtualStor | |
+| | | | ageDesc. | |
++-------------------+-------------+------------------+-----------------+-------------------------+
+ \ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 0ba8776..4129f49 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,6 +2,14 @@
Model Specifications
====================
+ONAP 2nd release defines the resource IM/DM based on ETSI specifications and OASIS TOSCA NFV Profile
+
+.. toctree::
+ :maxdepth: 1
+
+ ONAP release 2 spec/index
+
+
ONAP 1st release is mostly the merge of ECOMP and OPEN-O, the modeling specs are also the merge from two of them, but most of them come from SDC implementation
.. toctree::
@@ -9,6 +17,8 @@ ONAP 1st release is mostly the merge of ECOMP and OPEN-O, the modeling specs are
ONAP release 1 spec/index
+
+
We list the original ECOMP and OPEN-O as the reference which could help to understand how it comes from
Below is ECOMP modeling spec: