diff options
Diffstat (limited to 'docs/ONAP Model Spec')
43 files changed, 3936 insertions, 3043 deletions
diff --git a/docs/ONAP Model Spec/im/AddressData.rst b/docs/ONAP Model Spec/im/AddressData.rst deleted file mode 100644 index a3e703d..0000000 --- a/docs/ONAP Model Spec/im/AddressData.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. 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: AddressData -================== - -+---------------+---------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===============+===============+==================+=================+===============+ -| addressType | Identifier | 1 | Describes | support: | -| | | | the type of | MANDATORY | -| | | | the address to | | -| | | | be assigned to | | -| | | | the CP | | -| | | | instantiated | | -| | | | from the | | -| | | | parent CPD. | | -| | | | The content | | -| | | | type shall | | -| | | | be aligned | | -| | | | with the | | -| | | | address type | | -| | | | supported | | -| | | | by the | | -| | | | layerProtocol | | -| | | | attribute | | -| | | | of the | | -| | | | parent CPD. | | -+---------------+---------------+------------------+-----------------+---------------+ -| l2AddressData | L2AddressData | 0..1 | Provides the | support: | -| | | | information on | MANDATORY | -| | | | the MAC | | -| | | | addresses to be | | -| | | | assigned to | | -| | | | the CP(s) | | -| | | | instantiated | | -| | | | from the | | -| | | | parent CPD. | | -| | | | | | -| | | | Shall be present| | -| | | | when the | | -| | | | addressType is | | -| | | | MAC address. | | -+---------------+---------------+------------------+-----------------+---------------+ -| l3AddressData | L3AddressData | 0..1 | Provides the | support: | -| | | | information on | MANDATORY | -| | | | the IP addresses| | -| | | | to be assigned | | -| | | | to the CP | | -| | | | instantiated | | -| | | | from the | | -| | | | parent CPD. | | -| | | | | | -| | | | Shall be | | -| | | | present when | | -| | | | the addressType | | -| | | | is IP address. | | -+---------------+---------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst b/docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst deleted file mode 100644 index a2c8d72..0000000 --- a/docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. 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: AffinityOrAntiAffinityGroup -================================== - -+-------------+-------------+------------------+-----------------+-----------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=============+=============+==================+=================+=================+ -| groupId | Identifier | 1 | Identifies | support: | -| | | | an affinity or | MANDATORY | -| | | | anti-affinity | | -| | | | group to which | | -| | | | the affinity or | | -| | | | anti-affinity | | -| | | | rule applies. | | -+-------------+-------------+------------------+-----------------+-----------------+ -| type | Enum | 1 | Specifies | support: | -| | | | whether the rule| MANDATORY | -| | | | is an affinity | | -| | | | rule or an | valueRange: | -| | | | anti-affinity | "Affinity", | -| | | | rule. | "Anti-Affinity" | -+-------------+-------------+------------------+-----------------+-----------------+ -| scope | Enum | 1 | Specifies | support: | -| | | | the scope | MANDATORY | -| | | | of the rule. | | -| | | | | valueRange: | -| | | | | "NFVI-PoP", | -| | | | | "Zone", | -| | | | | "ZoneGroup", | -| | | | | "NFVI-node" | -+-------------+-------------+------------------+-----------------+-----------------+ diff --git a/docs/ONAP Model Spec/im/BaseConfigGroup.rst b/docs/ONAP Model Spec/im/BaseConfigGroup.rst deleted file mode 100644 index 2397c0e..0000000 --- a/docs/ONAP Model Spec/im/BaseConfigGroup.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. 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: BaseConfigGroup (Experimental) -===================================== diff --git a/docs/ONAP Model Spec/im/ConnectivityType.rst b/docs/ONAP Model Spec/im/ConnectivityType.rst deleted file mode 100644 index d47a1be..0000000 --- a/docs/ONAP Model Spec/im/ConnectivityType.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. 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: ConnectivityType -======================= - -+---------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===============+=============+==================+=================+===============+ -| layerProtocol | Enum | 1 | Identifies | support: | -| | | | the protocol | MANDATORY | -| | | | this VL gives | | -| | | | access to | | -| | | | (Ethernet, | | -| | | | MPLS, ODU2, | | -| | | | IPV4, IPV6, | | -| | | | Pseudo-Wire). | | -+---------------+-------------+------------------+-----------------+---------------+ -| flowPattern | String | 0..1 | Identifies | support: | -| | | | the flow | MANDATORY | -| | | | pattern of the | | -| | | | the connectivity| | -| | | | (Line, Tree, | | -| | | | Mesh). | | -+---------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/CpProtocolData.rst b/docs/ONAP Model Spec/im/CpProtocolData.rst deleted file mode 100644 index c9cf840..0000000 --- a/docs/ONAP Model Spec/im/CpProtocolData.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. 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: CpProtocolData -===================== - -+-------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+=========================+=============+==================+=================+===============+ -| associatedLayerProtocol | Enum | 1 | One of the | support: | -| | | | values of the | MANDATORY | -| | | | attribute | | -| | | | layerProtocol | | -| | | | of the Cpd IE. | | -+-------------------------+-------------+------------------+-----------------+---------------+ -| addressData | AddressData | 0..N | Provides | support: | -| | | | information | MANDATORY | -| | | | on the addresses| | -| | | | to be | | -| | | | assigned to | | -| | | | the CP(s) | | -| | | | instantiated | | -| | | | from the CPD. | | -+-------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/DeploymentGroup.rst b/docs/ONAP Model Spec/im/DeploymentGroup.rst deleted file mode 100644 index 4dd8b1e..0000000 --- a/docs/ONAP Model Spec/im/DeploymentGroup.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. 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: DeploymentGroup (Experimental) -===================================== - -This class is experimental and the detailed definition is for further discussion. diff --git a/docs/ONAP Model Spec/im/L2AddressData.rst b/docs/ONAP Model Spec/im/L2AddressData.rst deleted file mode 100644 index d4620df..0000000 --- a/docs/ONAP Model Spec/im/L2AddressData.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. 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: L2AddressData -==================== - -+----------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+======================+=============+==================+=================+===============+ -| macAddressAssignment | Boolean | 1 | Specify if | support: | -| | | | the MAC address | MANDATORY | -| | | | assignment | | -| | | | is the | | -| | | | responsibility | | -| | | | of management | | -| | | | and | | -| | | | orchestration | | -| | | | function or not.| | -| | | | | | -| | | | If it is set to | | -| | | | True, it is the | | -| | | | management and | | -| | | | orchestration | | -| | | | function | | -| | | | responsibility. | | -| | | | | | -| | | | If it is set to | | -| | | | False, it will | | -| | | | be provided by | | -| | | | an external | | -| | | | entity, e.g. | | -| | | | OSS/BSS. | | -+----------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/L3AddressData.rst b/docs/ONAP Model Spec/im/L3AddressData.rst deleted file mode 100644 index ccb651f..0000000 --- a/docs/ONAP Model Spec/im/L3AddressData.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. 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: L3AddressData -==================== - -+---------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=====================+=============+==================+=================+===============+ -| iPAddressAssignment | Boolean | 1 | Specify if | support: | -| | | | the address | MANDATORY | -| | | | assignment | | -| | | | is the | | -| | | | responsibility | | -| | | | of management | | -| | | | and | | -| | | | orchestration | | -| | | | function or not.| | -| | | | | | -| | | | If it is set to | | -| | | | True, it is the | | -| | | | management and | | -| | | | orchestration | | -| | | | function | | -| | | | responsibility. | | -+---------------------+-------------+------------------+-----------------+---------------+ -| floatingIpActivated | Boolean | 1 | Specify if the | support: | -| | | | floating IP | MANDATORY | -| | | | scheme is | | -| | | | activated on | | -| | | | the CP or not. | | -+---------------------+-------------+------------------+-----------------+---------------+ -| iPAddressType | Enum | 0..1 | Define address | support: | -| | | | type. | MANDATORY | -| | | | | | -| | | | NOTE: The | valueRange: | -| | | | address type | "IPv4", | -| | | | should be | "IPv6" | -| | | | aligned with | | -| | | | the address type| | -| | | | supported by the| | -| | | | layerProtocol | | -| | | | attribute of | | -| | | | the parent Cpd. | | -+---------------------+-------------+------------------+-----------------+---------------+ -| numberOfIpAddress | Integer | 0..1 | Minimum | support: | -| | | | number of IP | MANDATORY | -| | | | addresses to be | | -| | | | assigned based | | -| | | | on this | | -| | | | L3AddressData | | -| | | | information | | -| | | | element. | | -+---------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/LifecycleManagementScript.rst b/docs/ONAP Model Spec/im/LifecycleManagementScript.rst deleted file mode 100644 index b7ce432..0000000 --- a/docs/ONAP Model Spec/im/LifecycleManagementScript.rst +++ /dev/null @@ -1,165 +0,0 @@ -.. 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: LifecycleManagementScript -================================ - -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+===================+=====================================+ -| event | Enum | 0..N | Describes | support: | -| | | | VNF | MANDATORY | -| | | | lifecycle | | -| | | | event(s) or | valueRange: | -| | | | an external | for | -| | | | stimulus | lifecycle | -| | | | detected on | events, | -| | | | a VNFM | include: | -| | | | reference | "EVENT_START_INSTANTIATION", | -| | | | point. | "EVENT_END_INSTANTIATION", | -| | | | | "EVENT_START_SCALING", | -| | | | NOTE: At | "EVENT_END_SCALING", | -| | | | least one | "EVENT_START_SCALING_TO_LEVEL", | -| | | | of these | "EVENT_END_SCALING_TO_LEVEL", | -| | | | two | "EVENT_START_HEALING", | -| | | | attributes | "EVENT_END_HEALING", | -| | | | shall be | "EVENT_START_TERMINATION", | -| | | | included. | "EVENT_END_TERMINATION", | -| | | | | "EVENT_START_VNF_FLAVOR_CHANGE", | -| | | | | "EVENT_END_VNF_FLAVOR_CHANGE", | -| | | | | "EVENT_START_VNF_OPERATION_CHANGE", | -| | | | | "EVENT_END_VNF_OPERATION_CHANGE", | -| | | | | "EVENT_START_VNF_EXT_CONN_CHANGE", | -| | | | | "EVENT_END_VNF_EXT_CONN_CHANGE", | -| | | | | "EVENT_START_VNFINFO_MODIFICATION", | -| | | | | "EVENT_END_VNFINFO_MODIFICATION"; | -| | | | | for | -| | | | | external | -| | | | | stimulus, | -| | | | | include: | -| | | | | receipt of | -| | | | | request | -| | | | | message of | -| | | | | instantiation, | -| | | | | scaling, | -| | | | | healing, | -| | | | | termination, | -| | | | | change of | -| | | | | VNF | -| | | | | flavour, | -| | | | | change of | -| | | | | the | -| | | | | operation | -| | | | | state of | -| | | | | the VNF, | -| | | | | change of | -| | | | | external | -| | | | | VNF | -| | | | | connectivity, | -| | | | | modification | -| | | | | of VNF | -| | | | | information | -| | | | | or the | -| | | | | receipt of | -| | | | | a | -| | | | | notification | -| | | | | regarding | -| | | | | the change | -| | | | | of a VNF | -| | | | | indicator | -| | | | | value. | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| lcmTransitionEvent | String | 0..N | Describes | support: | -| | | | the | MANDATORY | -| | | | transition | | -| | | | VNF | | -| | | | lifecycle | | -| | | | event(s) | | -| | | | that cannot | | -| | | | be mapped | | -| | | | to any of | | -| | | | the | | -| | | | enumerated | | -| | | | values | | -| | | | defined for | | -| | | | the event | | -| | | | attribute. | | -| | | | | | -| | | | NOTE: At | | -| | | | least one | | -| | | | of these | | -| | | | two | | -| | | | attributes | | -| | | | shall be | | -| | | | included. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| script | String | 1 | Information | support: | -| | | | to locate a | MANDATORY | -| | | | VNF LCM | | -| | | | script | | -| | | | (e.g. | | -| | | | written in | | -| | | | a DSL as | | -| | | | specified | | -| | | | in | | -| | | | requirement | | -| | | | VNF_PACK.LCM.001) | | -| | | | triggered | | -| | | | to react to | | -| | | | one of the | | -| | | | events | | -| | | | listed in | | -| | | | the event | | -| | | | attribute. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| scriptDsl | String | 1 | Defines the | support: | -| | | | domain | MANDATORY | -| | | | specific | | -| | | | language | | -| | | | (i.e. the | | -| | | | type) of | | -| | | | script that | | -| | | | is | | -| | | | provided. | | -| | | | Types of | | -| | | | scripts | | -| | | | could | | -| | | | include | | -| | | | bash, | | -| | | | python, | | -| | | | etc. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| scriptInput | KeyValuePair| 0..N | Array of | support: | -| | | | KVP | MANDATORY | -| | | | requirements | | -| | | | with the | | -| | | | key as the | | -| | | | parameter | | -| | | | name and | | -| | | | the value | | -| | | | as the | | -| | | | parameter | | -| | | | that need | | -| | | | to be | | -| | | | passed as | | -| | | | an input to | | -| | | | the script. | | -| | | | | | -| | | | NOTE: The | | -| | | | scriptInput | | -| | | | values are | | -| | | | passed to | | -| | | | the scripts | | -| | | | in addition | | -| | | | to the | | -| | | | parameters | | -| | | | received in | | -| | | | the | | -| | | | operation | | -| | | | invocation | | -| | | | request or | | -| | | | indicator | | -| | | | value | | -| | | | change. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ diff --git a/docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst b/docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst deleted file mode 100644 index 57d1f63..0000000 --- a/docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. 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: LocalAffinityOrAntiAffinityRule -====================================== - -+-------------+-------------+------------------+-----------------+----------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=============+=============+==================+=================+================+ -| type | Enum | 1 | Specifies | support: | -| | | | whether the rule| MANDATORY | -| | | | is an affinity | | -| | | | rule or an | valueRange: | -| | | | anti-affinity | "Affinity", | -| | | | rule. | "Anti-Affinity"| -+-------------+-------------+------------------+-----------------+----------------+ -| scope | Enum | 1 | Specifies the | support: | -| | | | scope of the | MANDATORY | -| | | | rule. | | -| | | | | valueRange: | -| | | | | "NFVI-PoP", | -| | | | | "Zone", | -| | | | | "ZoneGroup", | -| | | | | "NFVI-node" | -+-------------+-------------+------------------+-----------------+----------------+ diff --git a/docs/ONAP Model Spec/im/MonitoringParameter.rst b/docs/ONAP Model Spec/im/MonitoringParameter.rst deleted file mode 100644 index 9dfc5b9..0000000 --- a/docs/ONAP Model Spec/im/MonitoringParameter.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. 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: MonitoringParameter -========================== - -+-------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===================+=============+==================+=================+===============+ -| id | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of the | | -| | | | monitoring | | -| | | | parameter. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| name | String | 0..1 | Human | support: | -| | | | readable | MANDATORY | -| | | | name of the | | -| | | | monitoring | | -| | | | parameter. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| performanceMetric | String | 1 | Identifies | support: | -| | | | the | MANDATORY | -| | | | virtualised | | -| | | | resource | | -| | | | performance | | -| | | | metric. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| collectionPeriod | Not | 0..1 | An | support: | -| | specified | | attribute | MANDATORY | -| | | | that | | -| | Editor's | | describes | | -| | note: need | | the | | -| | to be | | recommended | | -| | specified | | periodicity | | -| | | | at which to | | -| | | | collect the | | -| | | | performance | | -| | | | information. | | -| | | | | | -| | | | VNFM | | -| | | | determines | | -| | | | if this | | -| | | | parameter | | -| | | | is | | -| | | | considered. | | -| | | | | | -| | | | The vendor | | -| | | | may provide | | -| | | | this | | -| | | | information | | -| | | | as a | | -| | | | guidance | | -| | | | for | | -| | | | creating | | -| | | | PmJobs if | | -| | | | needed. | | -| | | | | | -| | | | NOTE: The | | -| | | | MANO or | | -| | | | NFVI may | | -| | | | not support | | -| | | | the | | -| | | | recommended | | -| | | | collectionPeriod| | -| | | | based on | | -| | | | their | | -| | | | functionalities,| | -| | | | and can | | -| | | | reject the | | -| | | | requests | | -| | | | based on | | -| | | | the | | -| | | | recommended | | -| | | | collectionPeriod| | -| | | | in this | | -| | | | case. | | -+-------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/PlacementGroup.rst b/docs/ONAP Model Spec/im/PlacementGroup.rst deleted file mode 100644 index db8008b..0000000 --- a/docs/ONAP Model Spec/im/PlacementGroup.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. 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: PlacementGroup (Experimental) -==================================== - -+-------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===================+=============+==================+=================+===============+ -| elementGroupId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | group in | | -| | | | the VNFD. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| placementStrategy | Enum | 1 | Determine | support: | -| | | | where | MANDATORY | -| | | | VNFC's | | -| | | | (VDU's) are | valueRange: | -| | | | placed with | "co-location",| -| | | | respect to | "isolation", | -| | | | the VNF. | "exclusively" | -| | | | | | -| | | | | NOTE: | -| | | | | | -| | | | | - Co-location| -| | | | | - | -| | | | | members | -| | | | | of the | -| | | | | group | -| | | | | share | -| | | | | the same | -| | | | | physical | -| | | | | host or | -| | | | | rack. | -| | | | | | -| | | | | - isolation | -| | | | | - | -| | | | | members | -| | | | | of the | -| | | | | group do | -| | | | | not | -| | | | | share | -| | | | | the same | -| | | | | physical | -| | | | | host or | -| | | | | rack. | -| | | | | | -| | | | | - Exclusively| -| | | | | - | -| | | | | members | -| | | | | have | -| | | | | sole use | -| | | | | of a | -| | | | | given | -| | | | | physical | -| | | | | host or | -| | | | | rack | -| | | | | (not | -| | | | | shared | -| | | | | with any | -| | | | | vnfcs | -| | | | | outside | -| | | | | the | -| | | | | group). | -+-------------------+-------------+------------------+-----------------+---------------+ -| vnfcMembers | Not | 0..N | References | support: | -| | specified | | to Vdus | MANDATORY | -| | | | that are | | -| | | | part of | | -| | | | this group. | | -| | | | | | -| | | | | | -| | | | | | -+-------------------+-------------+------------------+-----------------+---------------+ -| strategyScope | Enum | 1 | indicate if | support: | -| | | | the | MANDATORY | -| | | | strategy is | | -| | | | applied at | valueRange: | -| | | | the host or | "host", | -| | | | rack level | "rack" | -+-------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/QoS.rst b/docs/ONAP Model Spec/im/QoS.rst deleted file mode 100644 index 8f64127..0000000 --- a/docs/ONAP Model Spec/im/QoS.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. 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: QoS -========== - -+--------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+====================+=============+==================+=================+===============+ -|latency | Number | 1 | Maximum | support: | -| | | | latency in ms. | MANDATORY | -+--------------------+-------------+------------------+-----------------+---------------+ -|packetDelayVariation| Number | 1 | Maximum | support: | -| | | | jitter in ms. | MANDATORY | -+--------------------+-------------+------------------+-----------------+---------------+ -|packetLossRatio | Number | 0..1 | Maximum | support: | -| | | | packet loss | MANDATORY | -| | | | ratio. | | -| | | | Cardinality | | -| | | | is 0 if no | | -| | | | packetLossRatio | | -| | | | requirement | | -| | | | exists. | | -+--------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst b/docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst deleted file mode 100644 index ce9ab2f..0000000 --- a/docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. 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: RequestedAdditionalCapabilityData -======================================== - -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+===============================================+=============+==================+=================+===============+ -| requestedAdditionalCapabilityName | String | 1 | Identifies | support: | -| | | | a requested | MANDATORY | -| | | | additional | | -| | | | capability | valueRange: | -| | | | for the | For | -| | | | VDU. | acceleration | -| | | | | capabilities, | -| | | | | reference | -| | | | | to ETSI GS | -| | | | | NFV-IFA | -| | | | | 002. | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| supportMandatory | Boolean | 1 | Indicates | support: | -| | | | whether the | MANDATORY | -| | | | requested | | -| | | | additional | | -| | | | capability | | -| | | | is | | -| | | | mandatory | | -| | | | for | | -| | | | successful | | -| | | | operation. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| minRequestedAdditionalCapabilityVersion | String | 0..1 | Identifies | support: | -| | | | the minimum | MANDATORY | -| | | | version of | | -| | | | the | | -| | | | requested | | -| | | | additional | | -| | | | capability. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| preferredRequestedAdditionalCapabilityVersion | String | 0..1 | Identifies | support: | -| | | | the | MANDATORY | -| | | | preferred | | -| | | | version of | | -| | | | the | | -| | | | requested | | -| | | | additional | | -| | | | capability. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| targetPerformanceParameters | KeyValuePair| 1..N | Identifies | support: | -| | | | specific | MANDATORY | -| | | | attributes, | | -| | | | dependent | | -| | | | on the | | -| | | | requested | | -| | | | additional | | -| | | | capability | | -| | | | type. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/ScaleInfo.rst b/docs/ONAP Model Spec/im/ScaleInfo.rst deleted file mode 100644 index 14f74cf..0000000 --- a/docs/ONAP Model Spec/im/ScaleInfo.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. 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: ScaleInfo -================ - -+--------------------+----------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+================+==================+=================+==========================+ -| aspectId | Identifier | 1 | Reference | support: | -| | (Reference | | to the | MANDATORY | -| | to | | scaling | | -| | ScalingAspect) | | aspect. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| scaleLevel | Integer | 1 | The scale | support: | -| | | | level, | MANDATORY | -| | | | greater | | -| | | | than or | | -| | | | equal to 0. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/SwImageDesc.rst b/docs/ONAP Model Spec/im/SwImageDesc.rst deleted file mode 100644 index 2add32f..0000000 --- a/docs/ONAP Model Spec/im/SwImageDesc.rst +++ /dev/null @@ -1,144 +0,0 @@ -.. 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: SwImageDesc -================== - -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================================+===================+==================+===================+==========================+ -| id | Identifier | 1 | The | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| name | String | 1 | The name of | support: | -| | | | this | MANDATORY | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| version | String | 1 | The version | support: | -| | | | of this | MANDATORY | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| checksum | String | 1 | The | support: | -| | | | checksum of | MANDATORY | -| | | | the | | -| | | | software | | -| | | | image file. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| containerFormat | String | 1 | The | support: | -| | | | container | MANDATORY | -| | | | format | | -| | | | describes | | -| | | | the | | -| | | | container | | -| | | | file format | | -| | | | in which | | -| | | | software | | -| | | | image is | | -| | | | provided. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| diskFormat | String | 1 | The disk | support: | -| | | | format of a | MANDATORY | -| | | | software | | -| | | | image is | | -| | | | the format | | -| | | | of the | | -| | | | underlying | | -| | | | disk image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| minDisk | Number | 1 | The minimal | support: | -| | (recommended | | disk size | MANDATORY | -| | DM type: | | requirement | | -| | Scalar-Unit-Size) | | for this | | -| | | | software | | -| | | | image. The | | -| | | | value of | | -| | | | the "size | | -| | | | of storage" | | -| | | | attribute | | -| | | | of the | | -| | | | VirtualStorageDesc| | -| | | | referencing | | -| | | | this | | -| | | | SwImageDesc | | -| | | | shall not | | -| | | | be smaller | | -| | | | than the | | -| | | | value of | | -| | | | minDisk. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| minRam | Number | 0..1 | The minimal | support: | -| | (recommended | | RAM | MANDATORY | -| | DM type: | | requirement | | -| | Scalar-Unit-Size) | | for this | | -| | | | software | | -| | | | image. The | | -| | | | value of | | -| | | | the "size" | | -| | | | attribute | | -| | | | of | | -| | | | VirtualMemoryData | | -| | | | of the Vdu | | -| | | | referencing | | -| | | | this | | -| | | | SwImageDesc | | -| | | | shall not | | -| | | | be smaller | | -| | | | than the | | -| | | | value of | | -| | | | minRam. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| size | Number | 1 | The size of | support: | -| | (recommended | | this | MANDATORY | -| | DM type: | | software | | -| | Scalar-Unit-Size) | | image. | | -| | | | | | -| | | | | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| swImage | Identifier | 1 | This is a | support: | -| | (Reference | | reference | MANDATORY | -| | to a | | to the | | -| | SwImage) | | actual | | -| | | | software | | -| | | | image. The | | -| | | | reference | | -| | | | can be | | -| | | | relative to | | -| | | | the root of | | -| | | | the VNF | | -| | | | Package or | | -| | | | can be a | | -| | | | URL. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| operatingSystem | String | 0..1 | Identifies | support: | -| | | | the | MANDATORY | -| | | | operating | | -| | | | system used | | -| | | | in the | | -| | | | software | | -| | | | image. This | | -| | | | attribute | | -| | | | may also | | -| | | | identify if | | -| | | | a 32 bit or | | -| | | | 64 bit | | -| | | | software | | -| | | | image is | | -| | | | used. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| supportedVirtualisationEnvironment| String | 0..N | Identifies | support: | -| | | | the | MANDATORY | -| | | | virtualisation | | -| | | | environments | | -| | | | (e.g. | | -| | | | hypervisor) | | -| | | | compatible | | -| | | | with this | | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/VduLevel.rst b/docs/ONAP Model Spec/im/VduLevel.rst deleted file mode 100644 index 8d86ba4..0000000 --- a/docs/ONAP Model Spec/im/VduLevel.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. 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: VduLevel -=============== - -+-----------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=================+=============+==================+=================+===============+ -| vduId | Identifier | 1 | Uniquely | support: | -| | (Reference | | identifies | MANDATORY | -| | to Vdu) | | a VDU. | | -+-----------------+-------------+------------------+-----------------+---------------+ -|numberOfInstances| Integer | 1 | Number of | support: | -| | | | instances | MANDATORY | -| | | | of VNFC based on| | -| | | | this VDU to | | -| | | | deploy for an | | -| | | | instantiation | | -| | | | level or for a | | -| | | | scaling delta. | | -+-----------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VirtualCpuPinningData.rst b/docs/ONAP Model Spec/im/VirtualCpuPinningData.rst deleted file mode 100644 index d1876bc..0000000 --- a/docs/ONAP Model Spec/im/VirtualCpuPinningData.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. 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: VirtualCpuPinningData -============================ - -+-------------------------+-------------+------------------+-------------------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+=========================+=============+==================+=========================+===============+ -| virtualCpuPinningPolicy | Enum | 0..1 | The policy | support: | -| | | | can take | MANDATORY | -| | | | values of | | -| | | | "static" or | valueRange: | -| | | | "dynamic". | "static", | -| | | | In case of | "dynamic" | -| | | | "static" the virtual | | -| | | | CPU cores are | | -| | | | requested to be | | -| | | | allocated to logical | | -| | | | CPU cores according | | -| | | | to the rules defined in | | -| | | | virtualCpuPinningRules. | | -| | | | In case of "dynamic" | | -| | | | the allocation | | -| | | | of virtual CPU cores | | -| | | | to logical CPU cores | | -| | | | is decided by the VIM. | | -| | | | (e.g.: SMT | | -| | | | (Simultaneous | | -| | | | Multi-Threading) | | -| | | | requirements). | | -+-------------------------+-------------+------------------+-------------------------+---------------+ -| virtualCpuPinningRule | Not | 0..1 | A list of | support: | -| | specified | | rules that | MANDATORY | -| | | | should be | | -| | Editor's | | considered | | -| | note: need | | during the | | -| | to be | | allocation | | -| | specified | | of the | | -| | | | virtual CPUs to | | -| | | | logical CPUs in case of | | -| | | | "static" | | -| | | | virtualCpuPinningPolicy.| | -+-------------------------+-------------+------------------+-------------------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfConfigurableProperties.rst b/docs/ONAP Model Spec/im/VnfConfigurableProperties.rst deleted file mode 100644 index 3dd6c92..0000000 --- a/docs/ONAP Model Spec/im/VnfConfigurableProperties.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. 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: VnfConfigurableProperties -================================ - -+--------------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+================================+=============+==================+=================+===============+ -| isAutoscaleEnabled | Boolean | 0..1 | It permits | support: | -| | | | to enable | MANDATORY | -| | | | (TRUE)/disable | | -| | | | (FALSE) the | | -| | | | auto-scaling | | -| | | | functionality. | | -| | | | | | -| | | | NOTE: A | | -| | | | cardinality | | -| | | | of "0" | | -| | | | indicates | | -| | | | that | | -| | | | configuring | | -| | | | this | | -| | | | present VNF | | -| | | | property is | | -| | | | not | | -| | | | supported. | | -+--------------------------------+-------------+------------------+-----------------+---------------+ -| isAutohealEnabled | Boolean | 0..1 | It permits | support: | -| | | | to enable | MANDATORY | -| | | | (TRUE)/disable | | -| | | | (FALSE) the | | -| | | | auto-healing | | -| | | | functionality. | | -| | | | | | -| | | | NOTE: A | | -| | | | cardinality | | -| | | | of "0" | | -| | | | indicates | | -| | | | that | | -| | | | configuring | | -| | | | this | | -| | | | present VNF | | -| | | | property is | | -| | | | not | | -| | | | supported. | | -+--------------------------------+-------------+------------------+-----------------+---------------+ -| additionalConfigurableProperty | String | 0..N | It provides | support: | -| | | | VNF | MANDATORY | -| | | | specific | | -| | | | configurable | | -| | | | properties | | -| | | | that can be | | -| | | | modified | | -| | | | using the | | -| | | | ModifyVnfInfo | | -| | | | operation. | | -+--------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfIndicator.rst b/docs/ONAP Model Spec/im/VnfIndicator.rst deleted file mode 100644 index d06bdf6..0000000 --- a/docs/ONAP Model Spec/im/VnfIndicator.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. 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: VnfIndicator -=================== - -+----------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+================+=============+==================+=================+===============+ -| id | Identifier | 1 | Unique | support: | -| | | | identifier. | MANDATORY | -+----------------+-------------+------------------+-----------------+---------------+ -| name | String | 0..1 | The human | support: | -| | | | readable | MANDATORY | -| | | | name of the | | -| | | | VnfIndicator. | | -+----------------+-------------+------------------+-----------------+---------------+ -| indicatorValue | String | 1..N | Defines the | support: | -| | | | allowed | MANDATORY | -| | | | values or | | -| | | | value | | -| | | | ranges of | | -| | | | this | | -| | | | indicator. | | -+----------------+-------------+------------------+-----------------+---------------+ -| source | Enum | 1 | Describe | support: | -| | | | the source | MANDATORY | -| | | | of the | | -| | | | indicator. | valueRange: | -| | | | This tells | "VNF", | -| | | | the | "EM", | -| | | | consumer | "Both" | -| | | | where to | | -| | | | send the | | -| | | | subscription | | -| | | | request. | | -+----------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst b/docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst deleted file mode 100644 index 94bb5cd..0000000 --- a/docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. 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: VnfInfoModifiableAttributes -================================== - -+-------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=============+=============+==================+=================+===============+ -| extension | Not | 0..N | "Extension" | support: | -| | specified | | attributes | MANDATORY | -| | | | of VnfInfo | | -| | Editor's | | that are | | -| | note: need | | writeable. | | -| | to be | | | | -| | specified | | | | -+-------------+-------------+------------------+-----------------+---------------+ -| metadata | Not | 0..N | "Metadata" | support: | -| | specified | | attributes | MANDATORY | -| | | | of VnfInfo | | -| | Editor's | | that are | | -| | note: need | | writeable. | | -| | to be | | | | -| | specified | | | | -+-------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst b/docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst deleted file mode 100644 index 5676b25..0000000 --- a/docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. 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: VnfcConfigurableProperties -================================= - -+------------------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+====================================+=============+==================+=================+===============+ -| additionalVnfcConfigurableProperty | String | 0..N | It provides | support: | -| | | | VNFC | MANDATORY | -| | | | configurable | | -| | | | properties | | -| | | | that can be | | -| | | | modified | | -| | | | using the | | -| | | | ModifyVnfInfo | | -| | | | operation. | | -| | | | | | -| | | | NOTE: A | | -| | | | cardinality | | -| | | | of "0" | | -| | | | indicates | | -| | | | that | | -| | | | configuring | | -| | | | this | | -| | | | present VNF | | -| | | | property is | | -| | | | not | | -| | | | supported. | | -+------------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst b/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst new file mode 100644 index 0000000..e8a81a0 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst @@ -0,0 +1,3935 @@ +ONAP Vnf Sub Model + +1. .. rubric:: Diagrams + :name: diagrams + + 1. .. rubric:: ONAP Vnfd - Topology View + :name: onap-vnfd---topology-view + + 2. .. rubric:: ONAP Vnfd View + :name: onap-vnfd-view + + 3. .. rubric:: VNF Datatypes + :name: vnf-datatypes + + 4. .. rubric:: VNF Instance + :name: vnf-instance + + 5. .. rubric:: Vnf Deployment Flavor + :name: vnf-deployment-flavor + + 6. .. rubric:: Vnf Element Group + :name: vnf-element-group + +2. .. rubric:: Classes + :name: classes + + 7. .. rubric:: BaseConfigGroup + :name: baseconfiggroup + +Every Vnf contains a BaseConfigGroup. BaseConfigGroup may set Access +Control Lists (ACL's) and establish security groups and server groups. +BaseConfigGroup reates/establishs storage for the VM's (OpenStack +Cinder). BaseConfigGroup may establish internal networks such as OAM +(VNF Mgmt) or MNS (Maintenance & Surveillance) established. A very +simple VNF may only have a BaseConfig VnfElementGroup. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + + 8. .. rubric:: DeploymentGroup + :name: deploymentgroup + +DeploymentGroup provides the minimum viable VDU and associated VNFC +configuration for a useable VNF. I can have a small, medium, large +deployment configuration. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + + 9. .. rubric:: HomingGroup + :name: hominggroup + +Homing selects what cloud selection strategy will be used. HomingGroup +is used to determine where VNF's within a given group are placed with +respect to a service component. Homing strategy is as follows: +Colocation - members of the group share the same cloud region (VIM +Domain) isolation - members of the group do not share the same cloud +region. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - homingStrategy + - HomingStrategy + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - The homing strategy can be one of the following: + Exclusivity + - Resources within the cloud region are exclusive to the group + Inclusively + - Resources are co-located in the same cloud-region. + Diversity + - Resources are geo-diverse (cannot be co-located). + + * - vnfdMembers + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +InstantiationLevel +~~~~~~~~~~~~~~~~~~ + +The InstantiationLevel class describes a given level of resources to be +instantiated within a DF in term of the number of VNFC instances to be +created from each VDU. All the VDUs referenced in the level shall be +part of the corresponding DF and their number shall be within the range +(min/max) for this DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - levelId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a level with the DF. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the level. + + * - scaleInfo + - ScaleInfo + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Represents for each aspect the scale level that corresponds to this instantiationlevel. + scaleInfo shall be present if the VNF supports scaling. + + * - \_vduLevel + - VduLevel + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicates the number of instance of this VDU to deploy for this level. + + * - virtualLinkBitRateLevel + - VirtualLinkBitRateLevel + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies bitrate requirements applicable to virtual links created from particular virtual link descriptors for this level. + NOTE: If not present, it is assumed that the bitrate requirements can be derived from those specified in the VduCpd instances applicable to the internal VL. If present in + both the InstantiationLevel and the VduCpd instances applicable to the internal VL, the highest value takes precedence. + +LinkDesc +~~~~~~~~ + +A communication channel that connects two or more devices, nodes, or entities. + +**Parent class:** ResourceDesc (ResourceSpecification) + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - virtualLinkDescId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Unique identifier of this internal VLD in VNFD. + + * - connectivityType + - ConnectivityType + - 1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Specifies the protocol exposed by a VL and the flow pattern supported by the VL. + + * - testAccess + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Specifies test access facilities expected on the VL (e.g. none, passive monitoring, or active (intrusive) loopbacks at endpoints). + + * - description + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Provides human-readable information on the purpose of the VL (e.g. control plane traffic). + + * - monitoringParameter + - MonitoringParameter + - 0..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Defines the virtualised resources monitoring parameters on VLD level. + + * - \_virtuaLlinkDescFlavour + - VirtualLinkDescFlavour + - 1..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Describes a specific flavour of the VL with specific bitrate requirements. + + +PlacementGroup +~~~~~~~~~~~~~~ + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - placementStrategy + - PlacementStrategy + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - strategScope + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +13. .. rubric:: ScalingAspect + :name: scalingaspect + +The ScalingAspect class describes the details of an aspect used for +horizontal scaling. + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + + 14. .. rubric:: ScalingGroup + :name: scalinggroup + +A ScalingGroup determines which VNFC's (VDU's) are scaled together based +on demand. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + + 15. .. rubric:: SwImageDesc + :name: swimagedesc + +The SwImageDesc information element describes requested additional +capability for a particular VDU. Such a capability may be for +acceleration or specific tasks. Storage not necessarily related to the +compute, may be Network Attached Storage (NAS) References: +tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The identifier of this software image. + + * - name + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The name of this software image. + + * - version + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The version of this software image. + + * - checksum + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The checksum of the software image file. + + * - containerFormat + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The container format describes the container file format in which software image is provided. + + * - diskFormat + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The disk format of a software image is the format of the underlying disk image. + + * - minRam + - Number + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal RAM requirement for this software image. The value of the "size" attribute of VirtualMemoryData of the Vdu referencing this + SwImageDesc shall not be smaller than the value of minRam. + + * - minDisk + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the + VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk. + + * - size + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The size of the software image. + + * - operatingSystem + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. + support: + + * - supportedVirtualisationEnvironment + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. + + * - swImage + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the VirtualStorageDesc referencing this SwImageDesc + shall not be smaller than the value of minDisk. + + +Vdu +~~~ + +The Virtualisation Deployment Unit (VDU) is a construct supporting the +description of the deployment and operational behavior of a VNFC. A VNFC +instance created based on the VDU maps to a single virtualisation +container (e.g. a VM). A VNFC will only be in one VNFDesc. If a vendor +wants to use the VNFC in mupliple VNFDesc (their product) they can do +so, but it will be 'repeated'. References: +tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 + +Applied stereotypes: + +- Preliminary +- OpenModelClass +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vduId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this Vdu in VNFD. + + * - name + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name of the Vdu. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the Vdu. + + * - bootOrder + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Boot order of valid boot devices. + NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. + + * - nfviConstraint + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes constraints on the NFVI for the VNFC instance(s) created from this 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the virtualised resources monitoring parameters on VDU level. + + * - injectFiles + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. + + * - configurableProperties + - VnfcConfigurableProperties + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the configurable properties of all VNFC instances based on this VDU. + + * - \_vduCpd + - VduCpd + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL). + + * - \_virtualComputeDesc + - VirtualComputeDesc + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. + + * - \_virtualStorageDesc + - VirtualStorageDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from + virtualComputeDesc defined for this Vdu. + + * - \_swImageDesc + - SwImageDesc + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the software image which is directly loaded on the virtualisation + container realising this Vdu. + NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. + + +VduCpd +~~~~~~ + +A VduCpd information element is a type of Cpd and describes network +connectivity between a VNFC instance (based on this VDU) and an internal +VL. + +**Parent class:** Cpd + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - bitrateRequirement + - Number + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Bitrate requirement on this CP. + + * - vnicName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. + + * - vnicOrder + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the order to create the vNIC within the scope of this Vdu. + + * - vnicType + - VnicType + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the type of the vNIC this CP attaches to. + + * - \_virtualNetworkInterfaceRequirements + - VirtualNetworkInterfaceRequirements + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. + + * - cpdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this Cpd information element. + + * - cpRole + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the role of 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 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). + + * - cpProtocol + - CpProtocolData + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the protocol layering information the CP uses for connectivity + purposes and associated information. There shall be one cpProtocol for each layer + protocol as indicated by the attribute layerProtocol. + Editor's note: the attribute "layerProtocol" still needs further discussion and not included in this table. + + * - trunkMode + - Boolean + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). + + * - allowedAddressData + - AddressData + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. + + +VduLevel +~~~~~~~~ + +The VduLevel information element indicates for a given VDU in a given +level the number of instances to deploy. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vduId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a VDU. + + * - numberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. + + +VduProfile +~~~~~~~~~~ + +The VduProfile describes additional instantiation data for a given VDU +used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vdudId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a VDU. + + * - minNumberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. + + * - maxNumberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. + + * - localAffinityOrAntiAffinityRule + - LocalAffinityOrAntiAffinityRule + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) + to be created based on this VDU. + + * - affinityOrAntiAffinityGroupId + - Identifier + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier(s) of the affinity or anti-affinity group(s) the VDU belongs to. + NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity + relationships between the virtualisation container(s) (e.g. virtual machine(s)) to be created using this VDU and the + virtualisation container(s) (e.g. virtual machine(s)) to be created using other VDU(s) in the same group. + + * - watchdog + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc. + + * - vmBootUpTimeOut + - Integer + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Timeout value for the VNFM to wait before the successful booting up of the VDU. + + +VirtualComputeDesc +~~~~~~~~~~~~~~~~~~ + +The VirtualComputeDesc information element supports the specification of +requirements related to virtual compute resources. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - virtualComputeDescId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this VirtualComputeDesc in the VNFD + + * - logicalNode + - LogicalNodeData + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The logical Node requirements. + + * - requestAdditionalCapabilities + - RequestedAdditionalCapabilityData + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Specifies requirements for additional capabilities. These may be for a range of purposes. + One example is acceleration related capabilities. + + * - computeRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies compute requirements. + + * - virtualMemory + - VirtualMemoryData + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The virtual memory of the virtualised compute. + + * - virtualCpu + - VirtualCpuData + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The virtual CPU(s) of the virtualised compute. + + +VirtualLinkDescFlavour +~~~~~~~~~~~~~~~~~~~~~~ + +The VirtualLinkDescFlavour describes additional instantiation data for a +given internal VL used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - qos + - QoS + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - QoS of the VL. + + * - flavourId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies a flavour within a VnfVirtualLinkDesc. + + +VirtualLinkProfile +~~~~~~~~~~~~~~~~~~ + +The VirtualLinkProfile describes additional instantiation data for a +given VL used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - localAffinityOrAntiAffinityRule + - LocalAffinityOrAntiAffinityRule + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or anti-affinity rules applicable between the VLs based on this + VnfVirtualLinkDesc. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity + rule(s) with different scopes are applicable to the VLs based on this VnfVirtualLinkDesc. + + * - affinityOrAntiAffinityGroupId + - Identifier + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier(s) of the affinity or anti-affinity group(s) the VnfVirtualLinkDesc belongs to. + NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity + relationship between the VL(s) using this VnfVirtualLinkDesc and the VL(s) using other VnfVirtualLinkDesc(s) + in the same group. + + * - maxBitRateRequirements + - LinkBitrateRequirements + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies the minimum bitrate requirements for a VL instantiated + according to this profile. + + * - minBitRateRequirements + - LinkBitrateRequirements + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. + + * - initiationParameters + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies initiation parameters for the virtual link. + + * - networkType + - NetworkType + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Type of the network + + * - dhcpEnabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. + + * - vlanTransparent + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicating whether "VLAN Transparent Mode" is supported. + Default is "FALSE" if not specified otherwise. + + * - \_virtualLinkDescFlavour + - VirtualLinkDescFlavour + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies a flavour within the VnfVirtualLinkDesc. + + * - \_virtualLinkDesc + - LinkDesc + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a Vnf VLD. + + +VirtualNetworkInterfaceRequirements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This class specifies requirements on a virtual network interface. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - name + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides a human readable name for the requirement. + + * - description + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides a human readable description of the requirement. + + * - supportMandatory + - Boolean + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or + desirable (FALSE). + + * - networkInterfaceRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The network interface requirements. An element from an array of key-value pairs that + articulate the network interface deployment requirements + + * - nicIoRequirements + - LogicalNodeData + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. + Linking these attributes is necessary so that so that I/O requirements + that need to be articulated at the logical node level can be associated with the network interface requirements + associated with the CPD. + + +VirtualStorageDesc +~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this VirtualStorageDesc in the VNFD. + + * - typeOfStorage + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Type of virtualised storage resource (e.g. volume, object). + + * - sizeOfStorage + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Size of virtualised storage resource (e.g. size of volume, in GB). + + * - vduStorageRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - An array of key-value pairs that articulate the storage deployment requirements. + + * - rdmaEnabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Indicate if the storage support RDMA. + + * - swImageDesc + - Identifier + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Software image to be loaded on the VirtualStorage resource created + based on this VirtualStorageDesc. + +Vnf +~~~ + +An implementation of an NF that can be deployed on a Network Function +Virtualisation Infrastructure (NFVI). + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfInstanceId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the VNF instance + + * - vnfInstanceName + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - name of the VNF instance. Multiple names are possible. + + * - vnfProductName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - name to identify the VNF Product, invariant for the VNF Product lifetime + + * - description + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - description of the VNF instance + + * - vnfProvider + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - provider of the VNF model + + * - vnfdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the VNF model + + * - vnfdVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - version of the VNF model + + * - vnfSoftwareVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package + + * - onboardedVnfPkgInfoId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the specific VNF package on which the VNF instance is based + + * - availabilityZone + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - availability zone information of the VNF instance + + * - operationalStatus + - OperationalStatus + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether the resource is considered operational. + Valid values are in-service-path and out-of-service-path. + + * - orchestrationStatus + - OrchestrationStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNF instance is instantiated + + * - oamlpv4Address + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - oam ip address, ipv4 + + * - oamlpv6Address + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - oam ip address, ipv6 + + * - instantiatedVnfInfo + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - information specific to an instantiated VNF instance, e.g., vm information + + * - inMaint + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + * - isClosedLoopDisabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether closed loop function is enabled + + * - encryptedAccessFlag + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether this VNF is accessed using SSH + + * - vnfConfigurableProperty + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether autoHeal and autoScale is enabled + + * - nfNamingCode + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - String assigned to this model used for naming purpose. + + * - vnfNamingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which has the naming logic for this VNF instance + + * - vnfHomingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which provides homing conditions. + + * - nfType + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Generic description of the type of network function + + * - nfFunction + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - English description of network function that the specific VNF deployment is providing. + + * - nfRole + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Role in the network this model will be providing + + * - closedLoopStatus + - ClosedLoopStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Whether closed loop capabilities are enabled for this or not. + + * - \_nfc(vnfcinstance) + - Vnfc + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relatonship to the NF components that are part of this VNF. + + * - \_vnfd + - Vnfd + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relationship to the VNF descriptor + + * - \_vnfvirtuallink + - VnfVirtualL ink + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relationship to VnfVirtualLink + + +VnfDf +~~~~~ + +The VnfDf describes a specific deployment version of a VNF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - flavorId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this DF within the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the DF. + + * - \_virtuaLlinkProfile + - VirtualLinkProfile + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the internal 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the various 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The scaling aspects supported by this DF of the VNF. + scalingAspect shall be present if the VNF supports scaling. + + * - \_vduProfile + - VduProfile + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes additional instantiation data for the VDUs used in this flavor. + + * - \_placementGroup + - PlacementGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Determine where VNFC's (VDU's) are placed with respect to the VNF + + * - \_baseConfigGroup + - BaseConfigGroup + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - BaseConfigGroup may set 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 + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - DeploymentGroup provides the minimum viable VDU and associated VNFC configuration + for a useable VNF. + + * - \_scalinggroup + - ScalingGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together. + + +VnfExtCp +~~~~~~~~ + +Describes an external CP exposed by a VNF. + +**Parent class:** Cp + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + + 29. .. rubric:: VnfExtCpd + :name: vnfextcpd + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - \_virtualNetworkInterfaceRequirements + - VirtualNetworkInterfaceRequirements + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. + NOTE: In case of referencing an intCpd via its identifier, the virtualNetworkInterfaceRequirements attribute + of the referenced intCpd applies. + + * - \_vduCpd + - VduCpd + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reference to the internal VDU CPD which is used to instantiate internal CPs. These internal CPs are, in turn, + exposed as external CPs defined by this external CPD. + + +VnfIndicator +~~~~~~~~~~~~ + +The VnfIndicator information element defines the indicator the VNF +supports. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier. + + * - name + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The human readable name of the VnfIndicator. + + * - indicatorValue + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the allowed values or value ranges of this indicator. + + * - source + - VnfSource + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describe the source of the indicator. This tells the consumer where to send the + subscription request. + + +VnfVirtualLink +~~~~~~~~~~~~~~ + +**Parent class:** VirtualLink + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + + 32. .. rubric:: Vnfc + :name: vnfc + +An internal component of a VNF providing a VNF Provider a defined +sub-set of that VNF's functionality, with the main characteristic that a +single instance of this component maps 1:1 against a single +Virtualisation Container. + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfcInstanceId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the NFC instance + + * - nfcNamingCode + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - short code of the NFC instance + + * - description + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - description of the NFC instance + + * - vdudId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the model of the NFC instance + + * - l3InterfaceIpv4AddressList + - invalid + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - layer-3 interface addresses, ipv4 + + * - l3InterfaceIpv6AddressList + - invalid + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - layer-3 interface addresses, ipv6 + + * - vnfcState + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - operating status of the VM valid value example: + STARTED (POWER_ON), + STOPPED (POWER_OFF) + + * - inMaint + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + * - isClosedLoopDisabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether closed loop function is enabled + + * - vnfcInstanceName + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - An intelligent or human readable name of the vnfc instance. Multiple names are possible. + + * - \_vnfcCp + - VnfcCp + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Reference to the connection points of the vnfc + + * - vnfcNamingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which has the naming logic for this VNFC instance + + * - nfcFunction + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - English description of network function component that the specific VNFC deployment is providing. + + * - operationalStatus + - OperationalStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether the resource is considered operational. + Valid values are in-service-path and out-of-service-path. + + * - orchestrationStatus + - OrchestrationStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNFC instance is instantiated + + * - closedLoopStatus + - ClosedLoopStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Whether closed loop capabilities are enabled for this or not. + + * - \_vdu + - Vdu + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Reference to the VDU + + +VnfcCp +~~~~~~ + +**Parent class:** Cp + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + + 34. .. rubric:: Vnfd + :name: vnfd + +A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of +deployment and operational behaviour requirements. It also contains +connectivity, interface and virtualised resource requirements. +References: tosca-nfv-YAML-v1.0-wd05-rev02 (tosca.nodes.nfv.vnfd, but +node details are not defined) ETSI GS NFV-IFA 011 V2.1.3 (VNFD) + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfProvider + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provider of the VNF and of the VNFD. + + * - vnfProductName + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Name to identify the VNF Product. + Invariant for the VNF Product lifetime. + + * - vnfSoftwareVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Software version of the VNF. + This is changed when there is any change to the + software that is included in the VNF Package. + + * - vnfdVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the version of the VNFD. + + * - vnfProductInfoName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name for the VNF Product. + Can change during the VNF Product lifetime. + + * - vnfProductInfoDescription + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the VNF Product. + Can change during the VNF Product lifetime. + + * - vnfmInfo + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. + + * - localizationLanguage + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about localization languages of the VNF (includes e.g. strings in the VNFD). + NOTE: This allows to provide one or more localization languages to support selecting a + specific localization language at VNF instantiation time. + + * - modifiableAttributes + - VnfInfoModifiableAttributes + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the + ModifyVnfInfo operation. + + * - vnfdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this 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. + + * - defaultLocalizationLanguage + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about localization languages of the VNF (includes e.g. strings in the VNFD). + NOTE: This allows to provide one or more localization languages to support selecting a + specific localization language at VNF instantiation time. + + * - configurableProperties + - VnfConfigurableProperties + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). + + * - lifecycleManagementScript + - LifecycleManagementScript + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Includes a list of events and corresponding management scripts performed for the VNF. + + * - logo + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - File path of the vendor specified logo. + + * - guide + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model. + + * - \_vdu + - Vdu + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Virtualisation Deployment Unit. + + * - \_vnfExtCpd + - VnfExtCpd + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes external interface(s) exposed by this VNF enabling connection with a VL. + + * - \_deploymentFlavour + - VnfDf + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes specific DF(s) of a VNF with specific requirements for capacity and performance. + + * - \_vnfIndicator + - VnfIndicator + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Declares the VNF indicators that are supported by this VNF. + + * - \_virtualComputeDesc + - VirtualComputeDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines descriptors of virtual compute resources to be used by the VNF. + + * - \_virtualStorageDesc + - VirtualStorageDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines descriptors of virtual storage resources to be used by the VNF. + + * - \_intVirtuallinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Represents the type of network connectivity mandated by the VNF provider + between two or more CPs which includes at least one internal CP. + + * - \_vnfReservedCpd + - VduCpd + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reserved IP Address for VNF which is not bounded to any + specific VNFC, but assigned manually from outside and potentially + shared as a floating IP among VNFCs. + + * - \_elementGroup + - VnfdElementGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the associated elements of a VNFD for a certain purpose + during VNF lifecycle management. + + +VnfdElementGroup +~~~~~~~~~~~~~~~~ + +A VNFD Element Group is a mechanism for associating elements of a VNFD +(Vdus and VnfVirtualLinkDesc(s)) for a certain purpose, for example, +scaling aspects. A given element can belong to multiple groups. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +3. .. rubric:: Data Types + :name: data-types + + 36. .. rubric:: LifecycleManagementScript + :name: lifecyclemanagementscript + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - event + - LcmEvent + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. + + * - icmTransitionEvent + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the transition VNF lifecycle event(s) that cannot be mapped to any of + the enumerated values defined for the event attribute. + NOTE: At least one of these two attributes shall be included. + + * - script + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information to locate a VNF LCM script (e.g. written in a DSL as specified in requirement VNF_PACK.LCM.001) + triggered to react to one of the events listed in the event attribute. + + * - scriptDsl + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the domain specific language (i.e. the type) of script that is provided. + Types of scripts could include bash, python, etc. + + * - scriptInput + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. + NOTE: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or + indicator value change. + + +LogicalNodeData +~~~~~~~~~~~~~~~ + +This information element describes compute, memory and I/O requirements +that are to be associated with the logical node of infrastructure. The +logical node requirements are a sub-component of the VDU level +requirements. As an example for illustration purposes, a logical node +correlates to the concept of a NUMA cell in libvirt terminology. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - logicalNodeRequirement + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The logical node-level compute, memory and I/O requirements. An array of key-value pairs + that articulate the deployment requirements. This could include the number of CPU cores + on this logical node, a memory configuration 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. + + +MonitoringParameter +~~~~~~~~~~~~~~~~~~~ + +Specifies the virtualised resource related performance metric to be +tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects +the values of performance metrics identified by this information element +from the VIM(s) using one or more locally initiated PM Jobs. These +values can be used as inputs to auto-scaling rules. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of the monitoring parameter. + + * - name + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name of the monitoring parameter. + + * - performanceMetric + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - + + * - collectionPeriod + - invalid + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - An attribute that describes the recommended periodicity at which to collect the performance information. + VNFM determines if this parameter is considered. The vendor may provide this information as a guidance for + creating PmJobs if needed. + NOTE: The MANO or NFVI may not support the recommended collectionPeriod based on their functionalities, and can + reject the requests based on the recommended collectionPeriod in this case. + + +QoS +~~~ + +The QoS information element describes QoS data for a given VL used in a +DF. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - latency + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum latency in ms. + + * - packetDelayVariation + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum jitter in ms. + + * - packetLossRatio + - Number + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. + + +RequestedAdditionalCapabilityData +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This information element describes requested additional capability for a +particular VDU. Such a capability may be for acceleration or specific +tasks. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - supportMandatory + - Boolean + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Indicates whether the requested additional capability is mandatory for successful operation. + + * - requestedAdditionalCapabilityName + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies a requested additional capability for the VDU. + + * - minRequestedAdditionalCapabilityVersion + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies the minimum version of the requested additional capability. + + * - preferredRequestedAdditionalCapabilityVersion + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies the preferred version of the requested additional capability. + + * - targetPerformanceParameters + - KeyValuePair + - 1..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies specific attributes, dependent on the requested additional capability type. + + +ScaleInfo +~~~~~~~~~ + +The ScaleInfo information element represents a scale level for a +particular scaling aspect. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - aspectId + - Identifier + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reference to the scaling aspect. + + * - scaleLevel + - Integer + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The scale level, greater than or equal to 0 + + +VirtualCpuData +~~~~~~~~~~~~~~ + +The VirtualCpuData information element supports the specification of +requirements related to virtual CPU(s) of a virtual compute resource. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - cpuArchitecture + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested. + + * - numVirtualCpu + - Integer + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Number of virtual CPUs. + + * - virtualCpuClock + - Number + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. + + * - virtualCpuOversubscriptionPolicy + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. The cardinality can be 0 during the allocation request, if no particular value is requested. + + * - vduCpuRequirements + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of key-value pair requirements on the Compute (CPU) for the VDU. + + * - virtualCpuPinning + - VirtualCpuPinningData + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The virtual CPU pinning configuration for the virtualised compute resource. + + +VirtualCpuPinningData +~~~~~~~~~~~~~~~~~~~~~ + +The VirtualCpuPinningData information element supports the specification +of requirements related to the virtual CPU pinning configuration of a +virtual compute resource. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - virtualCpuPinningPolicy + - PinningPolicy + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The policy can take values of "static" or "dynamic". In case of "static" the virtual CPU cores are requested to be allocated to logical CPU cores according to the rules defined in virtualCpuPinningRules. + In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). + + * - virtualCpuPinningRule + - invalid + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy. + + +VirtualLinkBitRateLevel +~~~~~~~~~~~~~~~~~~~~~~~ + +The VirtualLinkBitRateLevel information element specifies bitrate +requirements applicable to a virtual link instantiated from a particular +VnfVirtualLinkDesc. + +VirtualMemoryData +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - virtualMemSize + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Amount of virtual Memory (e.g. in MB). + + * - virtualMemOversubscriptionPolicy + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + + Obsolete + - The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. The cardinality can be 0 during the allocation request, if no particular value is requested. + + * - vduMemRequirements + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of key-value pair requirements on the memory for the VDU. + + * - numaEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - It specifies the memory allocation to be cognisant of the relevant process/core allocation. The cardinality can be 0 during the allocation request, if no particular value is requested. + + +VnfConfigurableProperties +~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the configurable properties of a VNF (e.g. related +to auto scaling and auto healing). For a VNF instance, the value of +these properties can be modified by the VNFM + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - isAutoscaleEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. + NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. + + * - isAutohealEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. + NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. + + * - additionalConfigurableProperty + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - + + +VnfInfoModifiableAttributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the VNF-specific extension and metadata attributes +of the VnfInfo that are writeable via the ModifyVnfInfo operation. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - extension + - invalid + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - "Extension" attributes of VnfInfo that are writeable. + + * - metadata + - invalid + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Metadata" attributes of VnfInfo that are writeable + + +VnfcConfigurableProperties +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the configurable properties of a VNFC. For a VNFC +instance, the value of these properties can be modified through the +VNFM. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - additionalVnfcConfigurableProperty + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. + + +4. .. rubric:: Enumerations + :name: enumerations + + 49. .. rubric:: AddressType + :name: addresstype + +Type of address + +Contains Enumeration Literals: + +- MAC: + +- IP: + + 50. .. rubric:: ClosedLoopStatus + :name: closedloopstatus + +Contains Enumeration Literals: + +- ENABLED: + +- DISABLED: + + 51. .. rubric:: CollectionPeriod + :name: collectionperiod + +Specifies the periodicity at which the producer will collect performance +information. + +Contains Enumeration Literals: + +HomingStrategy +~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- Colocation: + +- isolation: + + 53. .. rubric:: LcmEvent + :name: lcmevent + +Describes VNF lifecycle event(s) or an external stimulus detected on a +VNFM reference point. + +Contains Enumeration Literals: + +- EVENT_START_INSTANTIATION: + +- EVENT_END_INSTANTIATION: + +- EVENT_START_SCALING: + +- EVENT_END_SCALING: + +- EVENT_START_SCALING_TO_LEVEL: + +- EVENT_END_SCALING_TO_LEVEL: + +- EVENT_START_HEALING: + +- EVENT_END_HEALING: + +- EVENT_START_TERMINATION: + +- EVENT_END_TERMINATION: + +- EVENT_START_VNF_FLAVOR_CHANGE: + +- EVENT_END_VNF_FLAVOR_CHANGE: + +- EVENT_START_VNF_OPERATION_CHANGE: + +- EVENT_END_VNF_OPERATION_CHANGE: + +- EVENT_START_VNF_EXT_CONN_CHANGE: + +- EVENT_END_VNF_EXT_CONN_CHANGE: + +- EVENT_START_VNFINFO_MODIFICATION: + +- EVENT_END_VNFINFO_MODIFICATION: + + 54. .. rubric:: OperationalStatus + :name: operationalstatus + +Indicator for whether the resource is considered operational. Valid +values are in-service-path and out-of-service-path. + +Contains Enumeration Literals: + +- IN-SERVICE-PATH: + +- OUT-OF-SERVICE-PATH: + + 55. .. rubric:: OrchestrationStatus + :name: orchestrationstatus + +Contains Enumeration Literals: + +- INVENTORIED: + +- ASSIGNED: + +- CREATED: + +- ACTIVE: + + 56. .. rubric:: PinningPolicy + :name: pinningpolicy + +Defines the CPU pinning policy. + +Contains Enumeration Literals: + +- STATIC: + +- DYNAMIC: + + 57. .. rubric:: PlacementStrategy + :name: placementstrategy + +Contains Enumeration Literals: + +- COLOCATION: + +- ISOLATION: + +- EXCLUSIVITY: + + 58. .. rubric:: ProvStatus + :name: provstatus + +Provisioning status, used as a trigger for operational monitoring of +this resource by service assurance systems. + +Contains Enumeration Literals: + +- PROVISIONED: + +- PREPROVISIONED: + +- CAPPED: + + 59. .. rubric:: VnfSource + :name: vnfsource + +Describes the source of the indicator. + +Contains Enumeration Literals: + +- VNF: + +- EM: + +- BOTH: + + 60. .. rubric:: VnicType + :name: vnictype + +Describes the type of VNIC to which a CP attaches. + +Contains Enumeration Literals: + +- NORMAL: + +- MACVTAP: + +- DIRECT: + +- BAREMETAL: + +- DIRECT_PHYSICAL: + +- VIRTIO_FORWARDER: + + 5. .. rubric:: Primitives + :name: primitives + + 6. .. rubric:: Interfaces + :name: interfaces + +7. .. rubric:: Signals + :name: signals + +8. .. rubric:: Operations + :name: operations + + diff --git a/docs/ONAP Model Spec/im/VnfdElementGroup.rst b/docs/ONAP Model Spec/im/VnfdElementGroup.rst deleted file mode 100644 index 89c6125..0000000 --- a/docs/ONAP Model Spec/im/VnfdElementGroup.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. 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: VnfdElementGroup -======================= - -+--------------------+---------------------+------------------+--------------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+====================+=====================+==================+====================+===============+ -| vnfdElementGroupId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | group in | | -| | | | the VNFD. | | -+--------------------+---------------------+------------------+--------------------+---------------+ -| description | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the | | -| | | | group. | | -+--------------------+---------------------+------------------+--------------------+---------------+ -| vdu | Identifier | 0..N | References | support: | -| | (Reference | | to Vdus | MANDATORY | -| | to Vdu) | | that are | | -| | | | part of | | -| | | | this group. | | -+--------------------+---------------------+------------------+--------------------+---------------+ -| virtualLinkDesc | Identifier | 0..N | References | support: | -| | (Reference | | to | MANDATORY | -| | to | | VnfVirtualLinkDesc | | -| | VnfVirtualLinkDesc) | | that are part of | | -| | | | this group. | | -+--------------------+---------------------+------------------+--------------------+---------------+ diff --git a/docs/ONAP Model Spec/im/cpd.rst b/docs/ONAP Model Spec/im/cpd.rst deleted file mode 100644 index be0177e..0000000 --- a/docs/ONAP Model Spec/im/cpd.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. 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: Cpd -========== - -+--------------------+----------------+------------------+-----------------+--------------------------+ -| **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-readable | MANDATORY | -| | | | information | | -| | | | on the | | -| | | | purpose of | | -| | | | the CP | | -| | | | (e.g. CP | | -| | | | for control | | -| | | | plane | | -| | | | traffic). | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| cpProtocol | CpProtocolData | 1..N | Identifies | support: | -| | | | the | MANDATORY | -| | | | protocol | | -| | | | layering | | -| | | | information | | -| | | | the CP uses | | -| | | | for | | -| | | | connectivity | | -| | | | purposes | | -| | | | and | | -| | | | associated | | -| | | | information. | | -| | | | There shall | | -| | | | be one | | -| | | | cpProtocol | | -| | | | for each | | -| | | | layer | | -| | | | protocol as | | -| | | | indicated | | -| | | | by the | | -| | | | attribute | | -| | | | layerProtocol. | | -| | | | | | -| | | | 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 | | -| | | | instantiated | | -| | | | from this | | -| | | | CPD is in | | -| | | | Trunk mode | | -| | | | (802.1Q or | | -| | | | other). | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| allowedAddressData | AddressData | 0..N | For | support: | -| | | | 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 Model Spec/im/index.rst b/docs/ONAP Model Spec/im/index.rst index e38744d..65d6a8d 100644 --- a/docs/ONAP Model Spec/im/index.rst +++ b/docs/ONAP Model Spec/im/index.rst @@ -12,44 +12,4 @@ ONAP Information Model Specifications .. toctree:: :titlesonly: - AddressData - AffinityOrAntiAffinityGroup - BaseConfigGroup - ConnectivityType - cpd - CpProtocolData - DeploymentGroup - instantiationlevel - L2AddressData - L3AddressData - LifecycleManagementScript - linkbitraterequirements - LocalAffinityOrAntiAffinityRule - logicalnodedata - MonitoringParameter - PlacementGroup - QoS - RequestedAdditionalCapabilityData - ScaleInfo - SwImageDesc - vdu - vducpd - VduLevel - vduprofile - virtualcomputedesc - virtualcpudata - VirtualCpuPinningData - virtuallinkdescflavour - virtuallinkprofile - virtualmemorydata - virtualnetworkinterfacerequirements - virtualstoragedesc - VnfcConfigurableProperties - VnfConfigurableProperties - vnfd - VnfdElementGroup - vnfdf - vnfextcpd - VnfIndicator - VnfInfoModifiableAttributes - vnfvirtuallinkdesc + VnfdAndVnfInstance
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/instantiationlevel.rst b/docs/ONAP Model Spec/im/instantiationlevel.rst deleted file mode 100644 index a36998a..0000000 --- a/docs/ONAP Model Spec/im/instantiationlevel.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. 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: 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. | | -+------------------------+-------------------------+------------------+-------------------+--------------------------+ -| virtualLinkBitRateLevel| VirtualLinkBitRateLevel | 0..N | Specifies | support: | -| | | | bitrate | MANDATORY | -| | | | requirements | | -| | | | applicable | | -| | | | to virtual links | | -| | | | created from | | -| | | | particular | | -| | | | virtual link | | -| | | | descriptors | | -| | | | for this level. | | -| | | | | | -| | | | NOTE: If not | | -| | | | present, it | | -| | | | is assumed | | -| | | | that the bitrate | | -| | | | requirements | | -| | | | can be derived | | -| | | | from those | | -| | | | specified in the | | -| | | | VduCpd instances | | -| | | | applicable | | -| | | | to the internal | | -| | | | VL. If | | -| | | | present in | | -| | | | both the | | -| | | | InstantiationLevel| | -| | | | 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 | | -| | | | instantiation | | -| | | | level. | | -| | | | scaleInfo | | -| | | | shall be | | -| | | | present if | | -| | | | the VNF | | -| | | | supports scaling. | | -+------------------------+-------------------------+------------------+-------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/linkbitraterequirements.rst b/docs/ONAP Model Spec/im/linkbitraterequirements.rst deleted file mode 100644 index ab2c497..0000000 --- a/docs/ONAP Model Spec/im/linkbitraterequirements.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. 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: 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 | | -| | | | connectivity | | -| | | | type (e.g. | | -| | | | for E-Tree | | -| | | | and E-LAN | | -| | | | branches). | | -| | | | | | -| | | | NOTE: The | | -| | | | present | | -| | | | document | | -| | | | does not | | -| | | | specify the | | -| | | | means to | | -| | | | declare | | -| | | | different | | -| | | | bitrate | | -| | | | requirements | | -| | | | for leaf | | -| | | | connections | | -| | | | (e.g. E-LAN | | -| | | | leaves). | | -+--------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/logicalnodedata.rst b/docs/ONAP Model Spec/im/logicalnodedata.rst deleted file mode 100644 index a0981de..0000000 --- a/docs/ONAP Model Spec/im/logicalnodedata.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. 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: LogicalNodeData -====================== - -+-------------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=========================+=============+==================+=================+==========================+ -| logicalNodeRequirements | KeyValuePair| 0..N | The logical | support: | -| | | | node-level | MANDATORY | -| | | | compute, | | -| | | | memory and | | -| | | | I/O | | -| | | | requirements. | | -| | | | An array of | | -| | | | key-value | | -| | | | pairs that | | -| | | | articulate | | -| | | | the | | -| | | | deployment | | -| | | | requirements. | | -| | | | | | -| | | | This could | | -| | | | include the | | -| | | | number of | | -| | | | CPU cores | | -| | | | on this | | -| | | | logical | | -| | | | node, a | | -| | | | memory | | -| | | | configuration | | -| | | | 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. | | -+-------------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/vdu.rst b/docs/ONAP Model Spec/im/vdu.rst deleted file mode 100644 index f83ed43..0000000 --- a/docs/ONAP Model Spec/im/vdu.rst +++ /dev/null @@ -1,201 +0,0 @@ -.. 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: Vdu -========== - -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| **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 diff --git a/docs/ONAP Model Spec/im/vducpd.rst b/docs/ONAP Model Spec/im/vducpd.rst deleted file mode 100644 index e0247d4..0000000 --- a/docs/ONAP Model Spec/im/vducpd.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. 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: VduCpd -============= - -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================================+====================================+==================+==================+==========================+ -| bitrateRequirement | Number | 0..1 | Bitrate | support: | -| | (recommended | | requirement | MANDATORY | -| | DM type: Scalar-Unit-Rate) | | on this CP. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| vnicName | String | 0..1 | Describes | support: | -| | | | the name of | MANDATORY | -| | | | the vNIC | | -| | | | this CP | | -| | | | attaches | | -| | | | to, e.g. | | -| | | | eth0. It | | -| | | | will be | | -| | | | configured | | -| | | | during the | | -| | | | Vdu booting | | -| | | | process. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| vnicOrder | Integer | 0..1 | Describes | support: | -| | | | the order | MANDATORY | -| | | | to create | | -| | | | the vNIC | | -| | | | within the | | -| | | | scope of | | -| | | | this Vdu. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| vnicType | Enum | 0..1 | Describes | support: | -| | | | the type of | MANDATORY | -| | | | the vNIC | | -| | | | this CP | valueRange: | -| | | | attaches | normal, | -| | | | to. | macvtap, | -| | | | | direct, | -| | | | | baremetal, | -| | | | | direct-physical | -| | | | | and | -| | | | | virtio-forwarder | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| virtualNetworkInterfaceRequirements| VirtualNetworkInterfaceRequirements| 0..N | Specifies | support: | -| | | | requirements | MANDATORY | -| | | | on a | | -| | | | virtual | | -| | | | network | | -| | | | interface | | -| | | | realising | | -| | | | the CPs | | -| | | | instantiated | | -| | | | from this | | -| | | | CPD. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| (inherited | | | All | | -| attributes) | | | attributes | | -| | | | inherited | | -| | | | from Cpd. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/vduprofile.rst b/docs/ONAP Model Spec/im/vduprofile.rst deleted file mode 100644 index 2d7e64a..0000000 --- a/docs/ONAP Model Spec/im/vduprofile.rst +++ /dev/null @@ -1,152 +0,0 @@ -.. 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: VduProfile -================= - -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=================================+=================================+===================+=================+==========================+ -| vduId | Identifier | 1 | Uniquely | support: | -| | (Reference | | identifies | MANDATORY | -| | to Vdu) | | a VDU. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| minNumberOfInstances | Integer | 1 | Minimum | support: | -| | | | number of | MANDATORY | -| | | | instances | | -| | | | of the VNFC | | -| | | | based on | | -| | | | this VDU | | -| | | | that is | | -| | | | permitted | | -| | | | to exist | | -| | | | for this | | -| | | | flavour. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| maxNumberOfInstances | Integer | 1 | Maximum | support: | -| | | | number of | MANDATORY | -| | | | instances | | -| | | | of the VNFC | | -| | | | based on | | -| | | | this VDU | | -| | | | that is | | -| | | | permitted | | -| | | | to exist | | -| | | | for this | | -| | | | flavour. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..N | Specifies | support: | -| | | | affinity or | MANDATORY | -| | | | anti-affinity | | -| | | | rules | | -| | | | applicable | | -| | | | between the | | -| | | | virtualisation | | -| | | | 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-affinity | | -| | | | rule(s) | | -| | | | with | | -| | | | different | | -| | | | scopes | | -| | | | (e.g. | | -| | | | "Affinity | | -| | | | with the | | -| | | | scope | | -| | | | resource | | -| | | | zone and | | -| | | | anti-affinity | | -| | | | with the | | -| | | | scope NFVI | | -| | | | node") are | | -| | | | applicable | | -| | | | to the | | -| | | | virtualisation | | -| | | | containers | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machines) | | -| | | | to be | | -| | | | created | | -| | | | based on | | -| | | | this VDU. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| affinityOrAntiAffinityGroupId | Identifier | 0..N | Identifier(s) | support: | -| | | | of the | MANDATORY | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | group(s) | | -| | | | the VDU | | -| | | | belongs to. | | -| | | | | | -| | | | NOTE: Each | | -| | | | identifier | | -| | | | references | | -| | | | an affinity | | -| | | | or | | -| | | | anti-affinity | | -| | | | group which | | -| | | | expresses | | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | relationships | | -| | | | between the | | -| | | | virtualisation | | -| | | | container(s) | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machine(s)) | | -| | | | to be | | -| | | | created | | -| | | | using this | | -| | | | VDU and the | | -| | | | virtualisation | | -| | | | 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. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| vmBootUpTimeOut | Integer | 0..1 | Timeout | support: | -| | | | value for | OPTIONAL | -| | | | the VNFM to | | -| | | | wait before | | -| | | | the | | -| | | | successful | | -| | | | booting up | | -| | | | of the VDU. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtualcomputedesc.rst b/docs/ONAP Model Spec/im/virtualcomputedesc.rst deleted file mode 100644 index 081f90b..0000000 --- a/docs/ONAP Model Spec/im/virtualcomputedesc.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. 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: VirtualComputeDesc -========================= - -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===============================+===================================+==================+===================+==========================+ -| virtualComputeDescId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | VirtualComputeDesc| | -| | | | in the | | -| | | | VNFD. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| logicalNode | LogicalNodeData | 1..N | The logical | support: | -| | | | Node | MANDATORY | -| | | | requirements. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| requestAdditionalCapabilities | RequestedAdditionalCapabilityData | 0..N | Specifies | support: | -| | | | requirements | MANDATORY | -| | | | for | | -| | | | additional | | -| | | | capabilities. | | -| | | | These may | | -| | | | be for a | | -| | | | range of | | -| | | | purposes. | | -| | | | One example | | -| | | | is | | -| | | | acceleration | | -| | | | related | | -| | | | capabilities. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| computeRequirements | KeyValuePair | 0..N | Specifies | support: | -| | | | compute | MANDATORY | -| | | | requirements. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| virtualMemory | VirtualMemoryData | 1 | The virtual | support: | -| | | | memory of | MANDATORY | -| | | | the | | -| | | | virtualised | | -| | | | compute. | | -| | | | | | -| | | | | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| virtualCpu | VirtualCpuData | 1 | The virtual | support: | -| | | | CPU(s) of | MANDATORY | -| | | | the | | -| | | | virtualised | | -| | | | compute. | | -| | | | | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/virtualcpudata.rst b/docs/ONAP Model Spec/im/virtualcpudata.rst deleted file mode 100644 index 105614f..0000000 --- a/docs/ONAP Model Spec/im/virtualcpudata.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. 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: VirtualCpuData -===================== - -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+==================================+=======================+==================+=================+=========================+ -| cpuArchitecture | String | 0..1 | CPU | support: | -| | | | architecture | MANDATORY | -| | | | type. | | -| | | | Examples | | -| | | | are x86, | | -| | | | ARM. The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | CPU | | -| | | | architecture | | -| | | | type is | | -| | | | requested. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| numVirtualCpu | Integer | 1 | Number of | support: | -| | | | virtual | MANDATORY | -| | | | CPUs. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| virtualCpuClock | Number | 0..1 | Minimum | support: | -| | (recommended | | virtual CPU | MANDATORY | -| | DM type: | | clock rate | | -| | Scalar-Unit-Freq) | | (e.g. in | | -| | | | MHz). The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| virtualCpuOversubscriptionPolicy | String | 0..1 | The CPU | support: | -| | | | core | MANDATORY | -| | | | oversubscription| | -| | | | policy e.g. | | -| | | | the | | -| | | | relation of | | -| | | | virtual CPU | | -| | | | cores to | | -| | | | physical | | -| | | | CPU | | -| | | | cores/threads. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| vduCpuRequirements | KeyValuePair | 0..N | Array of | support: | -| | | | key-value | MANDATORY | -| | | | pair | | -| | | | requirements | | -| | | | on the | | -| | | | Compute | | -| | | | (CPU) for | | -| | | | the VDU. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| virtualCpuPinning | VirtualCpuPinningData | 0..1 | The virtual | support: | -| | | | CPU pinning | MANDATORY | -| | | | configuration | | -| | | | for the | | -| | | | virtualised | | -| | | | compute | | -| | | | resource. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ diff --git a/docs/ONAP Model Spec/im/virtuallinkdescflavour.rst b/docs/ONAP Model Spec/im/virtuallinkdescflavour.rst deleted file mode 100644 index e617bfe..0000000 --- a/docs/ONAP Model Spec/im/virtuallinkdescflavour.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. 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: VirtualLinkDescFlavour -============================= - -+-------------------+-------------+------------------+---------------------+--------------------------+ -| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================+=============+==================+=====================+==========================+ -| flavourId | Identifier | 1 | Identifies | support: | -| | | | a flavour | MANDATORY | -| | | | within a | | -| | | | VnfVirtualLinkDesc. | | -+-------------------+-------------+------------------+---------------------+--------------------------+ -| qos | QoS | 0..1 | QoS of the | support: | -| | | | VL. | MANDATORY | -+-------------------+-------------+------------------+---------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtuallinkprofile.rst b/docs/ONAP Model Spec/im/virtuallinkprofile.rst deleted file mode 100644 index 46addd5..0000000 --- a/docs/ONAP Model Spec/im/virtuallinkprofile.rst +++ /dev/null @@ -1,152 +0,0 @@ -.. 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: VirtualLinkProfile -========================= - -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=================================+=================================+==================+=======================+==========================+ -| vnfVirtualLinkDescId | Identifier | 1 | Uniquely | support: | -| | (Reference | | identifies | MANDATORY | -| | to | | a Vnf VLD. | | -| | VnfVirtualLinkDesc) | | | | -| | | | | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| flavourId | Identifier | 1 | Identifies | support: | -| | (Reference | | a flavour | MANDATORY | -| | to | | within the | | -| | VirtualLinkDescFlavour) | | VnfVirtualLinkDesc. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..N | Specifies | support: | -| | | | affinity or | MANDATORY | -| | | | anti-affinity | | -| | | | rules | | -| | | | applicable | | -| | | | between the | | -| | | | VLs based | | -| | | | on this | | -| | | | VnfVirtualLinkDesc. | | -| | | | | | -| | | | When the | | -| | | | cardinality | | -| | | | is greater | | -| | | | than 1, | | -| | | | both | | -| | | | affinity | | -| | | | rule(s) and | | -| | | | anti-affinity | | -| | | | rule(s) with | | -| | | | different | | -| | | | scopes are | | -| | | | applicable | | -| | | | to the VLs | | -| | | | based on this | | -| | | | VnfVirtualLinkDesc. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| affinityOrAntiAffinityGroupId | Identifier | 0..N | Identifier(s) | support: | -| | | | of the | MANDATORY | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | group(s) the | | -| | | | VnfVirtualLinkDesc | | -| | | | belongs to. | | -| | | | | | -| | | | NOTE: Each | | -| | | | identifier | | -| | | | references | | -| | | | an affinity | | -| | | | or | | -| | | | anti-affinity | | -| | | | group which | | -| | | | expresses | | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | relationship | | -| | | | between the | | -| | | | VL(s) using | | -| | | | this | | -| | | | VnfVirtualLinkDesc | | -| | | | and the | | -| | | | VL(s) using | | -| | | | other | | -| | | | VnfVirtualLinkDesc(s) | | -| | | | in the same group. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| maxBitRateRequirements | LinkBitrateRequirements | 1 | Specifies | support: | -| | | | the maximum | MANDATORY | -| | | | bitrate | | -| | | | requirements | | -| | | | for a VL | | -| | | | instantiated | | -| | | | according | | -| | | | to this | | -| | | | profile. | | -| | | | | | -| | | | NOTE: These | | -| | | | attributes | | -| | | | are used to | | -| | | | control | | -| | | | scaling | | -| | | | boundaries. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| minBitRateRequirements | LinkBitrateRequirements | 1 | Specifies | support: | -| | | | the minimum | MANDATORY | -| | | | bitrate | | -| | | | requirements | | -| | | | for a VL | | -| | | | instantiated | | -| | | | according | | -| | | | to this | | -| | | | profile. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| initiationParameters | KeyValuePair | 0..N | Specifies | support: | -| | | | initiation | MANDATORY | -| | | | parameters | | -| | | | for the | valueRange: | -| | | | virtual | specified | -| | | | link. | values | -| | | | | include: | -| | | | | cidr, | -| | | | | allocationPools | -| | | | | (represented | -| | | | | by | -| | | | | [starting | -| | | | | ip address, | -| | | | | ending ip | -| | | | | address]), | -| | | | | gatewayIp, | -| | | | | networkName, | -| | | | | segmentationId, | -| | | | | physicalNetwork. | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| networkType | Enum | 0..1 | Type of the | support: | -| | | | network. | MANDATORY | -| | | | | | -| | | | | valueRange: | -| | | | | "VLAN", | -| | | | | "VXLAN" | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| dhcpEnabled | Boolean | 0..1 | Indicating | support: | -| | | | whether | MANDATORY | -| | | | DHCP is | | -| | | | enabled. | | -| | | | Default is | | -| | | | "FALSE" if | | -| | | | not | | -| | | | specified | | -| | | | otherwise. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| vlanTransparent | Boolean | 0..1 | Indicating | support: | -| | | | whether | MANDATORY | -| | | | "VLAN | | -| | | | Transparent | | -| | | | Mode" is | | -| | | | supported. | | -| | | | Default is | | -| | | | "FALSE" if | | -| | | | not | | -| | | | specified | | -| | | | otherwise. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtualmemorydata.rst b/docs/ONAP Model Spec/im/virtualmemorydata.rst deleted file mode 100644 index 0719a87..0000000 --- a/docs/ONAP Model Spec/im/virtualmemorydata.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. 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: VirtualMemoryData -======================== - -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+==================================+===================+==================+=================+=========================+ -| virtualMemSize | Number | 1 | Amount of | support: | -| | (recommended | | virtual | MANDATORY | -| | DM type: | | Memory | | -| | Scalar-Unit-Size) | | (e.g. in | | -| | | | MB). | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| virtualMemOversubscriptionPolicy | String | 0..1 | The memory | support: | -| | | | core | MANDATORY | -| | | | oversubscription| | -| | | | policy in | | -| | | | terms of | | -| | | | virtual | | -| | | | memory to | | -| | | | physical | | -| | | | memory on | | -| | | | the | | -| | | | platform. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| vduMemRequirements | KeyValuePair | 0..N | Array of | support: | -| | | | key-value | MANDATORY | -| | | | pair | | -| | | | requirements | | -| | | | on the | | -| | | | memory for | | -| | | | the VDU. | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| numaEnabled | Boolean | 0..1 | It | support: | -| | | | specifies | MANDATORY | -| | | | the memory | | -| | | | allocation | | -| | | | to be | | -| | | | cognisant | | -| | | | of the | | -| | | | relevant | | -| | | | process/core | | -| | | | allocation. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst b/docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst deleted file mode 100644 index 4e13ddd..0000000 --- a/docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. 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: VirtualNetworkInterfaceRequirements -========================================== - -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+==============================+==================+==================+=================+==========================+ -| name | String | 0..1 | Provides a | support: | -| | | | human | MANDATORY | -| | | | readable | | -| | | | name for | | -| | | | the | | -| | | | requirement. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| description | String | 0..1 | Provides a | support: | -| | | | human | MANDATORY | -| | | | readable | | -| | | | description | | -| | | | of the | | -| | | | requirement. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| supportMandatory | Boolean | 1 | Indicates | support: | -| | | | whether | MANDATORY | -| | | | fulfilling | | -| | | | the | | -| | | | constraint | | -| | | | is | | -| | | | mandatory | | -| | | | (TRUE) for | | -| | | | successful | | -| | | | operation | | -| | | | or | | -| | | | desirable | | -| | | | (FALSE). | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| networkInterfaceRequirements | KeyValuePair | 0..N | The network | support: | -| | | | interface | MANDATORY | -| | | | requirements. | | -| | | | An element | | -| | | | from an | | -| | | | array of | | -| | | | key-value | | -| | | | pairs that | | -| | | | articulate | | -| | | | the network | | -| | | | interface | | -| | | | deployment | | -| | | | requirements. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| nicIoRequirements | Identifier | 0..1 | This | support: | -| | (reference | | references | MANDATORY | -| | to | | (couples) | | -| | logicalNodeData) | | the CPD | | -| | | | with any | | -| | | | logical | | -| | | | node I/O | | -| | | | requirements | | -| | | | (for | | -| | | | network | | -| | | | devices) | | -| | | | that may | | -| | | | have been | | -| | | | created. | | -| | | | Linking | | -| | | | these | | -| | | | attributes | | -| | | | is | | -| | | | necessary | | -| | | | so that so | | -| | | | that I/O | | -| | | | requirements | | -| | | | that need | | -| | | | to be | | -| | | | articulated | | -| | | | at the | | -| | | | logical | | -| | | | node level | | -| | | | can be | | -| | | | associated | | -| | | | with the | | -| | | | network | | -| | | | interface | | -| | | | requirements | | -| | | | associated | | -| | | | with the | | -| | | | CPD. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtualstoragedesc.rst b/docs/ONAP Model Spec/im/virtualstoragedesc.rst deleted file mode 100644 index 4e0370e..0000000 --- a/docs/ONAP Model Spec/im/virtualstoragedesc.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. 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: VirtualStorageDesc -========================= - -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+========================+===================+==================+=====================+=========================+ -| id | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | VirtualStorageDesc | | -| | | | in the | | -| | | | VNFD. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| typeOfStorage | String | 1 | Type of | support: | -| | | | virtualised | MANDATORY | -| | | | storage | | -| | | | resource | | -| | | | (e.g. | | -| | | | volume, | | -| | | | object). | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| sizeOfStorage | Number | 1 | Size of | support: | -| | (recommended | | virtualised | MANDATORY | -| | DM type: | | storage | | -| | Scalar-Unit-Size) | | resource | | -| | | | (e.g. size | | -| | | | of volume, | | -| | | | in GB). | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| vduStorageRequirements | KeyValuePair | 0..N | An array of | support: | -| | | | key-value | MANDATORY | -| | | | pairs that | | -| | | | articulate | | -| | | | the storage | | -| | | | deployment | | -| | | | requirements. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| rdmaEnabled | Boolean | 0..1 | Indicate if | support: | -| | | | the storage | MANDATORY | -| | | | support | | -| | | | RDMA. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| swImageDesc | Identifier | 0..1 | Software | support: | -| | (Reference | | image to be | MANDATORY | -| | to | | loaded on | | -| | SwImageDesc) | | the | | -| | | | VirtualStorage | | -| | | | resource | | -| | | | created | | -| | | | based on | | -| | | | this | | -| | | | VirtualStorageDesc. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/vnfd.rst b/docs/ONAP Model Spec/im/vnfd.rst deleted file mode 100644 index 5a8d22d..0000000 --- a/docs/ONAP Model Spec/im/vnfd.rst +++ /dev/null @@ -1,309 +0,0 @@ -.. 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 -=========== - -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| **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. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ diff --git a/docs/ONAP Model Spec/im/vnfdf.rst b/docs/ONAP Model Spec/im/vnfdf.rst deleted file mode 100644 index c78de9f..0000000 --- a/docs/ONAP Model Spec/im/vnfdf.rst +++ /dev/null @@ -1,210 +0,0 @@ -.. 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: 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 | -| | | | 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 diff --git a/docs/ONAP Model Spec/im/vnfextcpd.rst b/docs/ONAP Model Spec/im/vnfextcpd.rst deleted file mode 100644 index 8a34c7c..0000000 --- a/docs/ONAP Model Spec/im/vnfextcpd.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. 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: VnfExtCpd -================ - -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=====================================+=====================================+==================+=====================================+==========================+ -| intCpd | Identifier | 0..1 | Reference | support: | -| | (Reference | | to the | MANDATORY | -| | to VduCpd) | | internal | | -| | | | VDU CPD | | -| | | | which is | | -| | | | used to | | -| | | | instantiate | | -| | | | internal | | -| | | | CPs. These | | -| | | | internal | | -| | | | CPs are, in | | -| | | | turn, | | -| | | | exposed as | | -| | | | external | | -| | | | CPs defined | | -| | | | by this | | -| | | | external | | -| | | | CPD. | | -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ -| virtualNetworkInterfaceRequirements | VirtualNetworkInterfaceRequirements | 0..N | Specifies | support: | -| | | | requirements | MANDATORY | -| | | | on a | | -| | | | virtual | | -| | | | network | | -| | | | interface | | -| | | | realising | | -| | | | the CPs | | -| | | | instantiated | | -| | | | from this | | -| | | | CPD. | | -| | | | | | -| | | | NOTE: In | | -| | | | case of | | -| | | | referencing | | -| | | | an intCpd | | -| | | | via its | | -| | | | identifier, | | -| | | | the | | -| | | | virtualNetworkInterfaceRequirements | | -| | | | attribute | | -| | | | of the | | -| | | | referenced | | -| | | | intCpd | | -| | | | applies. | | -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ -| (inherited | | | All | | -| attributes) | | | attributes | | -| | | | inherited | | -| | | | from Cpd. | | -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ -
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst b/docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst deleted file mode 100644 index c818fa1..0000000 --- a/docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. 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: VnfVirtualLinkDesc -========================= - -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=======================+=======================+==================+=================+==========================+ -| virtualLinkDescId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | internal | | -| | | | VLD in | | -| | | | VNFD. | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| virtualLinkDescFlavour| VirtualLinkDescFlavour| 1..N | Describes a | support: | -| | | | specific | MANDATORY | -| | | | flavour of | | -| | | | the VL with | | -| | | | specific | | -| | | | bitrate | | -| | | | requirements. | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| connectivityType | ConnectivityType | 1 | | support: | -| | | | | MANDATORY | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| testAccess | String | 0..N | Specifies | support: | -| | | | test access | MANDATORY | -| | | | facilities | | -| | | | expected on | | -| | | | the VL | | -| | | | (e.g. none, | | -| | | | passive | | -| | | | monitoring, | | -| | | | or active | | -| | | | (intrusive) | | -| | | | loopbacks | | -| | | | at | | -| | | | endpoints). | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| description | String | 0..1 | Provides | support: | -| | | | human-readable | MANDATORY | -| | | | information | | -| | | | on the | | -| | | | purpose of | | -| | | | the VL | | -| | | | (e.g. | | -| | | | control | | -| | | | plane | | -| | | | traffic). | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| monitoringParameter | MonitoringParameter | 0..N | Defines the | support: | -| | | | virtualised | MANDATORY | -| | | | resources | | -| | | | monitoring | | -| | | | parameters | | -| | | | on VLD | | -| | | | level. | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -
\ No newline at end of file |