From 10f96964015f89158941ae1f0698a6a89954ede8 Mon Sep 17 00:00:00 2001 From: guochong Date: Wed, 11 Apr 2018 09:39:48 +0800 Subject: Convert doc to rst file Issue-ID: MODELING-46 Change-Id: I1e73dcaa94365a7218421b1a9624ea051a802738 Signed-off-by: guochong --- docs/ONAP release 2 spec/im/vduprofile.rst | 170 +++++++++++++++++++++ docs/ONAP release 2 spec/im/virtualcomputedesc.rst | 67 ++++++++ docs/ONAP release 2 spec/im/virtualcpudata.rst | 96 ++++++++++++ .../im/virtuallinkdescflavour.rst | 23 +++ 4 files changed, 356 insertions(+) create mode 100644 docs/ONAP release 2 spec/im/vduprofile.rst create mode 100644 docs/ONAP release 2 spec/im/virtualcomputedesc.rst create mode 100644 docs/ONAP release 2 spec/im/virtualcpudata.rst create mode 100644 docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst diff --git a/docs/ONAP release 2 spec/im/vduprofile.rst b/docs/ONAP release 2 spec/im/vduprofile.rst new file mode 100644 index 0000000..522fa09 --- /dev/null +++ b/docs/ONAP release 2 spec/im/vduprofile.rst @@ -0,0 +1,170 @@ +.. 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: VduProfile +================= + ++--------------------+-------------+-------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+=============+===================+=================+==========================+ +| vduId | Identifier | 1 | Uniquely | support: | +| | (Reference | | identifies | MANDATORY | +| | to Vdu) | | a VDU. | | ++--------------------+-------------+-------------------+-----------------+--------------------------+ +| minNumberOf | Integer | 1 | Minimum | support: | +| Instances | | | number of | MANDATORY | +| | | | instances | | +| | | | of the VNFC | | +| | | | based on | | +| | | | this VDU | | +| | | | that is | | +| | | | permitted | | +| | | | to exist | | +| | | | for this | | +| | | | flavour. | | ++--------------------+-------------+-------------------+-----------------+--------------------------+ +| maxNumberOf | Integer | 1 | Maximum | support: | +| Instances | | | number of | MANDATORY | +| | | | instances | | +| | | | of the VNFC | | +| | | | based on | | +| | | | this VDU | | +| | | | that is | | +| | | | permitted | | +| | | | to exist | | +| | | | for this | | +| | | | flavour. | | ++--------------------+-------------+-------------------+-----------------+--------------------------+ +| localAffini | LocalAffini | 0..N | Specifies | support: | +| tyOrAntiAff | tyOrAntiAff | | affinity or | MANDATORY | +| inityRule | inityRule | | anti-affini | | +| | | | ty | | +| | | | rules | | +| | | | applicable | | +| | | | between the | | +| | | | virtualisat | | +| | | | ion | | +| | | | containers | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machines) | | +| | | | to be | | +| | | | created | | +| | | | based on | | +| | | | this VDU. | | +| | | | | | +| | | | When the | | +| | | | cardinality | | +| | | | is greater | | +| | | | than 1, | | +| | | | both | | +| | | | affinity | | +| | | | rule(s) and | | +| | | | anti-affini | | +| | | | ty | | +| | | | rule(s) | | +| | | | with | | +| | | | different | | +| | | | scopes | | +| | | | (e.g. | | +| | | | "Affinity | | +| | | | with the | | +| | | | scope | | +| | | | resource | | +| | | | zone and | | +| | | | anti-affini | | +| | | | ty | | +| | | | with the | | +| | | | scope NFVI | | +| | | | node") are | | +| | | | applicable | | +| | | | to the | | +| | | | virtualisat | | +| | | | ion | | +| | | | containers | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machines) | | +| | | | to be | | +| | | | created | | +| | | | based on | | +| | | | this VDU. | | ++--------------------+-------------+-------------------+-----------------+--------------------------+ +| affinityOrA | Identifier | 0..N | Identifier( | support: | +| ntiAffinity | | | s) | MANDATORY | +| GroupId | | | of the | | +| | | | affinity or | | +| | | | anti-affini | | +| | | | ty | | +| | | | group(s) | | +| | | | the VDU | | +| | | | belongs to. | | +| | | | | | +| | | | NOTE: Each | | +| | | | identifier | | +| | | | references | | +| | | | an affinity | | +| | | | or | | +| | | | anti-affini | | +| | | | ty | | +| | | | group which | | +| | | | expresses | | +| | | | affinity or | | +| | | | anti-affini | | +| | | | ty | | +| | | | relationshi | | +| | | | ps | | +| | | | between the | | +| | | | virtualisat | | +| | | | ion | | +| | | | container(s | | +| | | | ) | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machine(s)) | | +| | | | to be | | +| | | | created | | +| | | | using this | | +| | | | VDU and the | | +| | | | virtualisat | | +| | | | ion | | +| | | | container(s | | +| | | | ) | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machine(s)) | | +| | | | to be | | +| | | | created | | +| | | | using other | | +| | | | VDU(s) in | | +| | | | the same | | +| | | | group. | | ++--------------------+-------------+-------------------+-----------------+--------------------------+ +| watchdog | String | 0..1 | Watchdog | support: | +| | | | action to | MANDATORY | +| | | | be | | +| | | | triggered | | +| | | | by the VIM | | +| | | | for the VNF | | +| | | | in case the | | +| | | | heart beat | | +| | | | fails, e.g. | | +| | | | reset or | | +| | | | hard | | +| | | | shutdown, | | +| | | | etc. | | ++--------------------+-------------+-------------------+-----------------+--------------------------+ +| vmBootUpTim | Integer | 0..1 | Timeout | support: | +| eOut | | | value for | OPTIONAL | +| | | | the VNFM to | | +| | | | wait before | | +| | | | the | | +| | | | successful | | +| | | | booting up | | +| | | | of the VDU. | | ++--------------------+-------------+-------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/virtualcomputedesc.rst b/docs/ONAP release 2 spec/im/virtualcomputedesc.rst new file mode 100644 index 0000000..3f05570 --- /dev/null +++ b/docs/ONAP release 2 spec/im/virtualcomputedesc.rst @@ -0,0 +1,67 @@ +.. 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: VirtualComputeDesc/VirtualCompute +======================================== + ++-------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++===================+=============+==================+=================+==========================+ +| virtualComp | Identifier | 1 | Unique | support: | +| uteDescId | | | identifier | MANDATORY | +| | | | of this | | +| | | | VirtualComp | | +| | | | uteDesc | | +| | | | in the | | +| | | | VNFD. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| logicalNode | LogicalNode | 1..N | The logical | support: | +|  (logical_n | Data/Logici | | Node | MANDATORY | +| ode_id | alNodeDesc | | requirement | | +| in SOL001) | | | s. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| requestAddi | RequestedAd | 0..N | Specifies | support: | +| tionalCapab | ditionalCap | | requirement | MANDATORY | +| ilities | abilityData | | s | | +| | | | for | | +| | | | additional | | +| | | | capabilitie | | +| | | | s. | | +| | | | These may | | +| | | | be for a | | +| | | | range of | | +| | | | purposes. | | +| | | | One example | | +| | | | is | | +| | | | acceleratio | | +| | | | n | | +| | | | related | | +| | | | capabilitie | | +| | | | s. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| computeRequ | KeyValuePai | 0..N | Specifies | support: | +| irements | r/NameValue | | compute | MANDATORY | +| | Pair | | requirement | | +| | | | s. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| virtualMemo | VirtualMemo | 1 | The virtual | support: | +| ry | ryData/Virt | | memory of | MANDATORY | +| | ualMemoryDe | | the | | +| | sc | | virtualised | | +| | | | compute. | | +| | (VirtualMem | | | | +| | ory) | | | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| virtualCpu | VirtualCpuD | 1 | The virtual | support: | +| | ata/Virtual | | CPU(s) of | MANDATORY | +| | CPUDesc | | the | | +| | | | virtualised | | +| | (VirtualCpu | | compute. | | +| | ) | | | | ++-------------------+-------------+------------------+-----------------+--------------------------+ + \ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/virtualcpudata.rst b/docs/ONAP release 2 spec/im/virtualcpudata.rst new file mode 100644 index 0000000..1f8f1db --- /dev/null +++ b/docs/ONAP release 2 spec/im/virtualcpudata.rst @@ -0,0 +1,96 @@ +.. 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: VirtualCpuData/VirtualCPUDesc +==================================== + ++--------------------+-------------+------------------+-----------------+-------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+=============+==================+=================+=========================+ +| cpuArchitec | String | 0..1 | CPU | support: | +| ture | | | architectur | MANDATORY | +| | | | e | | +| | | | type. | | +| | | | Examples | | +| | | | are x86, | | +| | | | ARM. The | | +| | | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | CPU | | +| | | | architectur | | +| | | | e | | +| | | | type is | | +| | | | requested. | | ++--------------------+-------------+------------------+-----------------+-------------------------+ +| numVirtualC | Integer | 1 | Number of | support: | +| pu | | | virtual | MANDATORY | +| | | | CPUs. | | ++--------------------+-------------+------------------+-----------------+-------------------------+ +| virtualCpuC | Number | 0..1 | Minimum | support: | +| lock | (recommende | | virtual CPU | MANDATORY | +| | d | | clock rate | | +| | DM type: | | (e.g. in | | +| | Scalar-Unit | | MHz). The | | +| | -Freq) | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | value is | | +| | | | requested. | | ++--------------------+-------------+------------------+-----------------+-------------------------+ +| virtualCpuO | String | 0..1 | The CPU | support: | +| versubscrip | | | core | MANDATORY | +| tionPolicy | | | oversubscri | | +| | | | ption | | +| | | | policy e.g. | | +| | | | the | | +| | | | relation of | | +| | | | virtual CPU | | +| | | | cores to | | +| | | | physical | | +| | | | CPU | | +| | | | cores/threa | | +| | | | ds. | | +| | | | The | | +| | | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | value is | | +| | | | requested. | | ++--------------------+-------------+------------------+-----------------+-------------------------+ +| vduCpuRequi | KeyValuePai | 0..N | Array of | support: | +| rements | r/NameValue | | key-value | MANDATORY | +| | Pair | | pair | | +| | | | requirement | | +| | | | s | | +| | | | on the | | +| | | | Compute | | +| | | | (CPU) for | | +| | | | the VDU. | | ++--------------------+-------------+------------------+-----------------+-------------------------+ +| virtualCpuP | VirtualCpuP | 0..1 | The virtual | support: | +| inning | inningData | | CPU pinning | MANDATORY | +| | | | configurati | | +| | | | on | editor's | +| | | | for the | note: need | +| | | | virtualised | to check | +| | | | compute | whether can | +| | | | resource. | be optional | ++--------------------+-------------+------------------+-----------------+-------------------------+ diff --git a/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst b/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst new file mode 100644 index 0000000..aa444d8 --- /dev/null +++ b/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst @@ -0,0 +1,23 @@ +.. 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: VirtualLinkDescFlavour +============================= + ++-------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++===================+=============+==================+=================+==========================+ +| flavourId | Identifier | 1 | Identifies | support: | +| | | | a flavour | MANDATORY | +| | | | within a | | +| | | | VnfVirtualL | | +| | | | inkDesc. | | ++-------------------+-------------+------------------+-----------------+--------------------------+ +| qos | QoS | 0..1 | QoS of the | support: | +| | | | VL. | MANDATORY | ++-------------------+-------------+------------------+-----------------+--------------------------+ -- cgit 1.2.3-korg