From 0313f31618f6edb75ea7b1da8fad486f936d6981 Mon Sep 17 00:00:00 2001 From: guochong Date: Thu, 12 Apr 2018 14:12:37 +0800 Subject: Convert wiki page to rst files Issue-ID: MODELING-46 Change-Id: I062a39412205e140ff046896eef6e06e579f8498 Signed-off-by: guochong --- docs/ONAP release 2 spec/im/cpd.rst | 118 +++++++++++++++++++++ docs/ONAP release 2 spec/im/instantiationlevel.rst | 101 ++++++++++++++++++ .../im/linkbitraterequirements.rst | 58 ++++++++++ docs/ONAP release 2 spec/im/logicalnodedata.rst | 60 +++++++++++ 4 files changed, 337 insertions(+) create mode 100644 docs/ONAP release 2 spec/im/cpd.rst create mode 100644 docs/ONAP release 2 spec/im/instantiationlevel.rst create mode 100644 docs/ONAP release 2 spec/im/linkbitraterequirements.rst create mode 100644 docs/ONAP release 2 spec/im/logicalnodedata.rst diff --git a/docs/ONAP release 2 spec/im/cpd.rst b/docs/ONAP release 2 spec/im/cpd.rst new file mode 100644 index 0000000..f004b6b --- /dev/null +++ b/docs/ONAP release 2 spec/im/cpd.rst @@ -0,0 +1,118 @@ +.. 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: Cpd/CPDesc +================= + ++--------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+=============+==================+=================+==========================+ +| cpdId | Identifier | 1 | Identifier | support: | +| | | | of this Cpd | MANDATORY | +| | | | information | | +| | | | element. | | ++--------------------+-------------+------------------+-----------------+--------------------------+ +| cpRole | String | 0..1 | Identifies | support: | +| | | | the role of | MANDATORY | +| | | | the port in | | +| | | | the context | | +| | | | of the | | +| | | | traffic | | +| | | | flow | | +| | | | patterns in | | +| | | | the VNF or | | +| | | | parent NS. | | +| | | | | | +| | | | For example | | +| | | | a VNF with | | +| | | | a tree flow | | +| | | | pattern | | +| | | | within the | | +| | | | VNF will | | +| | | | have legal | | +| | | | cpRoles of | | +| | | | ROOT and | | +| | | | LEAF. | | ++--------------------+-------------+------------------+-----------------+--------------------------+ +| description | String | 0..1 | Provides | support: | +| | | | human-reada | MANDATORY | +| | | | ble | | +| | | | information | | +| | | | on the | | +| | | | purpose of | | +| | | | the CP | | +| | | | (e.g. CP | | +| | | | for control | | +| | | | plane | | +| | | | traffic). | | ++--------------------+-------------+------------------+-----------------+--------------------------+ +| cpProtocol | CpProtocolD | 1..N | Identifies | support: | +| | ata | | the | MANDATORY | +| | | | protocol | | +| | | | layering | | +| | | | information | | +| | | | the CP uses | | +| | | | for | | +| | | | connectivit | | +| | | | y | | +| | | | purposes | | +| | | | and | | +| | | | associated | | +| | | | information | | +| | | | . | | +| | | | There shall | | +| | | | be one | | +| | | | cpProtocol | | +| | | | for each | | +| | | | layer | | +| | | | protocol as | | +| | | | indicated | | +| | | | by the | | +| | | | attribute | | +| | | | layerProtoc | | +| | | | ol. | | +| | | | | | +| | | | Editor's | | +| | | | note: the | | +| | | | attribute | | +| | | | "layerProto | | +| | | | col" | | +| | | | still needs | | +| | | | further | | +| | | | discussion | | +| | | | and not | | +| | | | included in | | +| | | | this table. | | ++--------------------+-------------+------------------+-----------------+--------------------------+ +| trunkMode | Boolean | 1 | Information | support: | +| | | | about | MANDATORY | +| | | | whether the | | +| | | | CP | | +| | | | instantiate | | +| | | | d | | +| | | | from this | | +| | | | CPD is in | | +| | | | Trunk mode | | +| | | | (802.1Q or | | +| | | | other). | | ++--------------------+-------------+------------------+-----------------+--------------------------+ +| allowedAddr | AddressData | 0..N | For | support: | +| essData | | | specifying | MANDATORY | +| | | | floating | | +| | | | IP(s) to be | | +| | | | shared | | +| | | | among Cpds, | | +| | | | which are | | +| | | | reserved | | +| | | | for | | +| | | | vnfReserved | | +| | | | Cpd | | +| | | | described | | +| | | | in the | | +| | | | VNFD. | | ++--------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/instantiationlevel.rst b/docs/ONAP release 2 spec/im/instantiationlevel.rst new file mode 100644 index 0000000..dd4c18e --- /dev/null +++ b/docs/ONAP release 2 spec/im/instantiationlevel.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: InstantiationLevel +========================= + ++-------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++===================+=============+==================+=================+==========================+ +| levelId | Identifier | 1 | Uniquely | support: | +| | | | identifies | MANDATORY | +| | | | a level | | +| | | | with the | | +| | | | DF. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| description | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the | | +| | | | level. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| vduLevel | VduLevel | 1..N | Indicates | support: | +| | | | the number | MANDATORY | +| | | | of instance | | +| | | | of this VDU | | +| | | | to deploy | | +| | | | for this | | +| | | | level. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| virtualLink | VirtualLink | 0..N | Specifies | support: | +| BitRateLeve | BitRateLeve | | bitrate | MANDATORY | +| l | l | | requirement | | +| | | | s | | +| | | | applicable | | +| | | | to virtual | | +| | | | links | | +| | | | created | | +| | | | from | | +| | | | particular | | +| | | | virtual | | +| | | | link | | +| | | | descriptors | | +| | | | for this | | +| | | | level. | | +| | | | | | +| | | | NOTE: If | | +| | | | not | | +| | | | present, it | | +| | | | is assumed | | +| | | | that the | | +| | | | bitrate | | +| | | | requirement | | +| | | | s | | +| | | | can be | | +| | | | derived | | +| | | | from those | | +| | | | specified | | +| | | | in the | | +| | | | VduCpd | | +| | | | instances | | +| | | | applicable | | +| | | | to the | | +| | | | internal | | +| | | | VL. If | | +| | | | present in | | +| | | | both the | | +| | | | Instantiati | | +| | | | onLevel | | +| | | | and the | | +| | | | VduCpd | | +| | | | instances | | +| | | | applicable | | +| | | | to the | | +| | | | internal | | +| | | | VL, the | | +| | | | highest | | +| | | | value takes | | +| | | | precedence. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| scaleInfo | ScaleInfo | 0..N | Represents | support: | +| | | | for each | MANDATORY | +| | | | aspect the | | +| | | | scale level | | +| | | | that | | +| | | | corresponds | | +| | | | to this | | +| | | | instantiati | | +| | | | on | | +| | | | level. | | +| | | | scaleInfo | | +| | | | shall be | | +| | | | present if | | +| | | | the VNF | | +| | | | supports | | +| | | | scaling. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/linkbitraterequirements.rst b/docs/ONAP release 2 spec/im/linkbitraterequirements.rst new file mode 100644 index 0000000..154f9d3 --- /dev/null +++ b/docs/ONAP release 2 spec/im/linkbitraterequirements.rst @@ -0,0 +1,58 @@ +.. 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: LinkBitrateRequirements +============================== + ++--------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+=============+==================+=================+==========================+ +| root | Number | 1 | Throughput | support: | +| | | | requirement | MANDATORY | +| | | | of the | | +| | | | link (e.g. | | +| | | | bitrate of | | +| | | | E-Line, | | +| | | | root | | +| | | | bitrate of | | +| | | | E-Tree, | | +| | | | aggregate | | +| | | | capacity of | | +| | | | E-LAN). | | ++--------------------+-------------+------------------+-----------------+--------------------------+ +| leaf | Number | 0..1 | Throughput | support: | +| | | | requirement | MANDATORY | +| | | | of leaf | | +| | | | connections | | +| | | | to the link | | +| | | | when | | +| | | | applicable | | +| | | | to the | | +| | | | connectivit | | +| | | | y | | +| | | | type (e.g. | | +| | | | for E-Tree | | +| | | | and E?LAN | | +| | | | branches). | | +| | | | | | +| | | | NOTE: The | | +| | | | present | | +| | | | document | | +| | | | does not | | +| | | | specify the | | +| | | | means to | | +| | | | declare | | +| | | | different | | +| | | | bitrate | | +| | | | requirement | | +| | | | s | | +| | | | for leaf | | +| | | | connections | | +| | | | (e.g. E-LAN | | +| | | | leaves). | | ++--------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/logicalnodedata.rst b/docs/ONAP release 2 spec/im/logicalnodedata.rst new file mode 100644 index 0000000..1500dfa --- /dev/null +++ b/docs/ONAP release 2 spec/im/logicalnodedata.rst @@ -0,0 +1,60 @@ +.. 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: LogicalNodeData/LogicalNodeDesc +====================================== + ++--------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+=============+==================+=================+==========================+ +| logicalNode | KeyValuePai | 0..N | The logical | support: | +| Requirement | r/NameValue | | node-level | MANDATORY | +| s | Pair | | compute, | | +| | | | memory and | | +| | | | I/O | | +| | | | requirement | | +| | | | s. | | +| | | | An array of | | +| | | | key-value | | +| | | | pairs that | | +| | | | articulate | | +| | | | the | | +| | | | deployment | | +| | | | requirement | | +| | | | s. | | +| | | | | | +| | | | This could | | +| | | | include the | | +| | | | number of | | +| | | | CPU cores | | +| | | | on this | | +| | | | logical | | +| | | | node, a | | +| | | | memory | | +| | | | configurati | | +| | | | on | | +| | | | specific to | | +| | | | a logical | | +| | | | node (e.g. | | +| | | | such as | | +| | | | available | | +| | | | in the | | +| | | | Linux | | +| | | | kernel via | | +| | | | the libnuma | | +| | | | library) or | | +| | | | a | | +| | | | requirement | | +| | | | related to | | +| | | | the | | +| | | | association | | +| | | | of an I/O | | +| | | | device with | | +| | | | the logical | | +| | | | node. | | ++--------------------+-------------+------------------+-----------------+--------------------------+ -- cgit 1.2.3-korg