diff options
author | 2018-05-29 11:03:21 +0800 | |
---|---|---|
committer | 2018-05-29 15:00:28 +0800 | |
commit | 3ce3ff13fd81eb8e2b872feda910747a2411d18c (patch) | |
tree | a93c7eb395a20ec01e184c733bac7cdbb7632ff5 /docs/ONAP release 2 spec/im/vnfd.rst | |
parent | d7e47624d805422dbb637f38177209ef638aa12b (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/vnfd.rst')
-rw-r--r-- | docs/ONAP release 2 spec/im/vnfd.rst | 644 |
1 files changed, 307 insertions, 337 deletions
diff --git a/docs/ONAP release 2 spec/im/vnfd.rst b/docs/ONAP release 2 spec/im/vnfd.rst index a901c75..5a8d22d 100644 --- a/docs/ONAP release 2 spec/im/vnfd.rst +++ b/docs/ONAP release 2 spec/im/vnfd.rst @@ -1,339 +1,309 @@ -.. contents:: - :depth: 3 -.. +.. 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 -Class: VNFD/VNFDesc -=================== +Class: Vnfd +=========== -+---------------------+-------------+------------------+-----------------+------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes**| -+=====================+=============+==================+=================+========================+ -| vnfdId | Identifier | 1 | Identifier | support: | -| | | | of this | MANDATORY | -| | | | VNFD | | -| | | | information | | -| | | | element. | | -| | | | This | | -| | | | attribute | | -| | | | shall be | | -| | | | globally | | -| | | | unique. | | -| | | | | | -| | | | NOTE: The | | -| | | | VNFD | | -| | | | Identifier | | -| | | | shall be | | -| | | | used as the | | -| | | | unique | | -| | | | identifier | | -| | | | of the VNF | | -| | | | Package | | -| | | | that | | -| | | | contains | | -| | | | this VNFD. | | -| | | | | | -| | | | Any | | -| | | | modificatio | | -| | | | n | | -| | | | of the | | -| | | | content of | | -| | | | the VNFD or | | -| | | | the VNF | | -| | | | Package | | -| | | | shall | | -| | | | result in a | | -| | | | new VNFD | | -| | | | Identifier. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProvider | String | 1 | Provider of | support: | -| | | | the VNF and | MANDATORY | -| | | | of the | | -| | | | VNFD. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProductN | String | 1 | Name to | support: | -| ame | | | identify | MANDATORY | -| | | | the VNF | | -| | | | Product. | | -| | | | Invariant | | -| | | | for the VNF | | -| | | | Product | | -| | | | lifetime. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfSoftware | String | 1 | Software | support: | -| Version | | | version of | MANDATORY | -| | | | the VNF. | | -| | | | This is | | -| | | | changed | | -| | | | when there | | -| | | | is any | | -| | | | change to | | -| | | | the | | -| | | | software | | -| | | | that is | | -| | | | included in | | -| | | | the VNF | | -| | | | Package. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfdVersion | String | 1 | Identifies | support: | -| | | | the version | MANDATORY | -| | | | of the | | -| | | | VNFD. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProductI | String | 0..1 | Human | support: | -| nfoName | | | readable | MANDATORY | -| | | | name for | | -| | | | the VNF | | -| | | | Product. | | -| | | | Can change | | -| | | | during the | | -| | | | VNF Product | | -| | | | lifetime. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProductI | String | 0..1 | Human | support: | -| nfoDescript | | | readable | MANDATORY | -| ion | | | description | | -| | | | of the VNF | | -| | | | Product. | | -| | | | Can change | | -| | | | during the | | -| | | | VNF Product | | -| | | | lifetime. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfmInfo | String | 0..N | Identifies | support: | -| | | | VNFM(s) | MANDATORY | -| | | | compatible | | -| | | | with the | valueRange: | -| | | | VNF | use the | -| | | | described | name of | -| | | | in this | micro-servi | -| | | | version of | ce | -| | | | the VNFD. | of the vnfm | -| | | | | drive. For | -| | | | | vendor | -| | | | | specific | -| | | | | VNFM, the | -| | | | | value | -| | | | | composes of | -| | | | | "vendorname | -| | | | | " | -| | | | | and | -| | | | | "vnfmdriver | -| | | | | ", | -| | | | | e.g. | -| | | | | "mycompanyv | -| | | | | nfmdriver"; | -| | | | | for generic | -| | | | | VNFM, the | -| | | | | value is | -| | | | | "gvnfmdrive | -| | | | | r". | -+---------------------+-------------+------------------+-----------------+------------------------+ -| localizatio | String | 0..N | Information | support: | -| nLanguage | | | about | MANDATORY | -| | | | localizatio | | -| | | | n | valueRange: | -| | | | languages | refer to | -| | | | of the VNF | ISO936 \ `h | -| | | | (includes | ttps://www. | -| | | | e.g. | iso.org/iso | -| | | | strings in | -639-langua | -| | | | the VNFD). | ge-codes.ht | -| | | | | ml <https:/ | -| | | | NOTE: This | /www.iso.or | -| | | | allows to | g/iso-639-l | -| | | | provide one | anguage-cod | -| | | | or more | es.html>`__ | -| | | | localizatio | | -| | | | n | | -| | | | languages | | -| | | | to support | | -| | | | selecting a | | -| | | | specific | | -| | | | localizatio | | -| | | | n | | -| | | | language at | | -| | | | VNF | | -| | | | instantiati | | -| | | | on | | -| | | | time. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| defaultLoca | String | 0..1 | Default | support: | -| lizationLan | | | localizatio | MANDATORY | -| guage | | | n | | -| | | | language | valueRange: | -| | | | that is | refer to | -| | | | instantiate | ISO936 \ `h | -| | | | d | ttps://www. | -| | | | if no | iso.org/iso | -| | | | information | -639-langua | -| | | | about | ge-codes.ht | -| | | | selected | ml <https:/ | -| | | | localizatio | /www.iso.or | -| | | | n | g/iso-639-l | -| | | | language is | anguage-cod | -| | | | available. | es.html>`__ | -| | | | | | -| | | | | condition: | -| | | | | Shall be | -| | | | | present if | -| | | | | "localizati | -| | | | | onLanguage" | -| | | | | is present | -| | | | | and shall | -| | | | | be absent | -| | | | | otherwise. | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vdu | VDU/VDUDesc | 1..N | Virtualisat | support: | -| | | | ion | MANDATORY | -| | | | Deployment | | -| | | | Unit. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| virtualComp | VirtualComp | 1..N | Defines | support: | -| uteDesc | uteDesc | | descriptors | MANDATORY | -| | | | of virtual | | -| | | | compute | | -| | | | resources | | -| | | | to be used | | -| | | | by the VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| virtualStor | VirtualStor | 0..N | Defines | support: | -| ageDesc | ageDesc | | descriptors | MANDATORY | -| | | | of virtual | | -| | | | storage | | -| | | | resources | | -| | | | to be used | | -| | | | by the VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| intVirtualL | VirtualLink | 0..N | Represents | support: | -| inkDesc | Desc/VnfVir | | the type of | MANDATORY | -| | tualLinkDes | | network | | -| | c | | connectivit | | -| | | | y | | -| | | | mandated by | | -| | | | the VNF | | -| | | | provider | | -| | | | between two | | -| | | | or more CPs | | -| | | | which | | -| | | | includes at | | -| | | | least one | | -| | | | internal | | -| | | | CP. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfReserved | VduCpd | 0..N | Reserved IP | support: | -| Cpd | | | Address for | MANDATORY | -| | | | VNF which | | -| | | | is not | | -| | | | bounded to | | -| | | | any | | -| | | | specific | | -| | | | VNFC, but | | -| | | | assigned | | -| | | | manually | | -| | | | from | | -| | | | outside and | | -| | | | potentially | | -| | | | shared as a | | -| | | | floating IP | | -| | | | among | | -| | | | VNFCs. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfExtCpd | VnfExtCpd/V | 1..N | Describes | support: | -| | NFExtCPDesc | | external | MANDATORY | -| | | | interface(s | | -| | | | ) | | -| | | | exposed by | | -| | | | this VNF | | -| | | | enabling | | -| | | | connection | | -| | | | with a VL. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| deploymentF | VnfDf/VNFDe | 1..N | Describes | support: | -| lavour | ploymentFla | | specific | MANDATORY | -| | vor | | DF(s) of a | | -| | | | VNF with | | -| | | | specific | | -| | | | requirement | | -| | | | s | | -| | | | for | | -| | | | capacity | | -| | | | and | | -| | | | performance | | -| | | | . | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| configurabl | VnfConfigur | 0..1 | Describes | sup port: | -| eProperties | ablePropert | | the | MAN DATORY | -| | ies | | configurabl | | -| | | | e | | -| | | | properties | | -| | | | of the VNF | | -| | | | (e.g. | | -| | | | related to | | -| | | | auto | | -| | | | scaling and | | -| | | | auto | | -| | | | healing). | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| modifiableA | VnfInfoModi | 0..1 | Describes | sup port: | -| ttributes | fiableAttri | | the | MAN DATORY | -| | butes | | modifiable | | -| | | | attributes | | -| | | | of the VNF. | | -| | | | | | -| | | | Editor's | | -| | | | note: need | | -| | | | check the | | -| | | | usage of | | -| | | | this | | -| | | | attribute | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| lifeCycleMa | LifeCycleMa | 0..N | Includes a | sup port: | -| nagementScr | nagementScr | | list of | MAN DATORY | -| ipt | ipt/LifeCyc | | events and | | -| | leManagemen | | correspondi | | -| | tOperationD | | ng | | -| | esc | | management | | -| | | | scripts | | -| | | | performed | | -| | | | for the | | -| | | | VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| elementGrou | VnfdElement | 0..N | Describes | sup port: | -| p | Group | | the | MAN DATORY | -| | | | associated | | -| | | | elements of | | -| | | | a VNFD for | | -| | | | a certain | | -| | | | purpose | | -| | | | during VNF | | -| | | | lifecycle | | -| | | | management. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfIndicato | VnfIndicato | 0..N | Declares | support: | -| r | r | | the VNF | MANDATORY | -| | | | indicators | | -| | | | that are | | -| | | | supported | | -| | | | by this | | -| | | | VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| logo | String | 0..1 | File path | support: | -| | | | of the | MANDATORY | -| | | | vendor | | -| | | | specified | | -| | | | logo. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| guide | String | 0..1 | UUID of the | support: | -| | | | vendor | MANDATORY | -| | | | guide/docum | | -| | | | entation | | -| | | | which is | | -| | | | attached to | | -| | | | VNF and can | | -| | | | be | | -| | | | downloaded | | -| | | | from the | | -| | | | model. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| | | | | | -+---------------------+-------------+------------------+-----------------+------------------------+ ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=============================+=============================+==================+=====================+======================================================+ +| vnfdId | Identifier | 1 | Identifier | support: | +| | | | of this | MANDATORY | +| | | | VNFD | | +| | | | information | | +| | | | element. | | +| | | | This | | +| | | | attribute | | +| | | | shall be | | +| | | | globally | | +| | | | unique. | | +| | | | | | +| | | | NOTE: The | | +| | | | VNFD | | +| | | | Identifier | | +| | | | shall be | | +| | | | used as the | | +| | | | unique | | +| | | | identifier | | +| | | | of the VNF | | +| | | | Package | | +| | | | that | | +| | | | contains | | +| | | | this VNFD. | | +| | | | | | +| | | | Any | | +| | | | modification | | +| | | | of the | | +| | | | content of | | +| | | | the VNFD or | | +| | | | the VNF | | +| | | | Package | | +| | | | shall | | +| | | | result in a | | +| | | | new VNFD | | +| | | | Identifier. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProvider | String | 1 | Provider of | support: | +| | | | the VNF and | MANDATORY | +| | | | of the | | +| | | | VNFD. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductName | String | 1 | Name to | support: | +| | | | identify | MANDATORY | +| | | | the VNF | | +| | | | Product. | | +| | | | Invariant | | +| | | | for the VNF | | +| | | | Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfSoftwareVersion | String | 1 | Software | support: | +| | | | version of | MANDATORY | +| | | | the VNF. | | +| | | | This is | | +| | | | changed | | +| | | | when there | | +| | | | is any | | +| | | | change to | | +| | | | the | | +| | | | software | | +| | | | that is | | +| | | | included in | | +| | | | the VNF | | +| | | | Package. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfdVersion | String | 1 | Identifies | support: | +| | | | the version | MANDATORY | +| | | | of the | | +| | | | VNFD. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductInfoName | String | 0..1 | Human | support: | +| | | | readable | MANDATORY | +| | | | name for | | +| | | | the VNF | | +| | | | Product. | | +| | | | Can change | | +| | | | during the | | +| | | | VNF Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductInfoDescription | String | 0..1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the VNF | | +| | | | Product. | | +| | | | Can change | | +| | | | during the | | +| | | | VNF Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfmInfo | String | 0..N | Identifies | support: | +| | | | VNFM(s) | MANDATORY | +| | | | compatible | | +| | | | with the | valueRange: | +| | | | VNF | use the | +| | | | described | name of | +| | | | in this | micro-service | +| | | | version of | of the vnfm | +| | | | the VNFD. | drive. For | +| | | | | vendor | +| | | | | specific | +| | | | | VNFM, the | +| | | | | value | +| | | | | composes of | +| | | | | "vendorname" | +| | | | | and | +| | | | | "vnfmdriver", | +| | | | | e.g. | +| | | | | "mycompanyvnfmdriver"; | +| | | | | for generic | +| | | | | VNFM, the | +| | | | | value is | +| | | | | "gvnfmdriver". | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| localizationLanguage | String | 0..N | Information | support: | +| | | | about | MANDATORY | +| | | | localization | | +| | | | languages | valueRange: | +| | | | | refer to | +| | | | of the VNF | ISO936 \ | +| | | | (includes | `https://www.iso.org/iso-639-language-codes.html | +| | | | e.g. | <https://www.iso.org/iso-639-language-codes.html>`__ | +| | | | strings in | | +| | | | the VNFD). | | +| | | | | | +| | | | NOTE: This | | +| | | | allows to | | +| | | | provide one | | +| | | | or more | | +| | | | localizatio | | +| | | | n | | +| | | | languages | | +| | | | to support | | +| | | | selecting a | | +| | | | specific | | +| | | | localizatio | | +| | | | n | | +| | | | language at | | +| | | | VNF | | +| | | | instantiati | | +| | | | on | | +| | | | time. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| defaultLocalizationLanguage | String | 0..1 | Default | support: | +| | | | localization | MANDATORY | +| | | | language | | +| | | | that is | valueRange: | +| | | | instantiated | refer to | +| | | | if no | ISO936 \ | +| | | | information | `https://www.iso.org/iso-639-language-codes.html | +| | | | about | <https://www.iso.org/iso-639-language-codes.html>`__ | +| | | | selected | | +| | | | localization | condition: | +| | | | language is | Shall be | +| | | | available. | present if | +| | | | | "localizationLanguage" | +| | | | | is present | +| | | | | and shall | +| | | | | be absent | +| | | | | otherwise. | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vdu | Vdu | 1..N | Virtualisation | support: | +| | | | Deployment | MANDATORY | +| | | | Unit. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| virtualComputeDesc | VirtualComputeDesc | 1..N | Defines | support: | +| | | | descriptors | MANDATORY | +| | | | of virtual | | +| | | | compute | | +| | | | resources | | +| | | | to be used | | +| | | | by the VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| virtualStorageDesc | VirtualStorageDesc | 0..N | Defines | support: | +| | | | descriptors | MANDATORY | +| | | | of virtual | | +| | | | storage | | +| | | | resources | | +| | | | to be used | | +| | | | by the VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| intVirtualLinkDesc | VirtualLinkDesc | 0..N | Represents | support: | +| | | | the type of | MANDATORY | +| | | | network | | +| | | | connectivity | | +| | | | mandated by | | +| | | | the VNF | | +| | | | provider | | +| | | | between two | | +| | | | or more CPs | | +| | | | which | | +| | | | includes at | | +| | | | least one | | +| | | | internal | | +| | | | CP. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfReservedCpd | VduCpd | 0..N | Reserved IP | support: | +| | | | Address for | MANDATORY | +| | | | VNF which | | +| | | | is not | | +| | | | bounded to | | +| | | | any | | +| | | | specific | | +| | | | VNFC, but | | +| | | | assigned | | +| | | | manually | | +| | | | from | | +| | | | outside and | | +| | | | potentially | | +| | | | shared as a | | +| | | | floating IP | | +| | | | among | | +| | | | VNFCs. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfExtCpd | VnfExtCpd | 1..N | Describes | support: | +| | | | external | MANDATORY | +| | | | interface(s) | | +| | | | exposed by | | +| | | | this VNF | | +| | | | enabling | | +| | | | connection | | +| | | | with a VL. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| deploymentFlavour | VnfDf | 1..N | Describes | support: | +| | | | specific | MANDATORY | +| | | | DF(s) of a | | +| | | | VNF with | | +| | | | specific | | +| | | | requirements | | +| | | | for | | +| | | | capacity | | +| | | | and | | +| | | | performance. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| configurableProperties | VnfConfigurableProperties | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | | configurable | | +| | | | properties | | +| | | | of the VNF | | +| | | | (e.g. | | +| | | | related to | | +| | | | auto | | +| | | | scaling and | | +| | | | auto | | +| | | | healing). | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| modifiableAttributes | VnfInfoModifiableAttributes | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | | modifiable | | +| | | | attributes | | +| | | | of the VNF. | | +| | | | | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| lifeCycleManagementScript | LifeCycleManagementScript | 0..N | Includes a | support: | +| | | | list of | MANDATORY | +| | | | events and | | +| | | | corresponding | | +| | | | management | | +| | | | scripts | | +| | | | performed | | +| | | | for the | | +| | | | VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| elementGroup | VnfdElementGroup | 0..N | Describes | support: | +| | | | the | MANDATORY | +| | | | associated | | +| | | | elements of | | +| | | | a VNFD for | | +| | | | a certain | | +| | | | purpose | | +| | | | during VNF | | +| | | | lifecycle | | +| | | | management. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfIndicator | VnfIndicator | 0..N | Declares | support: | +| | | | the VNF | MANDATORY | +| | | | indicators | | +| | | | that are | | +| | | | supported | | +| | | | by this | | +| | | | VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| logo | String | 0..1 | File path | support: | +| | | | of the | MANDATORY | +| | | | vendor | | +| | | | specified | | +| | | | logo. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| guide | String | 0..1 | UUID of the | support: | +| | | | vendor | MANDATORY | +| | | | guide/documentation | | +| | | | which is | | +| | | | attached to | | +| | | | VNF and can | | +| | | | be | | +| | | | downloaded | | +| | | | from the | | +| | | | model. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ |