diff options
| author |   Victor Gao <victor.gao@huawei.com> | 2018-06-04 16:05:09 +0800 |
|---|---|---|
| committer | Victor Gao <victor.gao@huawei.com> | 2018-06-04 16:05:09 +0800 |
| commit | 709de031ede9d9407a4830317b2c6c5f8969025b (patch) | |
| tree | 89412859fd15d9d785c405df327707ff6a1e8f27 /docs/ONAP Model Spec/im | |
| parent | 78f70a2be21b22775d11a312b6bde26b31beb7c6 (diff) | |
handle model spec by branches2.0.0-ONAPbeijing2.0.0-ONAP
Change-Id: I4ac13c55261be3e347b00c46fc21d721f8c3332b
Issue-ID: MODELING-79
Signed-off-by: Victor Gao <victor.gao@huawei.com>
Diffstat (limited to 'docs/ONAP Model Spec/im')
42 files changed, 3057 insertions, 0 deletions
diff --git a/docs/ONAP Model Spec/im/AddressData.rst b/docs/ONAP Model Spec/im/AddressData.rst new file mode 100644 index 0000000..a3e703d --- /dev/null +++ b/docs/ONAP Model Spec/im/AddressData.rst @@ -0,0 +1,60 @@ +.. 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 new file mode 100644 index 0000000..a2c8d72 --- /dev/null +++ b/docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst @@ -0,0 +1,35 @@ +.. 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 new file mode 100644 index 0000000..2397c0e --- /dev/null +++ b/docs/ONAP Model Spec/im/BaseConfigGroup.rst @@ -0,0 +1,6 @@ +.. 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 new file mode 100644 index 0000000..d47a1be --- /dev/null +++ b/docs/ONAP Model Spec/im/ConnectivityType.rst @@ -0,0 +1,27 @@ +.. 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 new file mode 100644 index 0000000..c9cf840 --- /dev/null +++ b/docs/ONAP Model Spec/im/CpProtocolData.rst @@ -0,0 +1,26 @@ +.. 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 new file mode 100644 index 0000000..4dd8b1e --- /dev/null +++ b/docs/ONAP Model Spec/im/DeploymentGroup.rst @@ -0,0 +1,8 @@ +.. 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 new file mode 100644 index 0000000..d4620df --- /dev/null +++ b/docs/ONAP Model Spec/im/L2AddressData.rst @@ -0,0 +1,35 @@ +.. 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 new file mode 100644 index 0000000..ccb651f --- /dev/null +++ b/docs/ONAP Model Spec/im/L3AddressData.rst @@ -0,0 +1,56 @@ +.. 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 new file mode 100644 index 0000000..b7ce432 --- /dev/null +++ b/docs/ONAP Model Spec/im/LifecycleManagementScript.rst @@ -0,0 +1,165 @@ +.. 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 new file mode 100644 index 0000000..57d1f63 --- /dev/null +++ b/docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst @@ -0,0 +1,27 @@ +.. 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 new file mode 100644 index 0000000..9dfc5b9 --- /dev/null +++ b/docs/ONAP Model Spec/im/MonitoringParameter.rst @@ -0,0 +1,80 @@ +.. 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 new file mode 100644 index 0000000..db8008b --- /dev/null +++ b/docs/ONAP Model Spec/im/PlacementGroup.rst @@ -0,0 +1,84 @@ +.. 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 new file mode 100644 index 0000000..8f64127 --- /dev/null +++ b/docs/ONAP Model Spec/im/QoS.rst @@ -0,0 +1,26 @@ +.. 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 new file mode 100644 index 0000000..ce9ab2f --- /dev/null +++ b/docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst @@ -0,0 +1,61 @@ +.. 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 new file mode 100644 index 0000000..14f74cf --- /dev/null +++ b/docs/ONAP Model Spec/im/ScaleInfo.rst @@ -0,0 +1,21 @@ +.. 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 new file mode 100644 index 0000000..2add32f --- /dev/null +++ b/docs/ONAP Model Spec/im/SwImageDesc.rst @@ -0,0 +1,144 @@ +.. 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 new file mode 100644 index 0000000..8d86ba4 --- /dev/null +++ b/docs/ONAP Model Spec/im/VduLevel.rst @@ -0,0 +1,24 @@ +.. 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 new file mode 100644 index 0000000..d1876bc --- /dev/null +++ b/docs/ONAP Model Spec/im/VirtualCpuPinningData.rst @@ -0,0 +1,46 @@ +.. 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 new file mode 100644 index 0000000..3dd6c92 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfConfigurableProperties.rst @@ -0,0 +1,60 @@ +.. 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 new file mode 100644 index 0000000..d06bdf6 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfIndicator.rst @@ -0,0 +1,39 @@ +.. 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 new file mode 100644 index 0000000..94bb5cd --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst @@ -0,0 +1,27 @@ +.. 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 new file mode 100644 index 0000000..5676b25 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst @@ -0,0 +1,33 @@ +.. 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/VnfdElementGroup.rst b/docs/ONAP Model Spec/im/VnfdElementGroup.rst new file mode 100644 index 0000000..89c6125 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfdElementGroup.rst @@ -0,0 +1,35 @@ +.. 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 new file mode 100644 index 0000000..be0177e --- /dev/null +++ b/docs/ONAP Model Spec/im/cpd.rst @@ -0,0 +1,109 @@ +.. 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 new file mode 100644 index 0000000..e38744d --- /dev/null +++ b/docs/ONAP Model Spec/im/index.rst @@ -0,0 +1,55 @@ +.. 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 +.. onap-documentation documentation master file, created by + sphinx-quickstart on Mon Sep 18 15:12:14 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +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 diff --git a/docs/ONAP Model Spec/im/instantiationlevel.rst b/docs/ONAP Model Spec/im/instantiationlevel.rst new file mode 100644 index 0000000..a36998a --- /dev/null +++ b/docs/ONAP Model Spec/im/instantiationlevel.rst @@ -0,0 +1,76 @@ +.. 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 new file mode 100644 index 0000000..ab2c497 --- /dev/null +++ b/docs/ONAP Model Spec/im/linkbitraterequirements.rst @@ -0,0 +1,52 @@ +.. 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 new file mode 100644 index 0000000..a0981de --- /dev/null +++ b/docs/ONAP Model Spec/im/logicalnodedata.rst @@ -0,0 +1,53 @@ +.. 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 new file mode 100644 index 0000000..f83ed43 --- /dev/null +++ b/docs/ONAP Model Spec/im/vdu.rst @@ -0,0 +1,201 @@ +.. 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 new file mode 100644 index 0000000..e0247d4 --- /dev/null +++ b/docs/ONAP Model Spec/im/vducpd.rst @@ -0,0 +1,64 @@ +.. 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 new file mode 100644 index 0000000..2d7e64a --- /dev/null +++ b/docs/ONAP Model Spec/im/vduprofile.rst @@ -0,0 +1,152 @@ +.. 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 new file mode 100644 index 0000000..081f90b --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualcomputedesc.rst @@ -0,0 +1,56 @@ +.. 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 new file mode 100644 index 0000000..105614f --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualcpudata.rst @@ -0,0 +1,86 @@ +.. 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 new file mode 100644 index 0000000..e617bfe --- /dev/null +++ b/docs/ONAP Model Spec/im/virtuallinkdescflavour.rst @@ -0,0 +1,18 @@ +.. 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 new file mode 100644 index 0000000..46addd5 --- /dev/null +++ b/docs/ONAP Model Spec/im/virtuallinkprofile.rst @@ -0,0 +1,152 @@ +.. 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 new file mode 100644 index 0000000..0719a87 --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualmemorydata.rst @@ -0,0 +1,68 @@ +.. 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 new file mode 100644 index 0000000..4e13ddd --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst @@ -0,0 +1,90 @@ +.. 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 new file mode 100644 index 0000000..4e0370e --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualstoragedesc.rst @@ -0,0 +1,58 @@ +.. 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 new file mode 100644 index 0000000..5a8d22d --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfd.rst @@ -0,0 +1,309 @@ +.. 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 new file mode 100644 index 0000000..c78de9f --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfdf.rst @@ -0,0 +1,210 @@ +.. 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 new file mode 100644 index 0000000..8a34c7c --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfextcpd.rst @@ -0,0 +1,61 @@ +.. 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 new file mode 100644 index 0000000..c818fa1 --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst @@ -0,0 +1,62 @@ +.. 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 |