diff options
| author |   guochuyi <guochuyi@chinamobile.com> | 2018-05-29 11:03:21 +0800 |
|---|---|---|
| committer | guochuyi <guochuyi@chinamobile.com> | 2018-05-29 15:00:28 +0800 |
| commit | 3ce3ff13fd81eb8e2b872feda910747a2411d18c (patch) | |
| tree | a93c7eb395a20ec01e184c733bac7cdbb7632ff5 | |
| parent | d7e47624d805422dbb637f38177209ef638aa12b (diff) | |
Convert doc and pdf document to rst format.
Change-Id: Ib131e30084d777b81e5fd12986fabdfe21a802c7
Issue-ID: MODELING-46
Signed-off-by: guochuyi <guochuyi@chinamobile.com>
49 files changed, 1933 insertions, 2197 deletions
diff --git a/docs/ONAP release 2 spec/dm/ArtifactTypes.rst b/docs/ONAP release 2 spec/dm/ArtifactTypes.rst index 7f42933..36a9759 100644 --- a/docs/ONAP release 2 spec/dm/ArtifactTypes.rst +++ b/docs/ONAP release 2 spec/dm/ArtifactTypes.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (ONAP) +.. 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 Artifact Types -============================================== +============== | tosca.artifacts.nfv.SwImage: #don't need move to clean version | derived_from: tosca.artifacts.Deployment.Image
\ No newline at end of file diff --git a/docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst b/docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst index bbd7b99..d8ed14e 100644 --- a/docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst +++ b/docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst @@ -1,9 +1,10 @@ -.. Copyright 2018 (ONAP) +.. 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 Capabilities Types -============================================== +================== + | **tosca.capabilities.nfv.VirtualBindable:** | derived_from: tosca.capabilities.root diff --git a/docs/ONAP release 2 spec/dm/DataTypes.rst b/docs/ONAP release 2 spec/dm/DataTypes.rst index 338acf5..3821cf5 100644 --- a/docs/ONAP release 2 spec/dm/DataTypes.rst +++ b/docs/ONAP release 2 spec/dm/DataTypes.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (ONAP) +.. 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 Data Types -============================================== +========== | **tosca.datatypes.nfv.L2AddressData:** | derived_from: tosca.datatypes.Root diff --git a/docs/ONAP release 2 spec/dm/InterfaceTypes.rst b/docs/ONAP release 2 spec/dm/InterfaceTypes.rst index 66091cf..f4783a9 100644 --- a/docs/ONAP release 2 spec/dm/InterfaceTypes.rst +++ b/docs/ONAP release 2 spec/dm/InterfaceTypes.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (ONAP) +.. 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 Interface Types -============================================== +=============== | **tosca.interfaces.nfv.vnf.lifecycle.Nfv** | derived_from: tosca.interfaces.Root diff --git a/docs/ONAP release 2 spec/dm/NodeTypes.rst b/docs/ONAP release 2 spec/dm/NodeTypes.rst index ae3b1fa..bdbdce5 100644 --- a/docs/ONAP release 2 spec/dm/NodeTypes.rst +++ b/docs/ONAP release 2 spec/dm/NodeTypes.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (ONAP) +.. 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 Node Types -============================================== +========== | **tosca.nodes.nfv.Vdu.Compute:** | derived_from: tosca.nodes.Root diff --git a/docs/ONAP release 2 spec/dm/RelationshipTypes.rst b/docs/ONAP release 2 spec/dm/RelationshipTypes.rst index 590b097..1c9965b 100644 --- a/docs/ONAP release 2 spec/dm/RelationshipTypes.rst +++ b/docs/ONAP release 2 spec/dm/RelationshipTypes.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (ONAP) +.. 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 Relationships Types -============================================== +=================== | **tosca.relationships.nfv.VirtualBindsTo:** | derived_from: tosca.relationships.DependsOn diff --git a/docs/ONAP release 2 spec/dm/index.rst b/docs/ONAP release 2 spec/dm/index.rst index 083c23b..bc44519 100644 --- a/docs/ONAP release 2 spec/dm/index.rst +++ b/docs/ONAP release 2 spec/dm/index.rst @@ -7,7 +7,7 @@ contain the root `toctree` directive. ONAP Data Model Specifications -============================================== +============================== .. toctree:: :titlesonly: diff --git a/docs/ONAP release 2 spec/im/AddressData.rst b/docs/ONAP release 2 spec/im/AddressData.rst index 51bef0d..a3e703d 100644 --- a/docs/ONAP release 2 spec/im/AddressData.rst +++ b/docs/ONAP release 2 spec/im/AddressData.rst @@ -1,10 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst b/docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst index 58c7ffc..a2c8d72 100644 --- a/docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst +++ b/docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/BaseConfigGroup.rst b/docs/ONAP release 2 spec/im/BaseConfigGroup.rst index 01d1c0b..2397c0e 100644 --- a/docs/ONAP release 2 spec/im/BaseConfigGroup.rst +++ b/docs/ONAP release 2 spec/im/BaseConfigGroup.rst @@ -1,6 +1,6 @@ -.. Copyright 2018 (Huawei) +.. 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 release 2 spec/im/ConnectivityType.rst b/docs/ONAP release 2 spec/im/ConnectivityType.rst index b940a4d..d47a1be 100644 --- a/docs/ONAP release 2 spec/im/ConnectivityType.rst +++ b/docs/ONAP release 2 spec/im/ConnectivityType.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/CpProtocolData.rst b/docs/ONAP release 2 spec/im/CpProtocolData.rst index 94397ed..c9cf840 100644 --- a/docs/ONAP release 2 spec/im/CpProtocolData.rst +++ b/docs/ONAP release 2 spec/im/CpProtocolData.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/DeploymentGroup.rst b/docs/ONAP release 2 spec/im/DeploymentGroup.rst index afb0c1c..4eafe29 100644 --- a/docs/ONAP release 2 spec/im/DeploymentGroup.rst +++ b/docs/ONAP release 2 spec/im/DeploymentGroup.rst @@ -1,5 +1,6 @@ -.. Copyright 2018 (Huawei) +.. 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) +===================================== diff --git a/docs/ONAP release 2 spec/im/L2AddressData.rst b/docs/ONAP release 2 spec/im/L2AddressData.rst index 45fee8f..d4620df 100644 --- a/docs/ONAP release 2 spec/im/L2AddressData.rst +++ b/docs/ONAP release 2 spec/im/L2AddressData.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/L3AddressData.rst b/docs/ONAP release 2 spec/im/L3AddressData.rst index f358594..ccb651f 100644 --- a/docs/ONAP release 2 spec/im/L3AddressData.rst +++ b/docs/ONAP release 2 spec/im/L3AddressData.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst b/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst index 67362bb..b7ce432 100644 --- a/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst +++ b/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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** | diff --git a/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst b/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst index 77860ca..57d1f63 100644 --- a/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst +++ b/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/MonitoringParameter.rst b/docs/ONAP release 2 spec/im/MonitoringParameter.rst index e010e46..9dfc5b9 100644 --- a/docs/ONAP release 2 spec/im/MonitoringParameter.rst +++ b/docs/ONAP release 2 spec/im/MonitoringParameter.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/PlacementGroup.rst b/docs/ONAP release 2 spec/im/PlacementGroup.rst index b297441..db8008b 100644 --- a/docs/ONAP release 2 spec/im/PlacementGroup.rst +++ b/docs/ONAP release 2 spec/im/PlacementGroup.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/QoS.rst b/docs/ONAP release 2 spec/im/QoS.rst index 8d02766..8f64127 100644 --- a/docs/ONAP release 2 spec/im/QoS.rst +++ b/docs/ONAP release 2 spec/im/QoS.rst @@ -1,21 +1,21 @@ -.. Copyright 2018 (Huawei) +.. 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 | Number | 1 | Maximum | support: | | | | | latency in ms. | MANDATORY | +--------------------+-------------+------------------+-----------------+---------------+ |packetDelayVariation| Number | 1 | Maximum | support: | | | | | jitter in ms. | MANDATORY | +--------------------+-------------+------------------+-----------------+---------------+ -| packetLossRatio | Number | 0..1 | Maximum | support: | +|packetLossRatio | Number | 0..1 | Maximum | support: | | | | | packet loss | MANDATORY | | | | | ratio. | | | | | | Cardinality | | diff --git a/docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst b/docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst index 7ae348a..ce9ab2f 100644 --- a/docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst +++ b/docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/ScaleInfo.rst b/docs/ONAP release 2 spec/im/ScaleInfo.rst index ab3cfb8..14f74cf 100644 --- a/docs/ONAP release 2 spec/im/ScaleInfo.rst +++ b/docs/ONAP release 2 spec/im/ScaleInfo.rst @@ -2,25 +2,20 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: ScaleInfo ================ -+--------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+=================+==========================+ -| aspectId | Identifier | 1 | Reference | support: | -| | (Reference | | to the | MANDATORY | -| | to | | scaling | | -| | ScalingAspe | | aspect. | | -| | ct) | | | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| scaleLevel | Integer | 1 | The scale | support: | -| | | | level, | MANDATORY | -| | | | greater | | -| | | | than or | | -| | | | equal to 0. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ ++--------------------+----------------+------------------+-----------------+--------------------------+ +| **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 release 2 spec/im/SwImageDesc.rst b/docs/ONAP release 2 spec/im/SwImageDesc.rst index 2508fde..2add32f 100644 --- a/docs/ONAP release 2 spec/im/SwImageDesc.rst +++ b/docs/ONAP release 2 spec/im/SwImageDesc.rst @@ -2,151 +2,143 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: 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. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| containerFo | String | 1 | The | support: | -| rmat | | | 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: | -| | (recommende | | disk size | MANDATORY | -| | d | | requirement | | -| | DM type: | | for this | | -| | Scalar-Unit | | software | | -| | -Size) | | image. The | | -| | | | value of | | -| | | | the "size | | -| | | | of storage" | | -| | | | attribute | | -| | | | of the | | -| | | | VirtualStor | | -| | | | ageDesc | | -| | | | referencing | | -| | | | this | | -| | | | SwImageDesc | | -| | | | shall not | | -| | | | be smaller | | -| | | | than the | | -| | | | value of | | -| | | | minDisk. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| minRam | Number | 0..1 | The minimal | support: | -| | (recommende | | RAM | MANDATORY | -| | d | | requirement | | -| | DM type: | | for this | | -| | Scalar-Unit | | software | | -| | -Size) | | image. The | | -| | | | value of | | -| | | | the "size" | | -| | | | attribute | | -| | | | of | | -| | | | VirtualMemo | | -| | | | ryData | | -| | | | of the Vdu | | -| | | | referencing | | -| | | | this | | -| | | | SwImageDesc | | -| | | | shall not | | -| | | | be smaller | | -| | | | than the | | -| | | | value of | | -| | | | minRam. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| size | Number | 1 | The size of | support: | -| | (recommende | | this | MANDATORY | -| | d | | software | | -| | DM type: | | image. | | -| | Scalar-Unit | | | | -| | -Size) | | | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| 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. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| operatingSy | String | 0..1 | Identifies | support: | -| stem | | | 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. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| supportedVi | String | 0..N | Identifies | support: | -| rtualisatio | | | the | MANDATORY | -| nEnvironmen | | | virtualisat | | -| t | | | ion | | -| | | | environment | | -| | | | s | | -| | | | (e.g. | | -| | | | hypervisor) | | -| | | | compatible | | -| | | | with this | | -| | | | software | | -| | | | image. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| **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 release 2 spec/im/VduLevel.rst b/docs/ONAP release 2 spec/im/VduLevel.rst index 981906e..8d86ba4 100644 --- a/docs/ONAP release 2 spec/im/VduLevel.rst +++ b/docs/ONAP release 2 spec/im/VduLevel.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst b/docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst index 3e39d60..d1876bc 100644 --- a/docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst +++ b/docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst b/docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst index 775a48c..3dd6c92 100644 --- a/docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst +++ b/docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/VnfIndicator.rst b/docs/ONAP release 2 spec/im/VnfIndicator.rst index 63d08eb..d06bdf6 100644 --- a/docs/ONAP release 2 spec/im/VnfIndicator.rst +++ b/docs/ONAP release 2 spec/im/VnfIndicator.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst b/docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst index 51c59f0..94bb5cd 100644 --- a/docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst +++ b/docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst b/docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst index 1955197..5676b25 100644 --- a/docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst +++ b/docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/VnfdElementGroup.rst b/docs/ONAP release 2 spec/im/VnfdElementGroup.rst index 270e8d7..89c6125 100644 --- a/docs/ONAP release 2 spec/im/VnfdElementGroup.rst +++ b/docs/ONAP release 2 spec/im/VnfdElementGroup.rst @@ -1,9 +1,9 @@ -.. Copyright 2018 (Huawei) +.. 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 | diff --git a/docs/ONAP release 2 spec/im/cpd.rst b/docs/ONAP release 2 spec/im/cpd.rst index f004b6b..be0177e 100644 --- a/docs/ONAP release 2 spec/im/cpd.rst +++ b/docs/ONAP release 2 spec/im/cpd.rst @@ -2,117 +2,108 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: Cpd +========== -Class: Cpd/CPDesc -================= - -+--------------------+-------------+------------------+-----------------+--------------------------+ -| **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-reada | MANDATORY | -| | | | ble | | -| | | | information | | -| | | | on the | | -| | | | purpose of | | -| | | | the CP | | -| | | | (e.g. CP | | -| | | | for control | | -| | | | plane | | -| | | | traffic). | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| cpProtocol | CpProtocolD | 1..N | Identifies | support: | -| | ata | | the | MANDATORY | -| | | | protocol | | -| | | | layering | | -| | | | information | | -| | | | the CP uses | | -| | | | for | | -| | | | connectivit | | -| | | | y | | -| | | | purposes | | -| | | | and | | -| | | | associated | | -| | | | information | | -| | | | . | | -| | | | There shall | | -| | | | be one | | -| | | | cpProtocol | | -| | | | for each | | -| | | | layer | | -| | | | protocol as | | -| | | | indicated | | -| | | | by the | | -| | | | attribute | | -| | | | layerProtoc | | -| | | | ol. | | -| | | | | | -| | | | 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 | | -| | | | instantiate | | -| | | | d | | -| | | | from this | | -| | | | CPD is in | | -| | | | Trunk mode | | -| | | | (802.1Q or | | -| | | | other). | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| allowedAddr | AddressData | 0..N | For | support: | -| essData | | | specifying | MANDATORY | -| | | | floating | | -| | | | IP(s) to be | | -| | | | shared | | -| | | | among Cpds, | | -| | | | which are | | -| | | | reserved | | -| | | | for | | -| | | | vnfReserved | | -| | | | Cpd | | -| | | | described | | -| | | | in the | | -| | | | VNFD. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ ++--------------------+----------------+------------------+-----------------+--------------------------+ +| **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 release 2 spec/im/index.rst b/docs/ONAP release 2 spec/im/index.rst index d726d3d..e38744d 100644 --- a/docs/ONAP release 2 spec/im/index.rst +++ b/docs/ONAP release 2 spec/im/index.rst @@ -7,7 +7,7 @@ contain the root `toctree` directive. ONAP Information Model Specifications -============================================== +===================================== .. toctree:: :titlesonly: diff --git a/docs/ONAP release 2 spec/im/instantiationlevel.rst b/docs/ONAP release 2 spec/im/instantiationlevel.rst index dd4c18e..a36998a 100644 --- a/docs/ONAP release 2 spec/im/instantiationlevel.rst +++ b/docs/ONAP release 2 spec/im/instantiationlevel.rst @@ -2,100 +2,75 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: 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. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| virtualLink | VirtualLink | 0..N | Specifies | support: | -| BitRateLeve | BitRateLeve | | bitrate | MANDATORY | -| l | l | | requirement | | -| | | | s | | -| | | | applicable | | -| | | | to virtual | | -| | | | links | | -| | | | created | | -| | | | from | | -| | | | particular | | -| | | | virtual | | -| | | | link | | -| | | | descriptors | | -| | | | for this | | -| | | | level. | | -| | | | | | -| | | | NOTE: If | | -| | | | not | | -| | | | present, it | | -| | | | is assumed | | -| | | | that the | | -| | | | bitrate | | -| | | | requirement | | -| | | | s | | -| | | | can be | | -| | | | derived | | -| | | | from those | | -| | | | specified | | -| | | | in the | | -| | | | VduCpd | | -| | | | instances | | -| | | | applicable | | -| | | | to the | | -| | | | internal | | -| | | | VL. If | | -| | | | present in | | -| | | | both the | | -| | | | Instantiati | | -| | | | onLevel | | -| | | | 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 | | -| | | | instantiati | | -| | | | on | | -| | | | level. | | -| | | | scaleInfo | | -| | | | shall be | | -| | | | present if | | -| | | | the VNF | | -| | | | supports | | -| | | | scaling. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ ++------------------------+-------------------------+------------------+-------------------+--------------------------+ +| **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 release 2 spec/im/linkbitraterequirements.rst b/docs/ONAP release 2 spec/im/linkbitraterequirements.rst index 154f9d3..ab2c497 100644 --- a/docs/ONAP release 2 spec/im/linkbitraterequirements.rst +++ b/docs/ONAP release 2 spec/im/linkbitraterequirements.rst @@ -2,10 +2,6 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: LinkBitrateRequirements ============================== @@ -33,11 +29,10 @@ Class: LinkBitrateRequirements | | | | when | | | | | | applicable | | | | | | to the | | -| | | | connectivit | | -| | | | y | | +| | | | connectivity | | | | | | type (e.g. | | | | | | for E-Tree | | -| | | | and E?LAN | | +| | | | and E-LAN | | | | | | branches). | | | | | | | | | | | | NOTE: The | | @@ -49,8 +44,7 @@ Class: LinkBitrateRequirements | | | | declare | | | | | | different | | | | | | bitrate | | -| | | | requirement | | -| | | | s | | +| | | | requirements | | | | | | for leaf | | | | | | connections | | | | | | (e.g. E-LAN | | diff --git a/docs/ONAP release 2 spec/im/logicalnodedata.rst b/docs/ONAP release 2 spec/im/logicalnodedata.rst index 1500dfa..a0981de 100644 --- a/docs/ONAP release 2 spec/im/logicalnodedata.rst +++ b/docs/ONAP release 2 spec/im/logicalnodedata.rst @@ -2,59 +2,52 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: LogicalNodeData +====================== -Class: LogicalNodeData/LogicalNodeDesc -====================================== - -+--------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+=================+==========================+ -| logicalNode | KeyValuePai | 0..N | The logical | support: | -| Requirement | r/NameValue | | node-level | MANDATORY | -| s | Pair | | compute, | | -| | | | memory and | | -| | | | I/O | | -| | | | requirement | | -| | | | s. | | -| | | | An array of | | -| | | | key-value | | -| | | | pairs that | | -| | | | articulate | | -| | | | the | | -| | | | deployment | | -| | | | requirement | | -| | | | s. | | -| | | | | | -| | | | This could | | -| | | | include the | | -| | | | number of | | -| | | | CPU cores | | -| | | | on this | | -| | | | logical | | -| | | | node, a | | -| | | | memory | | -| | | | configurati | | -| | | | on | | -| | | | 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. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ ++-------------------------+-------------+------------------+-----------------+--------------------------+ +| **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 release 2 spec/im/vdu.rst b/docs/ONAP release 2 spec/im/vdu.rst index 3d74c59..f83ed43 100644 --- a/docs/ONAP release 2 spec/im/vdu.rst +++ b/docs/ONAP release 2 spec/im/vdu.rst @@ -2,225 +2,200 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: Vdu +========== -Class: VDU/VDUDesc -================== - -+-------------------+-------------+------------------+-----------------+-------------------------+ -| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================+=============+==================+=================+=========================+ -| vduId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this Vdu | | -| | | | in VNFD. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| name | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | name of the | | -| | | | Vdu. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| description | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the Vdu. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| vduCpd | VduCpd/VDUC | 1..N | Describes | support: | -| | PDesc | | network | MANDATORY | -| | | | connectivit | | -| | | | y | | -| | | | between a | | -| | | | VNFC | | -| | | | instance | | -| | | | (based on | | -| | | | this Vdu) | | -| | | | and an | | -| | | | Virtual | | -| | | | Link (VL). | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| virtualComp | Identifier | 1 | Describes | support: | -| uteDesc | (reference | | CPU, Memory | MANDATORY | -| | to | | and | | -| | VirtualComp | | acceleratio | | -| | uteDesc) | | n | | -| | | | requirement | | -| | | | s | | -| | | | of the | | -| | | | Virtualisat | | -| | | | ion | | -| | | | Container | | -| | | | realising | | -| | | | this Vdu. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| virtualStor | Identifier | 0..N | Describes | support: | -| ageDesc | (reference | | storage | MANDATORY | -| | to | | requirement | | -| | VirtualStor | | s | | -| | ageDesc) | | for a | | -| | | | VirtualStor | | -| | | | age | | -| | | | instance | | -| | | | attached to | | -| | | | the | | -| | | | virtualisat | | -| | | | ion | | -| | | | container | | -| | | | created | | -| | | | from | | -| | | | virtualComp | | -| | | | uteDesc | | -| | | | defined for | | -| | | | this Vdu. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| bootOrder | KeyValuePai | 0..N | Boot order | support: | -| | r/NameValue | | of valid | MANDATORY | -| | Pair | | boot | | -| | | | devices. | valueRange: | -| | | | | "key/name" | -| | | | NOTE: If no | indicates | -| | | | boot order | the the | -| | | | is defined | boot index | -| | | | the default | (lowest | -| | | | boot order | index | -| | | | defined in | defines | -| | | | the VIM or | highest | -| | | | NFVI shall | boot | -| | | | be used. | priority). | -| | | | | "value" | -| | | | | references | -| | | | | a | -| | | | | descriptor | -| | | | | from which | -| | | | | a valid | -| | | | | boot device | -| | | | | is created | -| | | | | e.g. | -| | | | | VirtualStor | -| | | | | ageDesc | -| | | | | from which | -| | | | | a | -| | | | | VirtualStor | -| | | | | age | -| | | | | instance is | -| | | | | created. | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| swImageDesc | SwImageDesc | 0..1 | Describes | support: | -| | | | the | MANDATORY | -| | | Editor's | software | | -| | | note: the | image which | | -| | | scenario of | is directly | | -| | | using "0" | loaded on | | -| | | needs to be | the | | -| | | clarified. | virtualisat | | -| | | | ion | | -| | | | container | | -| | | | realising | | -| | | | this Vdu. | | -| | | | | | -| | | | NOTE: More | | -| | | | software | | -| | | | images can | | -| | | | be attached | | -| | | | to the | | -| | | | virtualisat | | -| | | | ion | | -| | | | container | | -| | | | using | | -| | | | VirtualStor | | -| | | | age | | -| | | | resources. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| nfviConstra | KeyValuthae | 0..N | Describes | support: | -| int | Pair/NameVa | | constraints | MANDATORY | -| | luePair | | on the NFVI | | -| | | | for the | valueRange: | -| | | | VNFC | "key/name" | -| | | | instance(s) | includes | -| | | | created | "Availabili | -| | | | from this | tyZone", | -| | | | Vdu. For | "HostAggreg | -| | | | example, | ates". | -| | | | aspects of | | -| | | | a secure | | -| | | | hosting | | -| | | | environment | | -| | | | for the | | -| | | | VNFC | | -| | | | instance | | -| | | | that | | -| | | | involve | | -| | | | additional | | -| | | | entities or | | -| | | | processes. | | -| | | | | | -| | | | NOTE: These | | -| | | | are | | -| | | | constraints | | -| | | | other than | | -| | | | stipulating | | -| | | | that a VNFC | | -| | | | instance | | -| | | | has access | | -| | | | to a | | -| | | | certain | | -| | | | resource, | | -| | | | as a | | -| | | | prerequisit | | -| | | | e | | -| | | | to | | -| | | | instantiati | | -| | | | on. | | -| | | | The | | -| | | | attributes | | -| | | | virtualComp | | -| | | | uteDesc | | -| | | | and | | -| | | | virtualStor | | -| | | | ageDesc | | -| | | | define the | | -| | | | resources | | -| | | | required | | -| | | | for | | -| | | | instantiati | | -| | | | on | | -| | | | of the VNFC | | -| | | | instance. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| monitoringP | MonitoringP | 0..N | Defines the | support: | -| arameter | arameter | | virtualised | MANDATORY | -| | | | resources | | -| | | | monitoring | | -| | | | parameters | | -| | | | on VDU | | -| | | | level. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| configurabl | VnfcConfigu | 1 | Describes | support: | -| eProperties | rableProper | | the | MANDATORY | -| | ties | | configurabl | | -| | | | e | | -| | | | properties | | -| | | | of all VNFC | | -| | | | instances | | -| | | | based on | | -| | | | this VDU. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| injectFiles | String | 0..N | Describes | support: | -| | | | the | MANDATORY | -| | | | information | | -| | | | (e.g. URL) | | -| | | | about the | | -| | | | scripts, | | -| | | | config | | -| | | | drive | | -| | | | metadata, | | -| | | | etc. which | | -| | | | can be used | | -| | | | during Vdu | | -| | | | booting | | -| | | | process. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| | | | | | -+-------------------+-------------+------------------+-----------------+-------------------------+ ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=======================+===========================+==================+====================+=========================+ +| vduId | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of this Vdu | | +| | | | in VNFD. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| name | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | name of the | | +| | | | Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| description | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| vduCpd | VduCpd | 1..N | Describes | support: | +| | | | network | MANDATORY | +| | | | connectivity | | +| | | | between a | | +| | | | VNFC | | +| | | | instance | | +| | | | (based on | | +| | | | this Vdu) | | +| | | | and an | | +| | | | Virtual | | +| | | | Link (VL). | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| virtualComputeDesc | Identifier | 1 | Describes | support: | +| | (reference | | CPU, Memory | MANDATORY | +| | to | | and | | +| | VirtualComputeDesc) | | acceleration | | +| | | | requirements | | +| | | | of the | | +| | | | Virtualisation | | +| | | | Container | | +| | | | realising | | +| | | | this Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| virtualStorageDesc | Identifier | 0..N | Describes | support: | +| | (reference | | storage | MANDATORY | +| | to | | requirements | | +| | VirtualStorageDesc) | | for a | | +| | | | VirtualStorage | | +| | | | instance | | +| | | | attached to | | +| | | | the | | +| | | | virtualisation | | +| | | | container | | +| | | | created | | +| | | | from | | +| | | | virtualComputeDesc | | +| | | | defined for | | +| | | | this Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| bootOrder | KeyValuePair | 0..N | Boot order | support: | +| | | | of valid | MANDATORY | +| | | | boot | | +| | | | devices. | valueRange: | +| | | | | "key/name" | +| | | | NOTE: If no | indicates | +| | | | boot order | the the | +| | | | is defined | boot index | +| | | | the default | (lowest | +| | | | boot order | index | +| | | | defined in | defines | +| | | | the VIM or | highest | +| | | | NFVI shall | boot | +| | | | be used. | priority). | +| | | | | "value" | +| | | | | references | +| | | | | a | +| | | | | descriptor | +| | | | | from which | +| | | | | a valid | +| | | | | boot device | +| | | | | is created | +| | | | | e.g. | +| | | | | VirtualStorageDesc | +| | | | | from which | +| | | | | a | +| | | | | VirtualStorage | +| | | | | instance is | +| | | | | created. | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| swImageDesc | SwImageDesc | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | Editor's | software | | +| | | note: the | image which | | +| | | scenario of | is directly | | +| | | using "0" | loaded on | | +| | | needs to be | the | | +| | | clarified. | virtualisation | | +| | | | container | | +| | | | realising | | +| | | | this Vdu. | | +| | | | | | +| | | | NOTE: More | | +| | | | software | | +| | | | images can | | +| | | | be attached | | +| | | | to the | | +| | | | virtualisation | | +| | | | container | | +| | | | using | | +| | | | VirtualStorage | | +| | | | resources. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| nfviConstraint | KeyValuePair | 0..N | Describes | support: | +| | | | constraints | MANDATORY | +| | | | on the NFVI | | +| | | | for the | valueRange: | +| | | | VNFC | "key/name" | +| | | | instance(s) | includes | +| | | | created | "AvailabilityZone", | +| | | | from this | "HostAggregates". | +| | | | Vdu. For | | +| | | | example, | | +| | | | aspects of | | +| | | | a secure | | +| | | | hosting | | +| | | | environment | | +| | | | for the | | +| | | | VNFC | | +| | | | instance | | +| | | | that | | +| | | | involve | | +| | | | additional | | +| | | | entities or | | +| | | | processes. | | +| | | | | | +| | | | NOTE: These | | +| | | | are | | +| | | | constraints | | +| | | | other than | | +| | | | stipulating | | +| | | | that a VNFC | | +| | | | instance | | +| | | | has access | | +| | | | to a | | +| | | | certain | | +| | | | resource, | | +| | | | as a | | +| | | | prerequisite | | +| | | | to | | +| | | | instantiation. | | +| | | | The | | +| | | | attributes | | +| | | | virtualComputeDesc | | +| | | | and | | +| | | | virtualStorageDesc | | +| | | | define the | | +| | | | resources | | +| | | | required | | +| | | | for | | +| | | | instantiation | | +| | | | of the VNFC | | +| | | | instance. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| monitoringParameter | MonitoringParameter | 0..N | Defines the | support: | +| | | | virtualised | MANDATORY | +| | | | resources | | +| | | | monitoring | | +| | | | parameters | | +| | | | on VDU | | +| | | | level. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| configurableProperties| VnfcConfigurableProperties| 1 | Describes | support: | +| | | | the | MANDATORY | +| | | | configurable | | +| | | | properties | | +| | | | of all VNFC | | +| | | | instances | | +| | | | based on | | +| | | | this VDU. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| injectFiles | String | 0..N | Describes | support: | +| | | | the | MANDATORY | +| | | | information | | +| | | | (e.g. URL) | | +| | | | about the | | +| | | | scripts, | | +| | | | config | | +| | | | drive | | +| | | | metadata, | | +| | | | etc. which | | +| | | | can be used | | +| | | | during Vdu | | +| | | | booting | | +| | | | process. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+
\ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/vducpd.rst b/docs/ONAP release 2 spec/im/vducpd.rst index 82c2e89..e0247d4 100644 --- a/docs/ONAP release 2 spec/im/vducpd.rst +++ b/docs/ONAP release 2 spec/im/vducpd.rst @@ -2,74 +2,63 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: VduCpd +============= -Class: VduCpd/VDUCPDesc -======================= - -+--------------------+-------------+------------------+------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+==================+==========================+ -| bitrateRequ | Number | 0..1 | Bitrate | support: | -| irement | (recommende | | requirement | MANDATORY | -| | d | | on this CP. | | -| | DM type: | | | | -| | Scalar-Unit | | | | -| | -Rate) | | | | -+--------------------+-------------+------------------+------------------+--------------------------+ -| 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-phys | -| | | | | ical | -| | | | | and | -| | | | | virtio-forw | -| | | | | arder | -+--------------------+-------------+------------------+------------------+--------------------------+ -| virtualNetw | VirtualNetw | 0..N | Specifies | support: | -| orkInterfac | orkInterfac | | requirement | MANDATORY | -| eRequiremen | eRequiremen | | s | | -| ts | ts | | on a | | -| | | | virtual | | -| | | | network | | -| | | | interface | | -| | | | realising | | -| | | | the CPs | | -| | | | instantiate | | -| | | | d | | -| | | | from this | | -| | | | CPD. | | -+--------------------+-------------+------------------+------------------+--------------------------+ -| (inherited | | | All | | -| attributes) | | | attributes | | -| | | | inherited | | -| | | | from Cpd. | | -+--------------------+-------------+------------------+------------------+--------------------------+ ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ +| **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 release 2 spec/im/vduprofile.rst b/docs/ONAP release 2 spec/im/vduprofile.rst index 522fa09..2d7e64a 100644 --- a/docs/ONAP release 2 spec/im/vduprofile.rst +++ b/docs/ONAP release 2 spec/im/vduprofile.rst @@ -2,169 +2,151 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: VduProfile ================= -+--------------------+-------------+-------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+===================+=================+==========================+ -| vduId | Identifier | 1 | Uniquely | support: | -| | (Reference | | identifies | MANDATORY | -| | to Vdu) | | a VDU. | | -+--------------------+-------------+-------------------+-----------------+--------------------------+ -| minNumberOf | Integer | 1 | Minimum | support: | -| Instances | | | number of | MANDATORY | -| | | | instances | | -| | | | of the VNFC | | -| | | | based on | | -| | | | this VDU | | -| | | | that is | | -| | | | permitted | | -| | | | to exist | | -| | | | for this | | -| | | | flavour. | | -+--------------------+-------------+-------------------+-----------------+--------------------------+ -| maxNumberOf | Integer | 1 | Maximum | support: | -| Instances | | | number of | MANDATORY | -| | | | instances | | -| | | | of the VNFC | | -| | | | based on | | -| | | | this VDU | | -| | | | that is | | -| | | | permitted | | -| | | | to exist | | -| | | | for this | | -| | | | flavour. | | -+--------------------+-------------+-------------------+-----------------+--------------------------+ -| localAffini | LocalAffini | 0..N | Specifies | support: | -| tyOrAntiAff | tyOrAntiAff | | affinity or | MANDATORY | -| inityRule | inityRule | | anti-affini | | -| | | | ty | | -| | | | rules | | -| | | | applicable | | -| | | | between the | | -| | | | virtualisat | | -| | | | ion | | -| | | | 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-affini | | -| | | | ty | | -| | | | rule(s) | | -| | | | with | | -| | | | different | | -| | | | scopes | | -| | | | (e.g. | | -| | | | "Affinity | | -| | | | with the | | -| | | | scope | | -| | | | resource | | -| | | | zone and | | -| | | | anti-affini | | -| | | | ty | | -| | | | with the | | -| | | | scope NFVI | | -| | | | node") are | | -| | | | applicable | | -| | | | to the | | -| | | | virtualisat | | -| | | | ion | | -| | | | containers | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machines) | | -| | | | to be | | -| | | | created | | -| | | | based on | | -| | | | this VDU. | | -+--------------------+-------------+-------------------+-----------------+--------------------------+ -| affinityOrA | Identifier | 0..N | Identifier( | support: | -| ntiAffinity | | | s) | MANDATORY | -| GroupId | | | of the | | -| | | | affinity or | | -| | | | anti-affini | | -| | | | ty | | -| | | | group(s) | | -| | | | the VDU | | -| | | | belongs to. | | -| | | | | | -| | | | NOTE: Each | | -| | | | identifier | | -| | | | references | | -| | | | an affinity | | -| | | | or | | -| | | | anti-affini | | -| | | | ty | | -| | | | group which | | -| | | | expresses | | -| | | | affinity or | | -| | | | anti-affini | | -| | | | ty | | -| | | | relationshi | | -| | | | ps | | -| | | | between the | | -| | | | virtualisat | | -| | | | ion | | -| | | | container(s | | -| | | | ) | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machine(s)) | | -| | | | to be | | -| | | | created | | -| | | | using this | | -| | | | VDU and the | | -| | | | virtualisat | | -| | | | ion | | -| | | | 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. | | -+--------------------+-------------+-------------------+-----------------+--------------------------+ -| vmBootUpTim | Integer | 0..1 | Timeout | support: | -| eOut | | | value for | OPTIONAL | -| | | | the VNFM to | | -| | | | wait before | | -| | | | the | | -| | | | successful | | -| | | | booting up | | -| | | | of the VDU. | | -+--------------------+-------------+-------------------+-----------------+--------------------------+ ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| **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 release 2 spec/im/virtualcomputedesc.rst b/docs/ONAP release 2 spec/im/virtualcomputedesc.rst index 3f05570..081f90b 100644 --- a/docs/ONAP release 2 spec/im/virtualcomputedesc.rst +++ b/docs/ONAP release 2 spec/im/virtualcomputedesc.rst @@ -2,66 +2,55 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: VirtualComputeDesc +========================= -Class: VirtualComputeDesc/VirtualCompute -======================================== - -+-------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================+=============+==================+=================+==========================+ -| virtualComp | Identifier | 1 | Unique | support: | -| uteDescId | | | identifier | MANDATORY | -| | | | of this | | -| | | | VirtualComp | | -| | | | uteDesc | | -| | | | in the | | -| | | | VNFD. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| logicalNode | LogicalNode | 1..N | The logical | support: | -| (logical_n | Data/Logici | | Node | MANDATORY | -| ode_id | alNodeDesc | | requirement | | -| in SOL001) | | | s. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| requestAddi | RequestedAd | 0..N | Specifies | support: | -| tionalCapab | ditionalCap | | requirement | MANDATORY | -| ilities | abilityData | | s | | -| | | | for | | -| | | | additional | | -| | | | capabilitie | | -| | | | s. | | -| | | | These may | | -| | | | be for a | | -| | | | range of | | -| | | | purposes. | | -| | | | One example | | -| | | | is | | -| | | | acceleratio | | -| | | | n | | -| | | | related | | -| | | | capabilitie | | -| | | | s. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| computeRequ | KeyValuePai | 0..N | Specifies | support: | -| irements | r/NameValue | | compute | MANDATORY | -| | Pair | | requirement | | -| | | | s. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| virtualMemo | VirtualMemo | 1 | The virtual | support: | -| ry | ryData/Virt | | memory of | MANDATORY | -| | ualMemoryDe | | the | | -| | sc | | virtualised | | -| | | | compute. | | -| | (VirtualMem | | | | -| | ory) | | | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| virtualCpu | VirtualCpuD | 1 | The virtual | support: | -| | ata/Virtual | | CPU(s) of | MANDATORY | -| | CPUDesc | | the | | -| | | | virtualised | | -| | (VirtualCpu | | compute. | | -| | ) | | | | -+-------------------+-------------+------------------+-----------------+--------------------------+ ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ +| **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 release 2 spec/im/virtualcpudata.rst b/docs/ONAP release 2 spec/im/virtualcpudata.rst index 1f8f1db..105614f 100644 --- a/docs/ONAP release 2 spec/im/virtualcpudata.rst +++ b/docs/ONAP release 2 spec/im/virtualcpudata.rst @@ -2,95 +2,85 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: VirtualCpuData +===================== -Class: VirtualCpuData/VirtualCPUDesc -==================================== - -+--------------------+-------------+------------------+-----------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+=================+=========================+ -| cpuArchitec | String | 0..1 | CPU | support: | -| ture | | | architectur | MANDATORY | -| | | | e | | -| | | | type. | | -| | | | Examples | | -| | | | are x86, | | -| | | | ARM. The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | CPU | | -| | | | architectur | | -| | | | e | | -| | | | type is | | -| | | | requested. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| numVirtualC | Integer | 1 | Number of | support: | -| pu | | | virtual | MANDATORY | -| | | | CPUs. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| virtualCpuC | Number | 0..1 | Minimum | support: | -| lock | (recommende | | virtual CPU | MANDATORY | -| | d | | clock rate | | -| | DM type: | | (e.g. in | | -| | Scalar-Unit | | MHz). The | | -| | -Freq) | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| virtualCpuO | String | 0..1 | The CPU | support: | -| versubscrip | | | core | MANDATORY | -| tionPolicy | | | oversubscri | | -| | | | ption | | -| | | | policy e.g. | | -| | | | the | | -| | | | relation of | | -| | | | virtual CPU | | -| | | | cores to | | -| | | | physical | | -| | | | CPU | | -| | | | cores/threa | | -| | | | ds. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| vduCpuRequi | KeyValuePai | 0..N | Array of | support: | -| rements | r/NameValue | | key-value | MANDATORY | -| | Pair | | pair | | -| | | | requirement | | -| | | | s | | -| | | | on the | | -| | | | Compute | | -| | | | (CPU) for | | -| | | | the VDU. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| virtualCpuP | VirtualCpuP | 0..1 | The virtual | support: | -| inning | inningData | | CPU pinning | MANDATORY | -| | | | configurati | | -| | | | on | editor's | -| | | | for the | note: need | -| | | | virtualised | to check | -| | | | compute | whether can | -| | | | resource. | be optional | -+--------------------+-------------+------------------+-----------------+-------------------------+ ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ +| **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 release 2 spec/im/virtuallinkdescflavour.rst b/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst index aa444d8..e617bfe 100644 --- a/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst +++ b/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst @@ -2,22 +2,17 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: VirtualLinkDescFlavour ============================= -+-------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================+=============+==================+=================+==========================+ -| flavourId | Identifier | 1 | Identifies | support: | -| | | | a flavour | MANDATORY | -| | | | within a | | -| | | | VnfVirtualL | | -| | | | inkDesc. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| qos | QoS | 0..1 | QoS of the | support: | -| | | | VL. | MANDATORY | -+-------------------+-------------+------------------+-----------------+--------------------------+ ++-------------------+-------------+------------------+---------------------+--------------------------+ +| **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 release 2 spec/im/virtuallinkprofile.rst b/docs/ONAP release 2 spec/im/virtuallinkprofile.rst index 5e0cfe3..46addd5 100644 --- a/docs/ONAP release 2 spec/im/virtuallinkprofile.rst +++ b/docs/ONAP release 2 spec/im/virtuallinkprofile.rst @@ -2,182 +2,151 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: VirtualLinkProfile ========================= -+--------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+=================+==========================+ -| vnfVirtualL | Identifier | 1 | Uniquely | support: | -| inkDescId | (Reference | | identifies | MANDATORY | -| | to | | a Vnf VLD. | | -| | VnfVirtualL | | | | -| | inkDesc) | | | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| flavourId | Identifier | 1 | Identifies | support: | -| | (Reference | | a flavour | MANDATORY | -| | to | | within the | | -| | VirtualLink | | VnfVirtualL | | -| | DescFlavour | | inkDesc. | | -| | ) | | | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| localAffini | LocalAffini | 0..N | Specifies | support: | -| tyOrAntiAff | tyOrAntiAff | | affinity or | MANDATORY | -| inityRule | inityRule | | anti-affini | | -| | | | ty | | -| | | | rules | | -| | | | applicable | | -| | | | between the | | -| | | | VLs based | | -| | | | on this | | -| | | | VnfVirtualL | | -| | | | inkDesc. | | -| | | | | | -| | | | When the | | -| | | | cardinality | | -| | | | is greater | | -| | | | than 1, | | -| | | | both | | -| | | | affinity | | -| | | | rule(s) and | | -| | | | anti-affini | | -| | | | ty | | -| | | | rule(s) | | -| | | | with | | -| | | | different | | -| | | | scopes are | | -| | | | applicable | | -| | | | to the VLs | | -| | | | based on | | -| | | | this | | -| | | | VnfVirtualL | | -| | | | inkDesc. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| affinityOrA | Identifier | 0..N | Identifier( | support: | -| ntiAffinity | | | s) | MANDATORY | -| GroupId | | | of the | | -| | | | affinity or | | -| | | | anti-affini | | -| | | | ty | | -| | | | group(s) | | -| | | | the | | -| | | | VnfVirtualL | | -| | | | inkDesc | | -| | | | belongs to. | | -| | | | | | -| | | | NOTE: Each | | -| | | | identifier | | -| | | | references | | -| | | | an affinity | | -| | | | or | | -| | | | anti-affini | | -| | | | ty | | -| | | | group which | | -| | | | expresses | | -| | | | affinity or | | -| | | | anti-affini | | -| | | | ty | | -| | | | relationshi | | -| | | | p | | -| | | | between the | | -| | | | VL(s) using | | -| | | | this | | -| | | | VnfVirtualL | | -| | | | inkDesc | | -| | | | and the | | -| | | | VL(s) using | | -| | | | other | | -| | | | VnfVirtualL | | -| | | | inkDesc(s) | | -| | | | in the same | | -| | | | group. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| maxBitRateR | LinkBitrate | 1 | Specifies | support: | -| equirements | Requirement | | the maximum | MANDATORY | -| | s | | bitrate | | -| | | | requirement | | -| | | | s | | -| | | | for a VL | | -| | | | instantiate | | -| | | | d | | -| | | | according | | -| | | | to this | | -| | | | profile. | | -| | | | | | -| | | | NOTE: These | | -| | | | attributes | | -| | | | are used to | | -| | | | control | | -| | | | scaling | | -| | | | boundaries. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| minBitRateR | LinkBitrate | 1 | Specifies | support: | -| equirements | Requirement | | the minimum | MANDATORY | -| | s | | bitrate | | -| | | | requirement | | -| | | | s | | -| | | | for a VL | | -| | | | instantiate | | -| | | | d | | -| | | | according | | -| | | | to this | | -| | | | profile. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| initiationP | KeyValuePai | 0..N | Specifies | support: | -| arameters | r/NameValue | | initiation | MANDATORY | -| | Pair | | parameters | | -| | | | for the | valueRange: | -| | | | virtual | specified | -| | | | link. | values | -| | | | | include: | -| | | | | cidr, | -| | | | | allocationP | -| | | | | ools | -| | | | | (represente | -| | | | | d | -| | | | | by | -| | | | | [starting | -| | | | | ip address, | -| | | | | ending ip | -| | | | | address]), | -| | | | | gatewayIp, | -| | | | | networkName | -| | | | | , | -| | | | | segmentatio | -| | | | | nId, | -| | | | | physicalNet | -| | | | | work. | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| 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. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| vlanTranspa | Boolean | 0..1 | Indicating | support: | -| rent | | | whether | MANDATORY | -| | | | "VLAN | | -| | | | Transparent | | -| | | | Mode" is | | -| | | | supported. | | -| | | | Default is | | -| | | | "FALSE" if | | -| | | | not | | -| | | | specified | | -| | | | otherwise. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| **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 release 2 spec/im/virtualmemorydata.rst b/docs/ONAP release 2 spec/im/virtualmemorydata.rst index 6f64b49..0719a87 100644 --- a/docs/ONAP release 2 spec/im/virtualmemorydata.rst +++ b/docs/ONAP release 2 spec/im/virtualmemorydata.rst @@ -2,75 +2,67 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: VirtualMemoryData +======================== -Class: VirtualMemoryData/VirtualMemoryDesc -========================================== - -+--------------------+-------------+------------------+-----------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+=================+=========================+ -| virtualMemS | Number | 1 | Amount of | support: | -| ize | (recommende | | virtual | MANDATORY | -| | d | | Memory | | -| | DM type: | | (e.g. in | | -| | Scalar-Unit | | MB). | | -| | -Size) | | | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| virtualMemO | String | 0..1 | The memory | support: | -| versubscrip | | | core | MANDATORY | -| tionPolicy | | | oversubscri | | -| | | | ption | | -| | | | 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. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| vduMemRequi | KeyValuePai | 0..N | Array of | support: | -| rements | r/NameValue | | key-value | MANDATORY | -| | Pair | | pair | | -| | | | requirement | | -| | | | s | | -| | | | on the | | -| | | | memory for | | -| | | | the VDU. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ -| numaEnabled | Boolean | 0..1 | It | support: | -| | | | specifies | MANDATORY | -| | | | the memory | | -| | | | allocation | | -| | | | to be | | -| | | | cognisant | | -| | | | of the | | -| | | | relevant | | -| | | | process/cor | | -| | | | e | | -| | | | allocation. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+--------------------+-------------+------------------+-----------------+-------------------------+ ++----------------------------------+-------------------+------------------+-----------------+-------------------------+ +| **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 release 2 spec/im/virtualnetworkinterfacerequirements.rst b/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst index 7f000e7..4e13ddd 100644 --- a/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst +++ b/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst @@ -2,100 +2,89 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: 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 | | -| | | | . | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| supportMand | Boolean | 1 | Indicates | support: | -| atory | | | whether | MANDATORY | -| | | | fulfilling | | -| | | | the | | -| | | | constraint | | -| | | | is | | -| | | | mandatory | | -| | | | (TRUE) for | | -| | | | successful | | -| | | | operation | | -| | | | or | | -| | | | desirable | | -| | | | (FALSE). | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| networkInte | KeyValuePai | 0..N | The network | support: | -| rfaceRequir | r/NameValue | | interface | MANDATORY | -| ements | Pair | | requirement | | -| | | | s. | | -| | | | An element | | -| | | | from an | | -| | | | array of | | -| | | | key-value | | -| | | | pairs that | | -| | | | articulate | | -| | | | the network | | -| | | | interface | | -| | | | deployment | | -| | | | requirement | | -| | | | s. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| nicIoRequir | Identifier | 0..1 | This | support: | -| ements | (reference | | references | MANDATORY | -| | to | | (couples) | | -| | logicalNode | | the CPD | | -| | Data) | | with any | | -| | | | logical | | -| | | | node I/O | | -| | | | requirement | | -| | | | s | | -| | | | (for | | -| | | | network | | -| | | | devices) | | -| | | | that may | | -| | | | have been | | -| | | | created. | | -| | | | Linking | | -| | | | these | | -| | | | attributes | | -| | | | is | | -| | | | necessary | | -| | | | so that so | | -| | | | that I/O | | -| | | | requirement | | -| | | | s | | -| | | | that need | | -| | | | to be | | -| | | | articulated | | -| | | | at the | | -| | | | logical | | -| | | | node level | | -| | | | can be | | -| | | | associated | | -| | | | with the | | -| | | | network | | -| | | | interface | | -| | | | requirement | | -| | | | s | | -| | | | associated | | -| | | | with the | | -| | | | CPD. | | -+--------------------+-------------+------------------+-----------------+--------------------------+ ++------------------------------+------------------+------------------+-----------------+--------------------------+ +| **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 release 2 spec/im/virtualstoragedesc.rst b/docs/ONAP release 2 spec/im/virtualstoragedesc.rst index d245675..4e0370e 100644 --- a/docs/ONAP release 2 spec/im/virtualstoragedesc.rst +++ b/docs/ONAP release 2 spec/im/virtualstoragedesc.rst @@ -2,65 +2,57 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: VirtualStorageDesc ========================= -+-------------------+-------------+------------------+-----------------+-------------------------+ -| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================+=============+==================+=================+=========================+ -| id | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | VirtualStor | | -| | | | ageDesc | | -| | | | in the | | -| | | | VNFD. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| typeOfStora | String | 1 | Type of | support: | -| ge | | | virtualised | MANDATORY | -| | | | storage | | -| | | | resource | | -| | | | (e.g. | | -| | | | volume, | | -| | | | object). | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| sizeOfStora | Number | 1 | Size of | support: | -| ge | (recommende | | virtualised | MANDATORY | -| | d | | storage | | -| | DM type: | | resource | | -| | Scalar-Unit | | (e.g. size | | -| | -Size) | | of volume, | | -| | | | in GB). | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| vduStorageR | KeyValuePai | 0..N | An array of | support: | -| equirements | r/NameValue | | key-value | MANDATORY | -| | Pair | | pairs that | | -| | | | articulate | | -| | | | the storage | | -| | | | deployment | | -| | | | requirement | | -| | | | s. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ -| 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 | | -| | ) | | VirtualStor | | -| | | | age | | -| | | | resource | | -| | | | created | | -| | | | based on | | -| | | | this | | -| | | | VirtualStor | | -| | | | ageDesc. | | -+-------------------+-------------+------------------+-----------------+-------------------------+ ++------------------------+-------------------+------------------+---------------------+-------------------------+ +| **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 release 2 spec/im/vnfd.rst b/docs/ONAP release 2 spec/im/vnfd.rst index a901c75..5a8d22d 100644 --- a/docs/ONAP release 2 spec/im/vnfd.rst +++ b/docs/ONAP release 2 spec/im/vnfd.rst @@ -1,339 +1,309 @@ -.. contents:: - :depth: 3 -.. +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -Class: VNFD/VNFDesc -=================== +Class: Vnfd +=========== -+---------------------+-------------+------------------+-----------------+------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes**| -+=====================+=============+==================+=================+========================+ -| vnfdId | Identifier | 1 | Identifier | support: | -| | | | of this | MANDATORY | -| | | | VNFD | | -| | | | information | | -| | | | element. | | -| | | | This | | -| | | | attribute | | -| | | | shall be | | -| | | | globally | | -| | | | unique. | | -| | | | | | -| | | | NOTE: The | | -| | | | VNFD | | -| | | | Identifier | | -| | | | shall be | | -| | | | used as the | | -| | | | unique | | -| | | | identifier | | -| | | | of the VNF | | -| | | | Package | | -| | | | that | | -| | | | contains | | -| | | | this VNFD. | | -| | | | | | -| | | | Any | | -| | | | modificatio | | -| | | | n | | -| | | | of the | | -| | | | content of | | -| | | | the VNFD or | | -| | | | the VNF | | -| | | | Package | | -| | | | shall | | -| | | | result in a | | -| | | | new VNFD | | -| | | | Identifier. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProvider | String | 1 | Provider of | support: | -| | | | the VNF and | MANDATORY | -| | | | of the | | -| | | | VNFD. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProductN | String | 1 | Name to | support: | -| ame | | | identify | MANDATORY | -| | | | the VNF | | -| | | | Product. | | -| | | | Invariant | | -| | | | for the VNF | | -| | | | Product | | -| | | | lifetime. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfSoftware | String | 1 | Software | support: | -| Version | | | version of | MANDATORY | -| | | | the VNF. | | -| | | | This is | | -| | | | changed | | -| | | | when there | | -| | | | is any | | -| | | | change to | | -| | | | the | | -| | | | software | | -| | | | that is | | -| | | | included in | | -| | | | the VNF | | -| | | | Package. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfdVersion | String | 1 | Identifies | support: | -| | | | the version | MANDATORY | -| | | | of the | | -| | | | VNFD. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProductI | String | 0..1 | Human | support: | -| nfoName | | | readable | MANDATORY | -| | | | name for | | -| | | | the VNF | | -| | | | Product. | | -| | | | Can change | | -| | | | during the | | -| | | | VNF Product | | -| | | | lifetime. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfProductI | String | 0..1 | Human | support: | -| nfoDescript | | | readable | MANDATORY | -| ion | | | description | | -| | | | of the VNF | | -| | | | Product. | | -| | | | Can change | | -| | | | during the | | -| | | | VNF Product | | -| | | | lifetime. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfmInfo | String | 0..N | Identifies | support: | -| | | | VNFM(s) | MANDATORY | -| | | | compatible | | -| | | | with the | valueRange: | -| | | | VNF | use the | -| | | | described | name of | -| | | | in this | micro-servi | -| | | | version of | ce | -| | | | the VNFD. | of the vnfm | -| | | | | drive. For | -| | | | | vendor | -| | | | | specific | -| | | | | VNFM, the | -| | | | | value | -| | | | | composes of | -| | | | | "vendorname | -| | | | | " | -| | | | | and | -| | | | | "vnfmdriver | -| | | | | ", | -| | | | | e.g. | -| | | | | "mycompanyv | -| | | | | nfmdriver"; | -| | | | | for generic | -| | | | | VNFM, the | -| | | | | value is | -| | | | | "gvnfmdrive | -| | | | | r". | -+---------------------+-------------+------------------+-----------------+------------------------+ -| localizatio | String | 0..N | Information | support: | -| nLanguage | | | about | MANDATORY | -| | | | localizatio | | -| | | | n | valueRange: | -| | | | languages | refer to | -| | | | of the VNF | ISO936 \ `h | -| | | | (includes | ttps://www. | -| | | | e.g. | iso.org/iso | -| | | | strings in | -639-langua | -| | | | the VNFD). | ge-codes.ht | -| | | | | ml <https:/ | -| | | | NOTE: This | /www.iso.or | -| | | | allows to | g/iso-639-l | -| | | | provide one | anguage-cod | -| | | | or more | es.html>`__ | -| | | | localizatio | | -| | | | n | | -| | | | languages | | -| | | | to support | | -| | | | selecting a | | -| | | | specific | | -| | | | localizatio | | -| | | | n | | -| | | | language at | | -| | | | VNF | | -| | | | instantiati | | -| | | | on | | -| | | | time. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| defaultLoca | String | 0..1 | Default | support: | -| lizationLan | | | localizatio | MANDATORY | -| guage | | | n | | -| | | | language | valueRange: | -| | | | that is | refer to | -| | | | instantiate | ISO936 \ `h | -| | | | d | ttps://www. | -| | | | if no | iso.org/iso | -| | | | information | -639-langua | -| | | | about | ge-codes.ht | -| | | | selected | ml <https:/ | -| | | | localizatio | /www.iso.or | -| | | | n | g/iso-639-l | -| | | | language is | anguage-cod | -| | | | available. | es.html>`__ | -| | | | | | -| | | | | condition: | -| | | | | Shall be | -| | | | | present if | -| | | | | "localizati | -| | | | | onLanguage" | -| | | | | is present | -| | | | | and shall | -| | | | | be absent | -| | | | | otherwise. | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vdu | VDU/VDUDesc | 1..N | Virtualisat | support: | -| | | | ion | MANDATORY | -| | | | Deployment | | -| | | | Unit. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| virtualComp | VirtualComp | 1..N | Defines | support: | -| uteDesc | uteDesc | | descriptors | MANDATORY | -| | | | of virtual | | -| | | | compute | | -| | | | resources | | -| | | | to be used | | -| | | | by the VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| virtualStor | VirtualStor | 0..N | Defines | support: | -| ageDesc | ageDesc | | descriptors | MANDATORY | -| | | | of virtual | | -| | | | storage | | -| | | | resources | | -| | | | to be used | | -| | | | by the VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| intVirtualL | VirtualLink | 0..N | Represents | support: | -| inkDesc | Desc/VnfVir | | the type of | MANDATORY | -| | tualLinkDes | | network | | -| | c | | connectivit | | -| | | | y | | -| | | | mandated by | | -| | | | the VNF | | -| | | | provider | | -| | | | between two | | -| | | | or more CPs | | -| | | | which | | -| | | | includes at | | -| | | | least one | | -| | | | internal | | -| | | | CP. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfReserved | VduCpd | 0..N | Reserved IP | support: | -| Cpd | | | Address for | MANDATORY | -| | | | VNF which | | -| | | | is not | | -| | | | bounded to | | -| | | | any | | -| | | | specific | | -| | | | VNFC, but | | -| | | | assigned | | -| | | | manually | | -| | | | from | | -| | | | outside and | | -| | | | potentially | | -| | | | shared as a | | -| | | | floating IP | | -| | | | among | | -| | | | VNFCs. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfExtCpd | VnfExtCpd/V | 1..N | Describes | support: | -| | NFExtCPDesc | | external | MANDATORY | -| | | | interface(s | | -| | | | ) | | -| | | | exposed by | | -| | | | this VNF | | -| | | | enabling | | -| | | | connection | | -| | | | with a VL. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| deploymentF | VnfDf/VNFDe | 1..N | Describes | support: | -| lavour | ploymentFla | | specific | MANDATORY | -| | vor | | DF(s) of a | | -| | | | VNF with | | -| | | | specific | | -| | | | requirement | | -| | | | s | | -| | | | for | | -| | | | capacity | | -| | | | and | | -| | | | performance | | -| | | | . | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| configurabl | VnfConfigur | 0..1 | Describes | sup port: | -| eProperties | ablePropert | | the | MAN DATORY | -| | ies | | configurabl | | -| | | | e | | -| | | | properties | | -| | | | of the VNF | | -| | | | (e.g. | | -| | | | related to | | -| | | | auto | | -| | | | scaling and | | -| | | | auto | | -| | | | healing). | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| modifiableA | VnfInfoModi | 0..1 | Describes | sup port: | -| ttributes | fiableAttri | | the | MAN DATORY | -| | butes | | modifiable | | -| | | | attributes | | -| | | | of the VNF. | | -| | | | | | -| | | | Editor's | | -| | | | note: need | | -| | | | check the | | -| | | | usage of | | -| | | | this | | -| | | | attribute | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| lifeCycleMa | LifeCycleMa | 0..N | Includes a | sup port: | -| nagementScr | nagementScr | | list of | MAN DATORY | -| ipt | ipt/LifeCyc | | events and | | -| | leManagemen | | correspondi | | -| | tOperationD | | ng | | -| | esc | | management | | -| | | | scripts | | -| | | | performed | | -| | | | for the | | -| | | | VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| elementGrou | VnfdElement | 0..N | Describes | sup port: | -| p | Group | | the | MAN DATORY | -| | | | associated | | -| | | | elements of | | -| | | | a VNFD for | | -| | | | a certain | | -| | | | purpose | | -| | | | during VNF | | -| | | | lifecycle | | -| | | | management. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| vnfIndicato | VnfIndicato | 0..N | Declares | support: | -| r | r | | the VNF | MANDATORY | -| | | | indicators | | -| | | | that are | | -| | | | supported | | -| | | | by this | | -| | | | VNF. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| logo | String | 0..1 | File path | support: | -| | | | of the | MANDATORY | -| | | | vendor | | -| | | | specified | | -| | | | logo. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| guide | String | 0..1 | UUID of the | support: | -| | | | vendor | MANDATORY | -| | | | guide/docum | | -| | | | entation | | -| | | | which is | | -| | | | attached to | | -| | | | VNF and can | | -| | | | be | | -| | | | downloaded | | -| | | | from the | | -| | | | model. | | -+---------------------+-------------+------------------+-----------------+------------------------+ -| | | | | | -+---------------------+-------------+------------------+-----------------+------------------------+ ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=============================+=============================+==================+=====================+======================================================+ +| vnfdId | Identifier | 1 | Identifier | support: | +| | | | of this | MANDATORY | +| | | | VNFD | | +| | | | information | | +| | | | element. | | +| | | | This | | +| | | | attribute | | +| | | | shall be | | +| | | | globally | | +| | | | unique. | | +| | | | | | +| | | | NOTE: The | | +| | | | VNFD | | +| | | | Identifier | | +| | | | shall be | | +| | | | used as the | | +| | | | unique | | +| | | | identifier | | +| | | | of the VNF | | +| | | | Package | | +| | | | that | | +| | | | contains | | +| | | | this VNFD. | | +| | | | | | +| | | | Any | | +| | | | modification | | +| | | | of the | | +| | | | content of | | +| | | | the VNFD or | | +| | | | the VNF | | +| | | | Package | | +| | | | shall | | +| | | | result in a | | +| | | | new VNFD | | +| | | | Identifier. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProvider | String | 1 | Provider of | support: | +| | | | the VNF and | MANDATORY | +| | | | of the | | +| | | | VNFD. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductName | String | 1 | Name to | support: | +| | | | identify | MANDATORY | +| | | | the VNF | | +| | | | Product. | | +| | | | Invariant | | +| | | | for the VNF | | +| | | | Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfSoftwareVersion | String | 1 | Software | support: | +| | | | version of | MANDATORY | +| | | | the VNF. | | +| | | | This is | | +| | | | changed | | +| | | | when there | | +| | | | is any | | +| | | | change to | | +| | | | the | | +| | | | software | | +| | | | that is | | +| | | | included in | | +| | | | the VNF | | +| | | | Package. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfdVersion | String | 1 | Identifies | support: | +| | | | the version | MANDATORY | +| | | | of the | | +| | | | VNFD. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductInfoName | String | 0..1 | Human | support: | +| | | | readable | MANDATORY | +| | | | name for | | +| | | | the VNF | | +| | | | Product. | | +| | | | Can change | | +| | | | during the | | +| | | | VNF Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductInfoDescription | String | 0..1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the VNF | | +| | | | Product. | | +| | | | Can change | | +| | | | during the | | +| | | | VNF Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfmInfo | String | 0..N | Identifies | support: | +| | | | VNFM(s) | MANDATORY | +| | | | compatible | | +| | | | with the | valueRange: | +| | | | VNF | use the | +| | | | described | name of | +| | | | in this | micro-service | +| | | | version of | of the vnfm | +| | | | the VNFD. | drive. For | +| | | | | vendor | +| | | | | specific | +| | | | | VNFM, the | +| | | | | value | +| | | | | composes of | +| | | | | "vendorname" | +| | | | | and | +| | | | | "vnfmdriver", | +| | | | | e.g. | +| | | | | "mycompanyvnfmdriver"; | +| | | | | for generic | +| | | | | VNFM, the | +| | | | | value is | +| | | | | "gvnfmdriver". | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| localizationLanguage | String | 0..N | Information | support: | +| | | | about | MANDATORY | +| | | | localization | | +| | | | languages | valueRange: | +| | | | | refer to | +| | | | of the VNF | ISO936 \ | +| | | | (includes | `https://www.iso.org/iso-639-language-codes.html | +| | | | e.g. | <https://www.iso.org/iso-639-language-codes.html>`__ | +| | | | strings in | | +| | | | the VNFD). | | +| | | | | | +| | | | NOTE: This | | +| | | | allows to | | +| | | | provide one | | +| | | | or more | | +| | | | localizatio | | +| | | | n | | +| | | | languages | | +| | | | to support | | +| | | | selecting a | | +| | | | specific | | +| | | | localizatio | | +| | | | n | | +| | | | language at | | +| | | | VNF | | +| | | | instantiati | | +| | | | on | | +| | | | time. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| defaultLocalizationLanguage | String | 0..1 | Default | support: | +| | | | localization | MANDATORY | +| | | | language | | +| | | | that is | valueRange: | +| | | | instantiated | refer to | +| | | | if no | ISO936 \ | +| | | | information | `https://www.iso.org/iso-639-language-codes.html | +| | | | about | <https://www.iso.org/iso-639-language-codes.html>`__ | +| | | | selected | | +| | | | localization | condition: | +| | | | language is | Shall be | +| | | | available. | present if | +| | | | | "localizationLanguage" | +| | | | | is present | +| | | | | and shall | +| | | | | be absent | +| | | | | otherwise. | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vdu | Vdu | 1..N | Virtualisation | support: | +| | | | Deployment | MANDATORY | +| | | | Unit. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| virtualComputeDesc | VirtualComputeDesc | 1..N | Defines | support: | +| | | | descriptors | MANDATORY | +| | | | of virtual | | +| | | | compute | | +| | | | resources | | +| | | | to be used | | +| | | | by the VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| virtualStorageDesc | VirtualStorageDesc | 0..N | Defines | support: | +| | | | descriptors | MANDATORY | +| | | | of virtual | | +| | | | storage | | +| | | | resources | | +| | | | to be used | | +| | | | by the VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| intVirtualLinkDesc | VirtualLinkDesc | 0..N | Represents | support: | +| | | | the type of | MANDATORY | +| | | | network | | +| | | | connectivity | | +| | | | mandated by | | +| | | | the VNF | | +| | | | provider | | +| | | | between two | | +| | | | or more CPs | | +| | | | which | | +| | | | includes at | | +| | | | least one | | +| | | | internal | | +| | | | CP. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfReservedCpd | VduCpd | 0..N | Reserved IP | support: | +| | | | Address for | MANDATORY | +| | | | VNF which | | +| | | | is not | | +| | | | bounded to | | +| | | | any | | +| | | | specific | | +| | | | VNFC, but | | +| | | | assigned | | +| | | | manually | | +| | | | from | | +| | | | outside and | | +| | | | potentially | | +| | | | shared as a | | +| | | | floating IP | | +| | | | among | | +| | | | VNFCs. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfExtCpd | VnfExtCpd | 1..N | Describes | support: | +| | | | external | MANDATORY | +| | | | interface(s) | | +| | | | exposed by | | +| | | | this VNF | | +| | | | enabling | | +| | | | connection | | +| | | | with a VL. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| deploymentFlavour | VnfDf | 1..N | Describes | support: | +| | | | specific | MANDATORY | +| | | | DF(s) of a | | +| | | | VNF with | | +| | | | specific | | +| | | | requirements | | +| | | | for | | +| | | | capacity | | +| | | | and | | +| | | | performance. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| configurableProperties | VnfConfigurableProperties | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | | configurable | | +| | | | properties | | +| | | | of the VNF | | +| | | | (e.g. | | +| | | | related to | | +| | | | auto | | +| | | | scaling and | | +| | | | auto | | +| | | | healing). | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| modifiableAttributes | VnfInfoModifiableAttributes | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | | modifiable | | +| | | | attributes | | +| | | | of the VNF. | | +| | | | | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| lifeCycleManagementScript | LifeCycleManagementScript | 0..N | Includes a | support: | +| | | | list of | MANDATORY | +| | | | events and | | +| | | | corresponding | | +| | | | management | | +| | | | scripts | | +| | | | performed | | +| | | | for the | | +| | | | VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| elementGroup | VnfdElementGroup | 0..N | Describes | support: | +| | | | the | MANDATORY | +| | | | associated | | +| | | | elements of | | +| | | | a VNFD for | | +| | | | a certain | | +| | | | purpose | | +| | | | during VNF | | +| | | | lifecycle | | +| | | | management. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfIndicator | VnfIndicator | 0..N | Declares | support: | +| | | | the VNF | MANDATORY | +| | | | indicators | | +| | | | that are | | +| | | | supported | | +| | | | by this | | +| | | | VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| logo | String | 0..1 | File path | support: | +| | | | of the | MANDATORY | +| | | | vendor | | +| | | | specified | | +| | | | logo. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| guide | String | 0..1 | UUID of the | support: | +| | | | vendor | MANDATORY | +| | | | guide/documentation | | +| | | | which is | | +| | | | attached to | | +| | | | VNF and can | | +| | | | be | | +| | | | downloaded | | +| | | | from the | | +| | | | model. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ diff --git a/docs/ONAP release 2 spec/im/vnfdf.rst b/docs/ONAP release 2 spec/im/vnfdf.rst index f3ce578..c78de9f 100644 --- a/docs/ONAP release 2 spec/im/vnfdf.rst +++ b/docs/ONAP release 2 spec/im/vnfdf.rst @@ -2,231 +2,209 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: VnfDf ============ -+--------------------+-------------+------------------+-------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+===================+==========================+ -| flavorId | Identifier | 1 | Identifier | support: | -| | | | of this DF | MANDATORY | -| | | | within the | | -| | | | VNFD. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| description | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the DF. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| vduProfile | VduProfile | 1..N | Describes | support: | -| | | | additional | MANDATORY | -| | | | instantiati | | -| | | | on | | -| | | | data for | | -| | | | the VDUs | | -| | | | used in | | -| | | | this | | -| | | | flavor. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| virtualLink | VirtualLink | 0..N | Defines the | support: | -| Profile | Profile | | internal | MANDATORY | -| | | | VLD along | | -| | | | with | | -| | | | additional | | -| | | | data which | | -| | | | is used in | | -| | | | this DF. | | -| | | | | | -| | | | NOTE 1: | | -| | | | This allows | | -| | | | for | | -| | | | different | | -| | | | VNF | | -| | | | internal | | -| | | | topologies | | -| | | | between | | -| | | | DFs. | | -| | | | | | -| | | | NOTE 2: | | -| | | | virtualLink | | -| | | | Profile | | -| | | | needs to be | | -| | | | provided | | -| | | | for all VLs | | -| | | | that the | | -| | | | CPs of the | | -| | | | VDUs in the | | -| | | | VDU | | -| | | | profiles | | -| | | | connect to. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| instantiati | Instantiati | 1..N | Describes | support: | -| onLevel | onLevel | | the various | MANDATORY | -| | | | levels of | | -| | | | resources | | -| | | | that can be | | -| | | | used to | | -| | | | instantiate | | -| | | | the VNF | | -| | | | using this | | -| | | | flavour. | | -| | | | | | -| | | | Examples: | | -| | | | Small, | | -| | | | Medium, | | -| | | | Large. | | -| | | | | | -| | | | If there is | | -| | | | only one | | -| | | | "instantiat | | -| | | | ionLevel" | | -| | | | entry, it | | -| | | | shall be | | -| | | | treated as | | -| | | | the default | | -| | | | instantiati | | -| | | | on | | -| | | | level for | | -| | | | this DF. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| affinityOrA | AffinityOrA | 0..N | Specifies | support: | -| ntiAffinity | ntiAffinity | | affinity or | | -| Group | Group | | anti-affini | MANDATORY | -| | | | ty | | -| | | | relationshi | | -| | | | p | | -| | | | applicable | | -| | | | between the | | -| | | | virtualisat | | -| | | | ion | | -| | | | containers | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machines) | | -| | | | to be | | -| | | | created | | -| | | | using | | -| | | | different | | -| | | | VDUs or | | -| | | | internal | | -| | | | VLs to be | | -| | | | created | | -| | | | using | | -| | | | different | | -| | | | VnfVirtualL | | -| | | | inkDesc(s) | | -| | | | in the same | | -| | | | affinity or | | -| | | | anti-affini | | -| | | | ty | | -| | | | group. | | -| | | | | | -| | | | NOTE: | | -| | | | In the | | -| | | | present | | -| | | | specificati | | -| | | | on, | | -| | | | including | | -| | | | either | | -| | | | VDU(s) or | | -| | | | VnfVirtualL | | -| | | | inkDesc(s) | | -| | | | into the | | -| | | | same | | -| | | | affinity or | | -| | | | anti-affini | | -| | | | ty | | -| | | | group is | | -| | | | supported. | | -| | | | Extension | | -| | | | to support | | -| | | | including | | -| | | | both VDU(s) | | -| | | | and | | -| | | | VnfVirtualL | | -| | | | inkDesc(s) | | -| | | | into the | | -| | | | same | | -| | | | affinity or | | -| | | | anti-affini | | -| | | | ty | | -| | | | group is | | -| | | | left for | | -| | | | future | | -| | | | specificati | | -| | | | on. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| scalingAspe | ScalingAspe | 0..N | The scaling | support: | -| ct | ct | | aspects | | -| | | | supported | MANDATORY | -| | | | by this DF | | -| | | | of the VNF. | | -| | | | scalingAspe | | -| | | | ct | | -| | | | shall be | | -| | | | present if | | -| | | | the VNF | | -| | | | supports | | -| | | | scaling. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| placementGr | PlacementGr | 0..N | Determine | support: | -| oup | oup | | where | EXPERIMENTA | -| | | | VNFC's | L | -| | | | (VDU's) are | | -| | | | placed with | | -| | | | respect to | | -| | | | the VNF | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| baseConfigG | BaseConfigG | 0..1 |- BaseConfigGroup | support: | -| roup | roup | | may set | EXPERIMENTA | -| | | | Access | L | -| | | | Control | | -| | | | Lists | | -| | | | (ACL's) | | -| | | | and | | -| | | | establish | | -| | | | security | | -| | | | groups | | -| | | | and | | -| | | | server | | -| | | | groups. | | -| | | | | | -| | | |- BaseConfigGroup | | -| | | | creates/estab | | -| | | | lishslishs | | -| | | | storage for the | | -| | | | VM's (OpenStack | | -| | | | Cinder). | | -| | | | | | -| | | |- BaseConfigGroup | | -| | | | may | | -| | | | establish | | -| | | | internal | | -| | | | networks | | -| | | | such as | | -| | | | OAM (VNF | | -| | | | Mgmt) or | | -| | | | MNS | | -| | | | (Maintenance & | | -| | | | Surveillance) | | -| | | | established. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ -| deploymentG | DeploymentG | 1..N | DeploymentG | support: | -| roup | roup | | roup | EXPERIMENTA | -| | | | provides | L | -| | | | the minimum | | -| | | | viable VDU | | -| | | | and | | -| | | | associated | | -| | | | VNFC | | -| | | | configurati | | -| | | | on | | -| | | | for a | | -| | | | useable | | -| | | | VNF. | | -+--------------------+-------------+------------------+-------------------+--------------------------+ ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++============================+=============================+==================+=======================+==========================+ +| flavorId | Identifier | 1 | Identifier | support: | +| | | | of this DF | MANDATORY | +| | | | within the | | +| | | | VNFD. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| description | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the DF. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| vduProfile | VduProfile | 1..N | Describes | support: | +| | | | additional | MANDATORY | +| | | | instantiation | | +| | | | data for | | +| | | | the VDUs | | +| | | | used in | | +| | | | this | | +| | | | flavor. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| virtualLinkProfile | VirtualLinkProfile | 0..N | Defines the | support: | +| | | | internal | MANDATORY | +| | | | VLD along | | +| | | | with | | +| | | | additional | | +| | | | data which | | +| | | | is used in | | +| | | | this DF. | | +| | | | | | +| | | | NOTE 1: | | +| | | | This allows | | +| | | | for | | +| | | | different | | +| | | | VNF | | +| | | | internal | | +| | | | topologies | | +| | | | between | | +| | | | DFs. | | +| | | | | | +| | | | NOTE 2: | | +| | | | virtualLink | | +| | | | Profile | | +| | | | needs to be | | +| | | | provided | | +| | | | for all VLs | | +| | | | that the | | +| | | | CPs of the | | +| | | | VDUs in the | | +| | | | VDU | | +| | | | profiles | | +| | | | connect to. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| instantiationLevel | InstantiationLevel | 1..N | Describes | support: | +| | | | the various | MANDATORY | +| | | | levels of | | +| | | | resources | | +| | | | that can be | | +| | | | used to | | +| | | | instantiate | | +| | | | the VNF | | +| | | | using this | | +| | | | flavour. | | +| | | | | | +| | | | Examples: | | +| | | | Small, | | +| | | | Medium, | | +| | | | Large. | | +| | | | | | +| | | | If there is | | +| | | | only one | | +| | | | "instantiationLevel" | | +| | | | entry, it | | +| | | | shall be | | +| | | | treated as | | +| | | | the default | | +| | | | instantiation | | +| | | | level for | | +| | | | this DF. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| affinityOrAntiAffinityGroup| AffinityOrAntiAffinityGroup | 0..N | Specifies | support: | +| | | | affinity or | MANDATORY | +| | | | anti-affinity | | +| | | | relationship | | +| | | | applicable | | +| | | | between the | | +| | | | virtualisation | | +| | | | containers | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machines) | | +| | | | to be | | +| | | | created | | +| | | | using | | +| | | | different | | +| | | | VDUs or | | +| | | | internal | | +| | | | VLs to be | | +| | | | created | | +| | | | using | | +| | | | different | | +| | | | VnfVirtualLinkDesc(s) | | +| | | | in the same | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group. | | +| | | | | | +| | | | NOTE: | | +| | | | In the | | +| | | | present | | +| | | | specification, | | +| | | | including | | +| | | | either | | +| | | | VDU(s) or | | +| | | | VnfVirtualLinkDesc(s) | | +| | | | into the | | +| | | | same | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group is | | +| | | | supported. | | +| | | | Extension | | +| | | | to support | | +| | | | including | | +| | | | both VDU(s) | | +| | | | and | | +| | | | VnfVirtualLinkDesc(s) | | +| | | | into the | | +| | | | same | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group is | | +| | | | left for | | +| | | | future | | +| | | | specification. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| scalingAspect | ScalingAspect | 0..N | The scaling | support: | +| | | | aspects | MANDATORY | +| | | | supported | | +| | | | by this DF | | +| | | | of the VNF. | | +| | | | scalingAspect | | +| | | | shall be | | +| | | | present if | | +| | | | the VNF | | +| | | | supports | | +| | | | scaling. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| placementGroup | PlacementGroup | 0..N | Determine | support: | +| | | | where | EXPERIMENTAL | +| | | | VNFC's | | +| | | | (VDU's) are | | +| | | | placed with | | +| | | | respect to | | +| | | | the VNF | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| baseConfigGroup | BaseConfigGroup | 0..1 |- BaseConfigGroup | support: | +| | | | may set | EXPERIMENTAL | +| | | | Access | | +| | | | Control | | +| | | | Lists | | +| | | | (ACL's) | | +| | | | and | | +| | | | establish | | +| | | | security | | +| | | | groups | | +| | | | and | | +| | | | server | | +| | | | groups. | | +| | | | | | +| | | |- BaseConfigGroup | | +| | | | creates/establishs | | +| | | | storage for the | | +| | | | VM's (OpenStack | | +| | | | Cinder). | | +| | | | | | +| | | |- BaseConfigGroup | | +| | | | may | | +| | | | establish | | +| | | | internal | | +| | | | networks | | +| | | | such as | | +| | | | OAM (VNF | | +| | | | Mgmt) or | | +| | | | MNS | | +| | | | (Maintenance & | | +| | | | Surveillance) | | +| | | | established. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| deploymentGroup | DeploymentGroup | 1..N | DeploymentGroup | support: | +| | | | provides | EXPERIMENTAL | +| | | | the minimum | | +| | | | viable VDU | | +| | | | and | | +| | | | associated | | +| | | | VNFC | | +| | | | configuration | | +| | | | for a | | +| | | | useable | | +| | | | VNF. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
\ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/vnfextcpd.rst b/docs/ONAP release 2 spec/im/vnfextcpd.rst index 0892bcf..8a34c7c 100644 --- a/docs/ONAP release 2 spec/im/vnfextcpd.rst +++ b/docs/ONAP release 2 spec/im/vnfextcpd.rst @@ -2,69 +2,60 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. +Class: VnfExtCpd +================ -Class: VnfExtCpd/VnfExtCpDesc -============================= - -+-------------------+-------------+------------------+-----------------+--------------------------+ -| **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. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| virtualNetw | VirtualNetw | 0..N | Specifies | support: | -| orkInterfac | orkInterfac | | requirement | MANDATORY | -| eRequiremen | eRequiremen | | s | | -| ts | ts | | on a | | -| | | | virtual | | -| | | | network | | -| | | | interface | | -| | | | realising | | -| | | | the CPs | | -| | | | instantiate | | -| | | | d | | -| | | | from this | | -| | | | CPD. | | -| | | | | | -| | | | NOTE: In | | -| | | | case of | | -| | | | referencing | | -| | | | an intCpd | | -| | | | via its | | -| | | | identifier, | | -| | | | the | | -| | | | virtualNetw | | -| | | | orkInterfac | | -| | | | eRequiremen | | -| | | | ts | | -| | | | attribute | | -| | | | of the | | -| | | | referenced | | -| | | | intCpd | | -| | | | applies. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| (inherited | | | All | | -| attributes) | | | attributes | | -| | | | inherited | | -| | | | from Cpd. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ ++-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ +| **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 release 2 spec/im/vnfvirtuallinkdesc.rst b/docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst index 72d8b51..c818fa1 100644 --- a/docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst +++ b/docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst @@ -2,67 +2,61 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. contents:: - :depth: 3 -.. - Class: VnfVirtualLinkDesc ========================= -+-------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================+=============+==================+=================+==========================+ -| virtualLink | Identifier | 1 | Unique | support: | -| DescId | | | identifier | MANDATORY | -| | | | of this | | -| | | | internal | | -| | | | VLD in | | -| | | | VNFD. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| virtualLink | VirtualLink | 1..N | Describes a | support: | -| DescFlavour | DescFlavour | | specific | MANDATORY | -| | | | flavour of | | -| | | | the VL with | | -| | | | specific | | -| | | | bitrate | | -| | | | requirement | | -| | | | s. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| connectivit | Connectivit | 1 | | support: | -| yType | yType | | | 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-reada | MANDATORY | -| | | | ble | | -| | | | information | | -| | | | on the | | -| | | | purpose of | | -| | | | the VL | | -| | | | (e.g. | | -| | | | control | | -| | | | plane | | -| | | | traffic). | | -+-------------------+-------------+------------------+-----------------+--------------------------+ -| monitoringP | MonitoringP | 0..N | Defines the | support: | -| arameter | arameter | | virtualised | MANDATORY | -| | | | resources | | -| | | | monitoring | | -| | | | parameters | | -| | | | on VLD | | -| | | | level. | | -+-------------------+-------------+------------------+-----------------+--------------------------+ ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ +| **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 |