summaryrefslogtreecommitdiffstats
path: root/docs/ONAP release 2 spec/im/vnfdf.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/vnfdf.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/vnfdf.rst')
-rw-r--r--docs/ONAP release 2 spec/im/vnfdf.rst426
1 files changed, 202 insertions, 224 deletions
diff --git a/docs/ONAP release 2 spec/im/vnfdf.rst b/docs/ONAP release 2 spec/im/vnfdf.rst
index f3ce578..c78de9f 100644
--- a/docs/ONAP release 2 spec/im/vnfdf.rst
+++ b/docs/ONAP release 2 spec/im/vnfdf.rst
@@ -2,231 +2,209 @@
.. 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: VnfDf
============
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
-+====================+=============+==================+===================+==========================+
-| flavorId | Identifier | 1 | Identifier | support: |
-| | | | of this DF | MANDATORY |
-| | | | within the | |
-| | | | VNFD. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| description | String | 1 | Human | support: |
-| | | | readable | MANDATORY |
-| | | | description | |
-| | | | of the DF. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| vduProfile | VduProfile | 1..N | Describes | support: |
-| | | | additional | MANDATORY |
-| | | | instantiati | |
-| | | | on | |
-| | | | data for | |
-| | | | the VDUs | |
-| | | | used in | |
-| | | | this | |
-| | | | flavor. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| virtualLink | VirtualLink | 0..N | Defines the | support: |
-| Profile | Profile | | internal | MANDATORY |
-| | | | VLD along | |
-| | | | with | |
-| | | | additional | |
-| | | | data which | |
-| | | | is used in | |
-| | | | this DF. | |
-| | | | | |
-| | | | NOTE 1: | |
-| | | | This allows | |
-| | | | for | |
-| | | | different | |
-| | | | VNF | |
-| | | | internal | |
-| | | | topologies | |
-| | | | between | |
-| | | | DFs. | |
-| | | | | |
-| | | | NOTE 2: | |
-| | | | virtualLink | |
-| | | | Profile | |
-| | | | needs to be | |
-| | | | provided | |
-| | | | for all VLs | |
-| | | | that the | |
-| | | | CPs of the | |
-| | | | VDUs in the | |
-| | | | VDU | |
-| | | | profiles | |
-| | | | connect to. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| instantiati | Instantiati | 1..N | Describes | support: |
-| onLevel | onLevel | | the various | MANDATORY |
-| | | | levels of | |
-| | | | resources | |
-| | | | that can be | |
-| | | | used to | |
-| | | | instantiate | |
-| | | | the VNF | |
-| | | | using this | |
-| | | | flavour. | |
-| | | | | |
-| | | | Examples: | |
-| | | | Small, | |
-| | | | Medium, | |
-| | | | Large. | |
-| | | | | |
-| | | | If there is | |
-| | | | only one | |
-| | | | "instantiat | |
-| | | | ionLevel" | |
-| | | | entry, it | |
-| | | | shall be | |
-| | | | treated as | |
-| | | | the default | |
-| | | | instantiati | |
-| | | | on | |
-| | | | level for | |
-| | | | this DF. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| affinityOrA | AffinityOrA | 0..N | Specifies | support: |
-| ntiAffinity | ntiAffinity | | affinity or | |
-| Group | Group | | anti-affini | MANDATORY |
-| | | | ty | |
-| | | | relationshi | |
-| | | | p | |
-| | | | applicable | |
-| | | | between the | |
-| | | | virtualisat | |
-| | | | ion | |
-| | | | containers | |
-| | | | (e.g. | |
-| | | | virtual | |
-| | | | machines) | |
-| | | | to be | |
-| | | | created | |
-| | | | using | |
-| | | | different | |
-| | | | VDUs or | |
-| | | | internal | |
-| | | | VLs to be | |
-| | | | created | |
-| | | | using | |
-| | | | different | |
-| | | | VnfVirtualL | |
-| | | | inkDesc(s) | |
-| | | | in the same | |
-| | | | affinity or | |
-| | | | anti-affini | |
-| | | | ty | |
-| | | | group. | |
-| | | | | |
-| | | | NOTE: | |
-| | | | In the | |
-| | | | present | |
-| | | | specificati | |
-| | | | on, | |
-| | | | including | |
-| | | | either | |
-| | | | VDU(s) or | |
-| | | | VnfVirtualL | |
-| | | | inkDesc(s) | |
-| | | | into the | |
-| | | | same | |
-| | | | affinity or | |
-| | | | anti-affini | |
-| | | | ty | |
-| | | | group is | |
-| | | | supported. | |
-| | | | Extension | |
-| | | | to support | |
-| | | | including | |
-| | | | both VDU(s) | |
-| | | | and | |
-| | | | VnfVirtualL | |
-| | | | inkDesc(s) | |
-| | | | into the | |
-| | | | same | |
-| | | | affinity or | |
-| | | | anti-affini | |
-| | | | ty | |
-| | | | group is | |
-| | | | left for | |
-| | | | future | |
-| | | | specificati | |
-| | | | on. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| scalingAspe | ScalingAspe | 0..N | The scaling | support: |
-| ct | ct | | aspects | |
-| | | | supported | MANDATORY |
-| | | | by this DF | |
-| | | | of the VNF. | |
-| | | | scalingAspe | |
-| | | | ct | |
-| | | | shall be | |
-| | | | present if | |
-| | | | the VNF | |
-| | | | supports | |
-| | | | scaling. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| placementGr | PlacementGr | 0..N | Determine | support: |
-| oup | oup | | where | EXPERIMENTA |
-| | | | VNFC's | L |
-| | | | (VDU's) are | |
-| | | | placed with | |
-| | | | respect to | |
-| | | | the VNF | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| baseConfigG | BaseConfigG | 0..1 |- BaseConfigGroup | support: |
-| roup | roup | | may set | EXPERIMENTA |
-| | | | Access | L |
-| | | | Control | |
-| | | | Lists | |
-| | | | (ACL's) | |
-| | | | and | |
-| | | | establish | |
-| | | | security | |
-| | | | groups | |
-| | | | and | |
-| | | | server | |
-| | | | groups. | |
-| | | | | |
-| | | |- BaseConfigGroup | |
-| | | | creates/estab | |
-| | | | lishslishs | |
-| | | | storage for the | |
-| | | | VM's (OpenStack | |
-| | | | Cinder). | |
-| | | | | |
-| | | |- BaseConfigGroup | |
-| | | | may | |
-| | | | establish | |
-| | | | internal | |
-| | | | networks | |
-| | | | such as | |
-| | | | OAM (VNF | |
-| | | | Mgmt) or | |
-| | | | MNS | |
-| | | | (Maintenance & | |
-| | | | Surveillance) | |
-| | | | established. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
-| deploymentG | DeploymentG | 1..N | DeploymentG | support: |
-| roup | roup | | roup | EXPERIMENTA |
-| | | | provides | L |
-| | | | the minimum | |
-| | | | viable VDU | |
-| | | | and | |
-| | | | associated | |
-| | | | VNFC | |
-| | | | configurati | |
-| | | | on | |
-| | | | for a | |
-| | | | useable | |
-| | | | VNF. | |
-+--------------------+-------------+------------------+-------------------+--------------------------+
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
++============================+=============================+==================+=======================+==========================+
+| flavorId | Identifier | 1 | Identifier | support: |
+| | | | of this DF | MANDATORY |
+| | | | within the | |
+| | | | VNFD. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| description | String | 1 | Human | support: |
+| | | | readable | MANDATORY |
+| | | | description | |
+| | | | of the DF. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| vduProfile | VduProfile | 1..N | Describes | support: |
+| | | | additional | MANDATORY |
+| | | | instantiation | |
+| | | | data for | |
+| | | | the VDUs | |
+| | | | used in | |
+| | | | this | |
+| | | | flavor. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| virtualLinkProfile | VirtualLinkProfile | 0..N | Defines the | support: |
+| | | | internal | MANDATORY |
+| | | | VLD along | |
+| | | | with | |
+| | | | additional | |
+| | | | data which | |
+| | | | is used in | |
+| | | | this DF. | |
+| | | | | |
+| | | | NOTE 1: | |
+| | | | This allows | |
+| | | | for | |
+| | | | different | |
+| | | | VNF | |
+| | | | internal | |
+| | | | topologies | |
+| | | | between | |
+| | | | DFs. | |
+| | | | | |
+| | | | NOTE 2: | |
+| | | | virtualLink | |
+| | | | Profile | |
+| | | | needs to be | |
+| | | | provided | |
+| | | | for all VLs | |
+| | | | that the | |
+| | | | CPs of the | |
+| | | | VDUs in the | |
+| | | | VDU | |
+| | | | profiles | |
+| | | | connect to. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| instantiationLevel | InstantiationLevel | 1..N | Describes | support: |
+| | | | the various | MANDATORY |
+| | | | levels of | |
+| | | | resources | |
+| | | | that can be | |
+| | | | used to | |
+| | | | instantiate | |
+| | | | the VNF | |
+| | | | using this | |
+| | | | flavour. | |
+| | | | | |
+| | | | Examples: | |
+| | | | Small, | |
+| | | | Medium, | |
+| | | | Large. | |
+| | | | | |
+| | | | If there is | |
+| | | | only one | |
+| | | | "instantiationLevel" | |
+| | | | entry, it | |
+| | | | shall be | |
+| | | | treated as | |
+| | | | the default | |
+| | | | instantiation | |
+| | | | level for | |
+| | | | this DF. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| affinityOrAntiAffinityGroup| AffinityOrAntiAffinityGroup | 0..N | Specifies | support: |
+| | | | affinity or | MANDATORY |
+| | | | anti-affinity | |
+| | | | relationship | |
+| | | | applicable | |
+| | | | between the | |
+| | | | virtualisation | |
+| | | | containers | |
+| | | | (e.g. | |
+| | | | virtual | |
+| | | | machines) | |
+| | | | to be | |
+| | | | created | |
+| | | | using | |
+| | | | different | |
+| | | | VDUs or | |
+| | | | internal | |
+| | | | VLs to be | |
+| | | | created | |
+| | | | using | |
+| | | | different | |
+| | | | VnfVirtualLinkDesc(s) | |
+| | | | in the same | |
+| | | | affinity or | |
+| | | | anti-affinity | |
+| | | | group. | |
+| | | | | |
+| | | | NOTE: | |
+| | | | In the | |
+| | | | present | |
+| | | | specification, | |
+| | | | including | |
+| | | | either | |
+| | | | VDU(s) or | |
+| | | | VnfVirtualLinkDesc(s) | |
+| | | | into the | |
+| | | | same | |
+| | | | affinity or | |
+| | | | anti-affinity | |
+| | | | group is | |
+| | | | supported. | |
+| | | | Extension | |
+| | | | to support | |
+| | | | including | |
+| | | | both VDU(s) | |
+| | | | and | |
+| | | | VnfVirtualLinkDesc(s) | |
+| | | | into the | |
+| | | | same | |
+| | | | affinity or | |
+| | | | anti-affinity | |
+| | | | group is | |
+| | | | left for | |
+| | | | future | |
+| | | | specification. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| scalingAspect | ScalingAspect | 0..N | The scaling | support: |
+| | | | aspects | MANDATORY |
+| | | | supported | |
+| | | | by this DF | |
+| | | | of the VNF. | |
+| | | | scalingAspect | |
+| | | | shall be | |
+| | | | present if | |
+| | | | the VNF | |
+| | | | supports | |
+| | | | scaling. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| placementGroup | PlacementGroup | 0..N | Determine | support: |
+| | | | where | EXPERIMENTAL |
+| | | | VNFC's | |
+| | | | (VDU's) are | |
+| | | | placed with | |
+| | | | respect to | |
+| | | | the VNF | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| baseConfigGroup | BaseConfigGroup | 0..1 |- BaseConfigGroup | support: |
+| | | | may set | EXPERIMENTAL |
+| | | | Access | |
+| | | | Control | |
+| | | | Lists | |
+| | | | (ACL's) | |
+| | | | and | |
+| | | | establish | |
+| | | | security | |
+| | | | groups | |
+| | | | and | |
+| | | | server | |
+| | | | groups. | |
+| | | | | |
+| | | |- BaseConfigGroup | |
+| | | | creates/establishs | |
+| | | | storage for the | |
+| | | | VM's (OpenStack | |
+| | | | Cinder). | |
+| | | | | |
+| | | |- BaseConfigGroup | |
+| | | | may | |
+| | | | establish | |
+| | | | internal | |
+| | | | networks | |
+| | | | such as | |
+| | | | OAM (VNF | |
+| | | | Mgmt) or | |
+| | | | MNS | |
+| | | | (Maintenance & | |
+| | | | Surveillance) | |
+| | | | established. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
+| deploymentGroup | DeploymentGroup | 1..N | DeploymentGroup | support: |
+| | | | provides | EXPERIMENTAL |
+| | | | the minimum | |
+| | | | viable VDU | |
+| | | | and | |
+| | | | associated | |
+| | | | VNFC | |
+| | | | configuration | |
+| | | | for a | |
+| | | | useable | |
+| | | | VNF. | |
++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
\ No newline at end of file