summaryrefslogtreecommitdiffstats
path: root/docs/ONAP release 2 spec/im/vdu.rst
diff options
context:
space:
mode:
authorguochuyi <guochuyi@chinamobile.com>2018-05-29 11:03:21 +0800
committerguochuyi <guochuyi@chinamobile.com>2018-05-29 15:00:28 +0800
commit3ce3ff13fd81eb8e2b872feda910747a2411d18c (patch)
treea93c7eb395a20ec01e184c733bac7cdbb7632ff5 /docs/ONAP release 2 spec/im/vdu.rst
parentd7e47624d805422dbb637f38177209ef638aa12b (diff)
Convert doc and pdf document to rst format.
Change-Id: Ib131e30084d777b81e5fd12986fabdfe21a802c7 Issue-ID: MODELING-46 Signed-off-by: guochuyi <guochuyi@chinamobile.com>
Diffstat (limited to 'docs/ONAP release 2 spec/im/vdu.rst')
-rw-r--r--docs/ONAP release 2 spec/im/vdu.rst415
1 files changed, 195 insertions, 220 deletions
diff --git a/docs/ONAP release 2 spec/im/vdu.rst b/docs/ONAP release 2 spec/im/vdu.rst
index 3d74c59..f83ed43 100644
--- a/docs/ONAP release 2 spec/im/vdu.rst
+++ b/docs/ONAP release 2 spec/im/vdu.rst
@@ -2,225 +2,200 @@
.. 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: Vdu
+==========
-Class: VDU/VDUDesc
-==================
-
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
-+===================+=============+==================+=================+=========================+
-| vduId | Identifier | 1 | Unique | support: |
-| | | | identifier | MANDATORY |
-| | | | of this Vdu | |
-| | | | in VNFD. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| name | String | 1 | Human | support: |
-| | | | readable | MANDATORY |
-| | | | name of the | |
-| | | | Vdu. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| description | String | 1 | Human | support: |
-| | | | readable | MANDATORY |
-| | | | description | |
-| | | | of the Vdu. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| vduCpd | VduCpd/VDUC | 1..N | Describes | support: |
-| | PDesc | | network | MANDATORY |
-| | | | connectivit | |
-| | | | y | |
-| | | | between a | |
-| | | | VNFC | |
-| | | | instance | |
-| | | | (based on | |
-| | | | this Vdu) | |
-| | | | and an | |
-| | | | Virtual | |
-| | | | Link (VL). | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| virtualComp | Identifier | 1 | Describes | support: |
-| uteDesc | (reference | | CPU, Memory | MANDATORY |
-| | to | | and | |
-| | VirtualComp | | acceleratio | |
-| | uteDesc) | | n | |
-| | | | requirement | |
-| | | | s | |
-| | | | of the | |
-| | | | Virtualisat | |
-| | | | ion | |
-| | | | Container | |
-| | | | realising | |
-| | | | this Vdu. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| virtualStor | Identifier | 0..N | Describes | support: |
-| ageDesc | (reference | | storage | MANDATORY |
-| | to | | requirement | |
-| | VirtualStor | | s | |
-| | ageDesc) | | for a | |
-| | | | VirtualStor | |
-| | | | age | |
-| | | | instance | |
-| | | | attached to | |
-| | | | the | |
-| | | | virtualisat | |
-| | | | ion | |
-| | | | container | |
-| | | | created | |
-| | | | from | |
-| | | | virtualComp | |
-| | | | uteDesc | |
-| | | | defined for | |
-| | | | this Vdu. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| bootOrder | KeyValuePai | 0..N | Boot order | support: |
-| | r/NameValue | | of valid | MANDATORY |
-| | Pair | | boot | |
-| | | | devices. | valueRange: |
-| | | | | "key/name" |
-| | | | NOTE: If no | indicates |
-| | | | boot order | the the |
-| | | | is defined | boot index |
-| | | | the default | (lowest |
-| | | | boot order | index |
-| | | | defined in | defines |
-| | | | the VIM or | highest |
-| | | | NFVI shall | boot |
-| | | | be used. | priority). |
-| | | | | "value" |
-| | | | | references |
-| | | | | a |
-| | | | | descriptor |
-| | | | | from which |
-| | | | | a valid |
-| | | | | boot device |
-| | | | | is created |
-| | | | | e.g. |
-| | | | | VirtualStor |
-| | | | | ageDesc |
-| | | | | from which |
-| | | | | a |
-| | | | | VirtualStor |
-| | | | | age |
-| | | | | instance is |
-| | | | | created. |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| swImageDesc | SwImageDesc | 0..1 | Describes | support: |
-| | | | the | MANDATORY |
-| | | Editor's | software | |
-| | | note: the | image which | |
-| | | scenario of | is directly | |
-| | | using "0" | loaded on | |
-| | | needs to be | the | |
-| | | clarified. | virtualisat | |
-| | | | ion | |
-| | | | container | |
-| | | | realising | |
-| | | | this Vdu. | |
-| | | | | |
-| | | | NOTE: More | |
-| | | | software | |
-| | | | images can | |
-| | | | be attached | |
-| | | | to the | |
-| | | | virtualisat | |
-| | | | ion | |
-| | | | container | |
-| | | | using | |
-| | | | VirtualStor | |
-| | | | age | |
-| | | | resources. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| nfviConstra | KeyValuthae | 0..N | Describes | support: |
-| int | Pair/NameVa | | constraints | MANDATORY |
-| | luePair | | on the NFVI | |
-| | | | for the | valueRange: |
-| | | | VNFC | "key/name" |
-| | | | instance(s) | includes |
-| | | | created | "Availabili |
-| | | | from this | tyZone", |
-| | | | Vdu. For | "HostAggreg |
-| | | | example, | ates". |
-| | | | aspects of | |
-| | | | a secure | |
-| | | | hosting | |
-| | | | environment | |
-| | | | for the | |
-| | | | VNFC | |
-| | | | instance | |
-| | | | that | |
-| | | | involve | |
-| | | | additional | |
-| | | | entities or | |
-| | | | processes. | |
-| | | | | |
-| | | | NOTE: These | |
-| | | | are | |
-| | | | constraints | |
-| | | | other than | |
-| | | | stipulating | |
-| | | | that a VNFC | |
-| | | | instance | |
-| | | | has access | |
-| | | | to a | |
-| | | | certain | |
-| | | | resource, | |
-| | | | as a | |
-| | | | prerequisit | |
-| | | | e | |
-| | | | to | |
-| | | | instantiati | |
-| | | | on. | |
-| | | | The | |
-| | | | attributes | |
-| | | | virtualComp | |
-| | | | uteDesc | |
-| | | | and | |
-| | | | virtualStor | |
-| | | | ageDesc | |
-| | | | define the | |
-| | | | resources | |
-| | | | required | |
-| | | | for | |
-| | | | instantiati | |
-| | | | on | |
-| | | | of the VNFC | |
-| | | | instance. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| monitoringP | MonitoringP | 0..N | Defines the | support: |
-| arameter | arameter | | virtualised | MANDATORY |
-| | | | resources | |
-| | | | monitoring | |
-| | | | parameters | |
-| | | | on VDU | |
-| | | | level. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| configurabl | VnfcConfigu | 1 | Describes | support: |
-| eProperties | rableProper | | the | MANDATORY |
-| | ties | | configurabl | |
-| | | | e | |
-| | | | properties | |
-| | | | of all VNFC | |
-| | | | instances | |
-| | | | based on | |
-| | | | this VDU. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| injectFiles | String | 0..N | Describes | support: |
-| | | | the | MANDATORY |
-| | | | information | |
-| | | | (e.g. URL) | |
-| | | | about the | |
-| | | | scripts, | |
-| | | | config | |
-| | | | drive | |
-| | | | metadata, | |
-| | | | etc. which | |
-| | | | can be used | |
-| | | | during Vdu | |
-| | | | booting | |
-| | | | process. | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
-| | | | | |
-+-------------------+-------------+------------------+-----------------+-------------------------+
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
++=======================+===========================+==================+====================+=========================+
+| vduId | Identifier | 1 | Unique | support: |
+| | | | identifier | MANDATORY |
+| | | | of this Vdu | |
+| | | | in VNFD. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| name | String | 1 | Human | support: |
+| | | | readable | MANDATORY |
+| | | | name of the | |
+| | | | Vdu. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| description | String | 1 | Human | support: |
+| | | | readable | MANDATORY |
+| | | | description | |
+| | | | of the Vdu. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| vduCpd | VduCpd | 1..N | Describes | support: |
+| | | | network | MANDATORY |
+| | | | connectivity | |
+| | | | between a | |
+| | | | VNFC | |
+| | | | instance | |
+| | | | (based on | |
+| | | | this Vdu) | |
+| | | | and an | |
+| | | | Virtual | |
+| | | | Link (VL). | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| virtualComputeDesc | Identifier | 1 | Describes | support: |
+| | (reference | | CPU, Memory | MANDATORY |
+| | to | | and | |
+| | VirtualComputeDesc) | | acceleration | |
+| | | | requirements | |
+| | | | of the | |
+| | | | Virtualisation | |
+| | | | Container | |
+| | | | realising | |
+| | | | this Vdu. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| virtualStorageDesc | Identifier | 0..N | Describes | support: |
+| | (reference | | storage | MANDATORY |
+| | to | | requirements | |
+| | VirtualStorageDesc) | | for a | |
+| | | | VirtualStorage | |
+| | | | instance | |
+| | | | attached to | |
+| | | | the | |
+| | | | virtualisation | |
+| | | | container | |
+| | | | created | |
+| | | | from | |
+| | | | virtualComputeDesc | |
+| | | | defined for | |
+| | | | this Vdu. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| bootOrder | KeyValuePair | 0..N | Boot order | support: |
+| | | | of valid | MANDATORY |
+| | | | boot | |
+| | | | devices. | valueRange: |
+| | | | | "key/name" |
+| | | | NOTE: If no | indicates |
+| | | | boot order | the the |
+| | | | is defined | boot index |
+| | | | the default | (lowest |
+| | | | boot order | index |
+| | | | defined in | defines |
+| | | | the VIM or | highest |
+| | | | NFVI shall | boot |
+| | | | be used. | priority). |
+| | | | | "value" |
+| | | | | references |
+| | | | | a |
+| | | | | descriptor |
+| | | | | from which |
+| | | | | a valid |
+| | | | | boot device |
+| | | | | is created |
+| | | | | e.g. |
+| | | | | VirtualStorageDesc |
+| | | | | from which |
+| | | | | a |
+| | | | | VirtualStorage |
+| | | | | instance is |
+| | | | | created. |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| swImageDesc | SwImageDesc | 0..1 | Describes | support: |
+| | | | the | MANDATORY |
+| | | Editor's | software | |
+| | | note: the | image which | |
+| | | scenario of | is directly | |
+| | | using "0" | loaded on | |
+| | | needs to be | the | |
+| | | clarified. | virtualisation | |
+| | | | container | |
+| | | | realising | |
+| | | | this Vdu. | |
+| | | | | |
+| | | | NOTE: More | |
+| | | | software | |
+| | | | images can | |
+| | | | be attached | |
+| | | | to the | |
+| | | | virtualisation | |
+| | | | container | |
+| | | | using | |
+| | | | VirtualStorage | |
+| | | | resources. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| nfviConstraint | KeyValuePair | 0..N | Describes | support: |
+| | | | constraints | MANDATORY |
+| | | | on the NFVI | |
+| | | | for the | valueRange: |
+| | | | VNFC | "key/name" |
+| | | | instance(s) | includes |
+| | | | created | "AvailabilityZone", |
+| | | | from this | "HostAggregates". |
+| | | | Vdu. For | |
+| | | | example, | |
+| | | | aspects of | |
+| | | | a secure | |
+| | | | hosting | |
+| | | | environment | |
+| | | | for the | |
+| | | | VNFC | |
+| | | | instance | |
+| | | | that | |
+| | | | involve | |
+| | | | additional | |
+| | | | entities or | |
+| | | | processes. | |
+| | | | | |
+| | | | NOTE: These | |
+| | | | are | |
+| | | | constraints | |
+| | | | other than | |
+| | | | stipulating | |
+| | | | that a VNFC | |
+| | | | instance | |
+| | | | has access | |
+| | | | to a | |
+| | | | certain | |
+| | | | resource, | |
+| | | | as a | |
+| | | | prerequisite | |
+| | | | to | |
+| | | | instantiation. | |
+| | | | The | |
+| | | | attributes | |
+| | | | virtualComputeDesc | |
+| | | | and | |
+| | | | virtualStorageDesc | |
+| | | | define the | |
+| | | | resources | |
+| | | | required | |
+| | | | for | |
+| | | | instantiation | |
+| | | | of the VNFC | |
+| | | | instance. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| monitoringParameter | MonitoringParameter | 0..N | Defines the | support: |
+| | | | virtualised | MANDATORY |
+| | | | resources | |
+| | | | monitoring | |
+| | | | parameters | |
+| | | | on VDU | |
+| | | | level. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| configurableProperties| VnfcConfigurableProperties| 1 | Describes | support: |
+| | | | the | MANDATORY |
+| | | | configurable | |
+| | | | properties | |
+| | | | of all VNFC | |
+| | | | instances | |
+| | | | based on | |
+| | | | this VDU. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
+| injectFiles | String | 0..N | Describes | support: |
+| | | | the | MANDATORY |
+| | | | information | |
+| | | | (e.g. URL) | |
+| | | | about the | |
+| | | | scripts, | |
+| | | | config | |
+| | | | drive | |
+| | | | metadata, | |
+| | | | etc. which | |
+| | | | can be used | |
+| | | | during Vdu | |
+| | | | booting | |
+| | | | process. | |
++-----------------------+---------------------------+------------------+--------------------+-------------------------+
\ No newline at end of file