...
The following describes Data Model based on the ETSI v3.3.1 SOL001 VNFD plus CNF enhancements, which came from 4.1.1.
- in Honolulu, the VDU and Container relation is 1:1. We plan to enhance it in the future.
- 2.7.x for backward compatibility during SDC onboarding + 3.3.1 with CNF enhancements
- If the type is changed, separate properties for 2.7.x and 3.3.1 will be used
- As the ETSI SOL001 WG produces a stable draft/release of SOL001 4.X specification , we expect to update the data model to align with that specifcation.
ETSI 3.3.1 SOL001 Data Model with minimum CNF Properties from 4.1.1
Gliffy Diagram |
---|
VNF Data Model
|
Gliffy Diagram | ||||||
---|---|---|---|---|---|---|
|
VNF Data Model
- property "vnfm_info" constraint pattern: "(etsivnfm:v[0-9]property "vnfm_info" constraint pattern: "(etsivnfm:v[0-9]?[0-9]\.[0-9]?[0-9]\.[0-9]?[0-9]$)|([0-9]:[a-zA-Z0-9.-]$)"
- values must be in format etsivnfm:v3.3.1 or <int>:<string>
- this is not enforced by constraint in type definition in ONAP
- property "vnf_profile" has not changed, but it is commented out in existing version in ONAP
- new attribute "scale_status" added
tosca.nodes.nfv.VNF: derived_from: tosca.nodes.Root description: The generic abstract type from which all VNF specific node types shall be derived to form, together with other node types, the TOSCA service template(s) representing the VNFD | ||||||||||||||||||||
Id | Type | Cardinality | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
descriptor_id | String #UUID | 1 | Identifier for the VNFD | |||||||||||||||||
descriptor_version | String | 1 | Identifies the version of the VNFD | |||||||||||||||||
provider | String | 1 | provider of the VNF and of the VNFD | |||||||||||||||||
product_name | String | 1 | name to identify the VNF product. Invariant for the VNF Product lifetime | |||||||||||||||||
software_version | String | 1 | Software version of the VNF | |||||||||||||||||
product_info_name | String | 0..1 | Human readable name of the VNF Product | |||||||||||||||||
product_info_description | String | 0..1 | Human readable name for the VNF product | |||||||||||||||||
vnfm_info | list of String | 1..n | Identifies VNFM(s) compatible with the VNF | |||||||||||||||||
localization_languages | list of String | 0..n | Information about localization languages of the VNF | |||||||||||||||||
lcm_operations_configuration | tosca.datatypes.nfv.VnfLcmOperationsConfiguration | 0..n | Describes the configuration parameters for the VNF LCM operations | |||||||||||||||||
monitoring_parameters | list of tosca.datatypes.nfv.VnfMonitoringParameter | 0..n | Describes monitoring parameters applicable to the VNF. | |||||||||||||||||
flavour_id | String | 1 | Identifier of the Deployment Flavour within the VNFD | |||||||||||||||||
flavour_description | String | 1 | Human readable description of the DF | |||||||||||||||||
vnf_profile | tosca.datatypes.nfv.VnfProfile | 0..1 | Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF | |||||||||||||||||
mciop_profile | list of tosca.datatypes.nfv.MciopProfile | 0..n | Describes additional instantiation data for the MCIOPs used in this deployment | |||||||||||||||||
scale_status | map of tosca.datatypes.nfv.ScaleInfo | 0..n | Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" the VNF has been scaled w.r.t. that aspect. | vdu | ||||||||||||||||
requirements: - virtual_link: capability: tosca.capabilities | tosca.nodes.nfv. | VDU1..n | Virtualisation Deployment Unit | virtualComputeDesc | VirtualLinkable relationship: tosca.relationships | tosca.nodes.nfv. | VirtualComputeDesc0..n | Defines descriptors of virtual compute resources to be used by the VNF when each of the VNFC instances of the VNF is intended to be deployed in a single VM . | ||||||||||||
osContainerDesc | tosca.nodes.nfv.OsContainerDesc | 0..n | Defines descriptors of container compute resources to be used by the VNF when the VDUs of the VNF are realized by a set of OS Containers sharing the same host and same networking namespace. | |||||||||||||||||
swImageDesc | tosca.nodes.nfv.SwImageDesc | 0..n | Defines descriptors of software images to be used by the VNF. | |||||||||||||||||
interfaces: Vnflcm: type: tosca.interfaces.nfv.Vnflcm # VnfIndicator: # type: tosca.interfaces.nfv.VnfIndicator # derived types are expected to introduce Vnf Indicator interfaces # with their type derived from tosca.interfaces.nfv.VnfIndicator |
VDU OsContainer Data Model
...
tosca.nodes.nfv.Vdu.osContainer:
derived_from: tosca.nodes.Root
description: Describes the container compute part of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC
...
Describes constraints on the NFVI for the VNFC instance(s) created from this VDU. This property is reserved for future use in the present document.
...
monitoring_parameters
...
tosca.datatypes.nfv.VnfcMonitoringParameter
...
Describes monitoring parameters applicable to a VNFC instantiated from this VDU
...
#configurable_properties
...
tosca.datatypes.nfv.VnfcConfigurableProperties
...
# derived types are expected to introduce configurable_properties with its type derived from tosca.datatypes.nfv.VnfcConfigurableProperties
...
vdu_profile
...
tosca.datatypes.nfv.VduProfile
...
Defines additional instantiation data for the Vdu.OsContainer node
...
sw_image_data
...
tosca.datatypes.nfv.SwImageData
...
Defines information related to a SwImage artifact used by this Vdu.OsContainer node
...
boot_data
...
tosca.datatypes.nfv.BootData
...
Contains the information used to customize a container compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent
...
capabilities:
virtual_compute:
type: tosca.capabilities.nfv.VirtualCompute
occurrences: [ 1, 1 ]
virtual_binding:
type: tosca.capabilities.nfv.VirtualBindable
occurrences: [ 1, UNBOUNDED ]
...
requirements:
- virtual_storage:
capability: tosca.capabilities.nfv.VirtualStorage
relationship: tosca.relationships.nfv.AttachesTo
occurrences: [ 0, UNBOUNDED ]
MciopProfile Data Model
...
tosca.datatypes.nfv.MciopProfile:
derived_from: tosca.datatypes.Root
description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF.
...
mciopId
...
Identifies the MCIOP in the VNF package.
...
deploymentOrder
...
Indicates the order in which this MCIOP shall be deployed in relation to other MCIOPs. A lower value specifies an earlier deployment.
null is allowed
VirtualLinksTo occurrences: [ 0, 1 ] # Additional requirements shall be defined in the VNF specific node type (deriving from tosca.nodes.nfv.VNF) corresponding to NS virtual links that need to connect to VnfExtCps | |||
interfaces: Vnflcm: type: tosca.interfaces.nfv.Vnflcm # VnfIndicator: # type: tosca.interfaces.nfv.VnfIndicator # derived types are expected to introduce Vnf Indicator interfaces # with their type derived from tosca.interfaces.nfv.VnfIndicator | |||
OsContainer VDU Data Model
Gliffy Diagram | ||||||
---|---|---|---|---|---|---|
|
VDU OsContainer Data Model
tosca.nodes.nfv.Vdu.osContainer: derived_from: tosca.nodes.Root description: Describes the resources of a single container within a VDU | |||
Id | Type | Cardinality | Description |
---|---|---|---|
name | String | 1 | Human readable name of the Container |
description | String | 1 | Human readable description of the Container |
logical_node | map of tosca.datatypes.nfv.LogicalNodeData | 0..n | Describes the logical node requirements |
requested_additional_capabilities | map of tosca.datatypes.nfv.RequestedAdditionalCapability | 0..n | Describes additional capabilities to host this container |
requestedCpuResources | integer | 0..1 | Number of milli-Cpus |
CpuResourcesLimit | integer | 0..1 | Limit (Max) Number of milli-Cpus |
requestedMemoryResources | scalar-unit.size | 0..1 | Amount of Memory requested |
MemoryResourcesLimit | scalar-unit.size | 0..1 | Limit (Max) Memory |
requestedEphemeralStorageResources | scalar-unit.size | 0..1 | Amount of Ephemeral Storage Requested |
ephemeralStorageResourcesLimit | scalar-unit.size | 0..1 | Limit on Ephemeral Storage |
capabilities: ContainerGroupable: type: tosca.capabilities.nfv.ContainerGroupable occurrences: [ 1, UNBOUNDED ] |
VDU OsContainerGroup Data Model
tosca.nodes.nfv.Vdu.osContainerGroup: derived_from: tosca.nodes.Root description: Describes the aggregate of container(s) of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC; Corresponds to a "Pod" in K8S; Can have multiple constitute containers. | |||
Id | Type | Cardinality | Description |
---|---|---|---|
name | String | 1 | Human readable name of the VDU |
description | String | 1 | Human readable description of the VDU |
nfvi_constraints | map of String | 0..n | Describes constraints on the NFVI for the VNFC instance(s) created from this VDU. This property is reserved for future use in the present document. |
monitoring_parameters | list of tosca.datatypes.nfv.VnfcMonitoringParameter | 0..n | Describes monitoring parameters applicable to a VNFC instantiated from this VDU; Per Container on IFA011 v4.1.1 but more relevant at the VDU (Pod) Level |
#configurable_properties | tosca.datatypes.nfv.VnfcConfigurableProperties | 0..1 | # derived types are expected to introduce configurable_properties with its type derived from tosca.datatypes.nfv.VnfcConfigurableProperties |
vdu_profile | tosca.datatypes.nfv.VduProfile | 1 | Defines additional instantiation data for the Vdu.OsContainerGroup node |
boot_data | tosca.datatypes.nfv.BootData | 0..1 | Contains the information used to customize a container compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent Per Container on IFA011 v4.1.1 but more relevant at the VDU (Pod) Level |
capabilities: virtual_binding: type: tosca.capabilities.nfv.VirtualBindable occurrences: [ 1, UNBOUNDED ] | |||
requirements: - virtual_storage: capability: tosca.capabilities.nfv.VirtualStorage relationship: tosca.relationships.nfv.AttachesTo occurrences: [ 0, UNBOUNDED ] - container_grouping: capability: tosca.capabilities.nfv.ContainerGroupable relationship: tosca.relationships.nfv.GroupsTo occurrences: [ 1, UNBOUNDED ] |
MciopProfile Data Model
Gliffy Diagram macroId 52d3d86d-0434-4565-9ea9-ca1b16d0c8ff name 4.1.1 MciopProfile pagePin 2
tosca.datatypes.nfv.MciopProfile: derived_from: tosca.datatypes.Root description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF. |
...
# affinityOrAntiAffinityGroupId
...
References the affinity or anti-affinity groups(s) the MCIOP belongs to.
...
associatedVdu
...
List of VDUs which are associated to this MCIOP and which are deployed using this MCIOP
Vdu Data Model
tosca.nodes.nfv.VDU:
derived_from: tosca.nodes.SoftwareComponent
Id | Type | Cardinality | Constraints | Description |
---|
mciopId | String | 1 |
Unique identifier of this Vdu in VNFD
name
Human readable name of the Vdu.
description
Human readable description of the Vdu.
intCpd
Describes network connectivity between a
VNFC instance (based on this Vdu) and
an internal Virtual Link (VL).
virtualComputeDesc
Describes CPU, Memory and acceleration
requirements of the Virtualisation
Container realizing this Vdu.
tosca.nodes.nfv.Vdu.osContainer
Describes CPU, memory requirements and limits, and software images of the OS Containers realizing this Vdu corresponding to OS Containers sharing the same host and same network namespace. Each unique identifier is referenced only once within one VDU.
Describes storage requirements for a VirtualStorage instance attached to the virtualisation container(s) created from virtualComputeDesc or osContainerDesc
defined for this Vdu
The key indicates the boot index (lowest index defines highest boot priority). The Value references a descriptor from which a valid boot device is created e.g. VirtualStorageDesc from which a VirtualStorage instance is created.
Describes the software image which is directly loaded on the virtualisation container realizing this Vdu
Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu.
Specifies the virtualised resource related performance metrics on the VDU level to be tracked by the VNFM.
Describes the configurable properties of all VNFC instances based on this VDU
Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM.
Specifies the logical topology between an intCpd in trunk mode, used to describe a trunk port, and other intCpds used to describe subports of the same trunk.
...
Identifies the MCIOP in the VNF package. | ||||
deploymentOrder | Integer | 0..1 | greater_or_equal: 0 | Indicates the order in which this MCIOP shall be deployed in relation to other MCIOPs. A lower value specifies an earlier deployment. null is allowed |
# affinityOrAntiAffinityGroupId | list of String | 0..n | References the affinity or anti-affinity groups(s) the MCIOP belongs to. | |
associatedVdu | list of String | 0..n | List of VDUs which are associated to this MCIOP and which are deployed using this MCIOP |
VnfInstantiateOperationConfiguration Data Model
tosca.datatypes.nfv.VnfInstantiateOperationConfiguration: derived_from: tosca.datatypes.Root description: represents information that affect the invocation of the InstantiateVnf operation. | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
description | String | 0..1 | Description of VnfInstantiateOperationConfiguration | |
VnfMonitoringParameter Data Model
tosca.datatypes.nfv.VnfMonitoringParameter: | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
name | String | 1 | Human readable name of the monitoring parameter | |
performance_metric | String | 1 | - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, | Identifies the performance metric, according to ETSI GS NFV-IFA 027. |
collection_period | scalar-unit.time | 0..1 | - greater_than: 0 s | Describes the recommended periodicity at which to collect the performance information. |
VnfProfile Data Model
tosca.datatypes.nfv.VnfProfile: | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
instantiation_level | String | 0..1 | Identifier of the instantiation level of the VNF DF to be used for instantiation. If not present, the default instantiation level as declared in the VNFD shall be used | |
min_number_of_instances | Integer | 1 | - greater_or_equal: 0 | Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. |
max_number_of_instances | Integer | 1 | - greater_or_equal: 0 | Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. |
service_availability_level | Integer | 0..1 | greater_or_equal: 1 | If present, specifies the service availability level for the VNF instance created from this profile. |
SwImageData Data Model
- Change: checksum propeorty is used to be string in 2.6.x. Now, it is tosca.datatypes.nfv.ChecksumData. During SDC onboarding, the old type checksum data will be stored in a new property in SDC (e.g., checksum261).
tosca.datatypes.nfv. |
SwImageData: derived_from: tosca.datatypes.Root description: |
describes information related to a software image artifact | ||||
Id | Type | Cardinality | Constraints | Description |
---|
name | String |
1 |
Name of |
VnfMonitoringParameter Data Model
this software image | ||||
version | String | 1 | Version of this software image | |
provider | String | 1 | Provider of this software image | |
checksum | tosca.datatypes.nfv.ChecksumData | 1 | Checksum of the software image file | |
container_format |
tosca.datatypes.nfv.VnfMonitoringParameter:
derived_from: tosca.datatypes.Root
description: Represents information on virtualised resource related performance metrics applicable to the VNF.
name
String
1
Human readable name of the monitoring parameter
String | 1 | - valid_values: [ |
v_memory_usage_mean_vnf, v_memory_usage_peak_vnf,
v_disk_usage_mean_vnf, v_disk_usage_peak_vnf,
byte_incoming_vnf_ext_cp, byte_outgoing_vnf_ext_cp,
packet_incoming_vnf_ext_cp, packet_outgoing_vnf_ext_cp
aki, ami, ari, bare, docker, ova, ovf ] | The container format describes the container file format in which software image is provided | |||
disk_format | String | 1 | - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ] | The disk format of a software image is the format of the underlying disk image |
min_disk | scalar-unit.size # Number | 1 | #no need: - greater_or_equal: 0 B | The minimal disk size requirement for this software image |
min_ram | scalar-unit.size # Number |
Identifies the performance metric, according to ETSI GS NFV-IFA 027.
collection_period
0..1 | #no need: - greater_ |
Describes the recommended periodicity at which to collect the performance information.
...
or_equal: 0 B | The minimal RAM requirement for this software image | |||
size | scalar-unit.size # Number | 1 | The size of this software image | |
operating_system | String | 0..1 | Identifies the operating system used in the software image | |
supported_virtualisation_environments | list of String | 0..n | Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image |
BootData Data Model
tosca.datatypes.nfv. VnfProfileBootData: derived_from: tosca.datatypes.Root description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF. | |||||
Id | Type | Cardinality | Constraints | Description | |
---|---|---|---|---|---|
the information used to customize a virtualised or containerized compute resource at boot time. | |||||
Id | Type | Cardinality | Constraints | Description | |
vim_specific_properties | tosca.datatypes.nfv.BootDataVimSpecificProperties | 0..1 | Properties used for selecting VIM or CISM specific capabilities when setting the boot data. | ||
kvp_data | tosca.datatypes.nfv.KvpData | instantiation_level | String | 0..1 | Identifier of the instantiation level of the VNF DF to be used for instantiation. If not present, the default instantiation level as declared in the VNFD shall be used |
min_number_of_instances | Integer | 1 | - greater_or_equal: 0 | Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. | |
max_number_of_instances | Integer | 1 | - greater_or_equal: 0 | Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. | service_availability_level | Integer | 0..1 | greater_or_equal: 1 |
SwImageData Data Model
...
A set of key-value pairs for configuring a virtual or container compute resource. | ||||
content_or_file_data | tosca.datatypes.nfv.ContentOrFileData | 0..1 | A string content or a file for configuring a virtual or container compute resource. |
BootDataVimSpecificProperties Data Model
tosca.datatypes.nfv.BootDataVimSpecificProperties: derived_from: tosca.datatypes.Root description: describes the VIM specific information used for selecting VIM specific capabilities when setting the boot data. | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
vim_type | String | 1 | Discriminator for the different types of the VIM or CISM information. | |
properties | map of String | 0..n | Properties used for selecting VIM or CISM specific capabilities when setting the boot data |
KvpData Data Model
tosca.datatypes.nfv.SwImageDataKvpData: derived_from: tosca.datatypes.Root description: describes information related to a software image artifact a set of key-value pairs information used to customize a virtualised or containerized compute resource at boot time by using only key-value pairs data. | ||||||||||||||||
Id | Type | Cardinality | Constraints | Description | name | String | 1 | Name of this software image | version | String | 1 | Version of this software image | provider | String | 1 | Provider of this software image |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | map of String | 0..n | A map of strings that contains a set of key-value pairs that describes the information for configuring the virtualised or containerized compute resource. |
ContentOrFileData Data Model
| checksum | tosca.datatypes.nfv. | ChecksumData1 | Checksum of the software image file | ||||||||
container_format | String | 1 | - valid_values: [ aki, ami, ari, bare, docker, ova, ovf ] | The container format describes the container file format in which software image is provided | ||||||||
disk_format | String | 1 | - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ] | The disk format of a software image is the format of the underlying disk image | ||||||||
min_disk | scalar-unit.size # Number | 1 | #no need: - greater_or_equal: 0 B | The minimal disk size requirement for this software image | ||||||||
min_ram | scalar-unit.size # Number | 0..1 | #no need: - greater_or_equal: 0 B | The minimal RAM requirement for this software image | size | scalar-unit.size # Number | 1 | The size of this software image | operating_system | String | 0..1 | Identifies the operating system used in the software image | supported_virtualisation_environments | list of String | 0..n | Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image |
BootData Data Model
ContentOrFileData: derived_from: tosca.datatypes.Root description: describes a string content or a file information used to customize a virtualised or containerized compute resource at boot time by using string content or file. | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
data | map of String | 0..n | A map of strings that contains a set of key-value pairs that carries the dynamic deployment values which used to replace the corresponding variable parts in the file as identify by a URL as described in source_path. Shall be present if "source_path" is present and shall be absent otherwise.. | |
content | String | 0..1 | The string information used to customize a virtualised or containerized compute resource at boot time. | |
source_path | String | 0..1 | The URL to a file contained in the VNF package used to customize a virtualised or containerized compute resource. The content shall comply with IETF RFC 3986 [8]. | |
destination_path | String | 0..1 | The URL address when inject a file into the virtualised or containerized compute resource. The content shall comply with IETF RFC 3986 [8]. |
ChecksumData Data Model
tosca.datatypes.nfv.ChecksumData: derived_from: tosca.datatypes.Root description: Describes information about the result of performing a checksum operation over some arbitrary data | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
algorithm | String | 1 | Describes the algorithm used to obtain the checksum value | |
hash | String | 1 | Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers |
vduCp Data Model
tosca.nodes.nfv.VduCp |
: derived_from: tosca.nodes. |
nfv. |
Cp description: |
Describes network connectivity between a VNFC instance based on this VDU and an internal VL | |||
Id | Type | Cardinality |
---|
vim_specific_properties
Description | |||
---|---|---|---|
bitrate_requirement | integer | 0..1 | Bitrate requirement in bit per second on this connection point |
virtual_network_interface_requirements | list of tosca |
.datatypes.nfv |
.VirtualNetworkInterfaceRequirements | 0..n | Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD |
order | integer | 0..1 |
Properties used for selecting VIM or CISM specific capabilities when setting the boot data.
kvp_data
The order of the NIC on the compute instance (e.g.eth2) | |
vnic_type | string |
0..1 |
A set of key-value pairs for configuring a virtual or container compute resource.
content_or_file_data
tosca.datatypes.nfv.ContentOrFileData
0..1
A string content or a file for configuring a virtual or container compute resource.
BootDataVimSpecificProperties Data Model
...
tosca.datatypes.nfv.BootDataVimSpecificProperties:
derived_from: tosca.datatypes.Root
description: describes the VIM specific information used for selecting VIM specific capabilities when setting the boot data.
...
vim_type
...
String
...
1
...
Discriminator for the different types of the VIM or CISM information.
...
properties
...
map of String
...
0..n
...
Properties used for selecting VIM or CISM specific capabilities when setting the boot data
KvpData Data Model
...
tosca.datatypes.nfv.KvpData:
derived_from: tosca.datatypes.Root
description: describes a set of key-value pairs information used to customize a virtualised or containerized compute resource at boot time by using only key-value pairs data.
...
data
...
map of String
...
0..n
...
A map of strings that contains a set of key-value pairs that describes the information for configuring the virtualised or containerized compute resource.
ContentOrFileData Data Model
...
tosca.datatypes.nfv.ContentOrFileData:
derived_from: tosca.datatypes.Root
description: describes a string content or a file information used to customize a virtualised or containerized compute resource at boot time by using string content or file.
...
Describes the type of the virtual network interface realizing the CPs instantiated from this CPD. Valid values: normal, macvtap, direct, baremetal, virtio-forwarder, direct-physical, smart-nic, bridge, ipvlan, loopback, macvlan, ptp, vlan, host-device | |||
capabilities: virtual_binding: type: tosca.capabilities.nfv.VirtualBindable occurrences: [ 1, UNBOUNDED ] | |||
requirements: - virtual_link: capability: tosca.capabilities.nfv.VirtualLinkable |
vnfExtCp Data Model
- tosca.nodes.nfv.VnfExtCP
- No Change since 2.7.1
- There are some changes from 2.6.1 to 2.7.1
- property "vnic_type" has the following extra valid_values:
- macvtap, baremetal, virtio-forwarder, smart-nic
- and the following removed valid_values - backwards incompatible:
- virtio
- requirement "virtual_link" cardinality changed from default (1-1) to 0-1
- requirement "virtual_binding" cardinality changed from default (1-1) to 1-1, i.e. no effective change
- property "vnic_type" has the following extra valid_values:
- requirement "external_virtual_link" cardinality changed from default (1-1) to 0-1
- requirement "internal_virtual_link" cardinality changed from default (1-1) to 1-1, i.e. no effective change
VduCompute Data Model
- tosca.nodes.nfv.Vdu.Compute
- No Change since 2.7.1
- There are some changes from 2.6.1 to 2.7.1
- property "boot_order" changed from list to boolean
- Backwards incompatible change from 2.6.1 -> 2.7.1
- property "nfvi_constraints" changed from list to map
- Backwards incompatible change from 2.6.1 -> 2.7.1
- property "boot_data" changed from string to tosca.datatypes.nfv.BootData
- property "boot_order" changed from list to boolean
- The configurable_properties is still out of scope in Honolulu
tosca.nodes.nfv.Vdu.Compute: derived_from: tosca.nodes.Root description: Describes the virtual compute part of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
name | String | 1 | Human readable name of the VDU | |
description | String | 1 | Human readable description of the VDU | |
boot_order | boolean | 1 | indicates whether the order of the virtual_storage requirements is used as the boot index (the first requirement represents the lowest index and defines highest boot priority) default: false | |
nfvi_constraints | map of String | 0..n | Describes constraints on the NFVI for the VNFC instance(s) created from this VDU. This property is reserved for future use in the present document. | |
monitoring_parameters | list of tosca.datatypes.nfv.VnfcMonitoringParameter | 0..n | Describes monitoring parameters applicable to a VNFC instantiated from this VDU | |
#configurable_properties | tosca.datatypes.nfv.VnfcConfigurableProperties | 0..n | derived types are expected to introduce configurable_properties with its type derived from tosca.datatypes.nfv.VnfcConfigurableProperties | |
vdu_profile | tosca.datatypes.nfv.VduProfile | 1 | Defines additional instantiation data for the VDU.Compute node | |
sw_image_data | tosca.datatypes.nfv.SwImageData | 0..1 | Defines information related to a SwImage artifact used by this Vdu.Compute node | |
boot_data | tosca.datatypes.nfv.BootData | 0..1 | Contains the information used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. | |
capabilities: virtual_compute: type: tosca.capabilities.nfv.VirtualCompute occurrences: [ 1, 1 ] virtual_binding: type: tosca.capabilities.nfv.VirtualBindable occurrences: [ 1, UNBOUNDED ] | ||||
requirements: - virtual_storage: capability: tosca.capabilities.nfv.VirtualStorage relationship: tosca.relationships.nfv.AttachesTo occurrences: [ 0, UNBOUNDED ] |
VduVirtualBlockStorage Data Model
tosca.nodes.nfv.Vdu.VirtualBlockStorage
- property "sw_image_data" deprecated in 3.3.1
VduVirtualObjectStorage Data Model
tosca.nodes.nfv.Vdu.VirtualObjectStorage
- No Change since 2.7.1
VduVirtualFileStorage Data Model
tosca.nodes.nfv.Vdu.VirtualFileStorage
- requirement "virtual_binding" cardinality changed from default (1-1) to 1-1, i.e. no effective change in 3.3.1
VnfVirtualLink Data Model
tosca.nodes.nfv.VnfVirtualLink
- No Change since 2.7.1
VipCp Data Model
- New to SDC
tosca.nodes.nfv.VipCp: derived_from: tosca.nodes.nfv.Cp description: Describes a connection point to allocate one or a set of virtual IP addresses | ||||
Id | Type | Cardinality | Constraints | Description |
---|---|---|---|---|
vip_function | String | 1 | - valid_values: [ high_availability, load_balance ] | Describes the algorithm used to obtain the checksum value |
requirements: - target |
...
data
...
map of String
...
0..n
...
A map of strings that contains a set of key-value pairs that carries the dynamic deployment values which used to replace the corresponding variable parts in the file as identify by a URL as described in source_path. Shall be present if "source_path" is present and shall be absent otherwise..
...
content
...
The string information used to customize a virtualised or containerized compute resource at boot time.
...
source_path
...
The URL to a file contained in the VNF package used to customize a virtualised or containerized compute resource. The content shall comply with IETF RFC 3986 [8].
...
destination_path
...
The URL address when inject a file into the virtualised or containerized compute resource. The content shall comply with IETF RFC 3986 [8].
ChecksumData Data Model
...
tosca.datatypes.nfv.ChecksumData:
derived_from: tosca.datatypes.Root
description: Describes information about the result of performing a checksum operation over some arbitrary data
...
algorithm
...
String
...
1
...
Describes the algorithm used to obtain the checksum value
...
hash
...
Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers
vduCp Data Model
- tosca.nodes.nfv.VduCP
- No Change since 2.7.1
vnfExtCp Data Model
- tosca.nodes.nfv.VnfExtCP
- No Change since 2.7.1
- There are some changes from 2.6.1 to 2.7.1
- property "vnic_type" has the following extra valid_values:
- macvtap, baremetal, virtio-forwarder, smart-nic
- and the following removed valid_values - backwards incompatible:
- virtio
- requirement "virtual_link" cardinality changed from default (1-1) to 0-1
- requirement "virtual_binding" cardinality changed from default (1-1) to 1-1, i.e. no effective change
- property "vnic_type" has the following extra valid_values:
- requirement "external_virtual_link" cardinality changed from default (1-1) to 0-1
- requirement "internal_virtual_link" cardinality changed from default (1-1) to 1-1, i.e. no effective change
VduCompute Data Model
- tosca.nodes.nfv.Vdu.Compute
- No Change since 2.7.1
- There are some changes from 2.6.1 to 2.7.1
- property "boot_order" changed from list to boolean
- Backwards incompatible change from 2.6.1 -> 2.7.1
- property "nfvi_constraints" changed from list to map
- Backwards incompatible change from 2.6.1 -> 2.7.1
- property "boot_data" changed from string to tosca.datatypes.nfv.BootData
- property "boot_order" changed from list to boolean
- The configurable_properties is still out of scope in Honolulu
tosca.nodes.nfv.Vdu.Compute:
derived_from: tosca.nodes.Root
description: Describes the virtual compute part of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC
name
String
1
Human readable name of the VDU
description
Human readable description of the VDU
boot_order
indicates whether the order of the virtual_storage requirements is used as the boot index (the first requirement represents the lowest index and defines highest boot priority)
default: false
nfvi_constraints
Describes constraints on the NFVI for the VNFC instance(s) created from this VDU. This property is reserved for future use in the present document.
monitoring_parameters
tosca.datatypes.nfv.VnfcMonitoringParameter
Describes monitoring parameters applicable to a VNFC instantiated from this VDU
#configurable_properties
tosca.datatypes.nfv.VnfcConfigurableProperties
derived types are expected to introduce configurable_properties with its type derived from tosca.datatypes.nfv.VnfcConfigurableProperties
vdu_profile
tosca.datatypes.nfv.VduProfile
Defines additional instantiation data for the VDU.Compute node
sw_image_data
tosca.datatypes.nfv.SwImageData
Defines information related to a SwImage artifact used by this Vdu.Compute node
boot_data
tosca.datatypes.nfv.BootData
Contains the information used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM.
capabilities:
virtual_compute:
type: tosca.capabilities.nfv.VirtualCompute
occurrences: [ 1, 1 ]
virtual_binding:
type: tosca.capabilities.nfv.VirtualBindable
occurrences: [ 1, UNBOUNDED ]
requirements:
- virtual_storage: capability: tosca.capabilities. |
Node relationship: tosca.relationships. |
DependsOn occurrences: [ |
1, UNBOUNDED ] |
VduVirtualBlockStorage Data Model
tosca.nodes.nfv.Vdu.VirtualBlockStorage
- property "sw_image_data" deprecated in 3.3.1
VduVirtualObjectStorage Data Model
tosca.nodes.nfv.Vdu.VirtualObjectStorage
- No Change since 2.7.1
VduVirtualFileStorage Data Model
tosca.nodes.nfv.Vdu.VirtualFileStorage
- requirement "virtual_binding" cardinality changed from default (1-1) to 1-1, i.e. no effective change in 3.3.1
VnfVirtualLink Data Model
tosca.nodes.nfv.VnfVirtualLink
- No Change since 2.7.1
VipCp Data Model
...
- virtual_link: capability: tosca.capabilities.nfv.VirtualLinkable relationship: tosca.relationships.nfv.VipVirtualLinksTo occurrences: [1, 1] |
#VirtualCp Data Model
Gliffy Diagram macroId 7382e3d4-b2aa-40fe-8653-3420b8c9d980 name v4.1.1 VirtualCp pagePin 1
tosca.nodes.nfv.VipCpVirtualCp: derived_from: tosca.nodes.nfv.Cp description: Describes a virtual connection point allowing the access to allocate one or a set of virtual IP addresses number of VNFC instances (based on their respective VDUs). | |||||||||
Id | Type | Cardinality | Constraints | Description | |||||
---|---|---|---|---|---|---|---|---|---|
additionalServiceData | list of tosca.datatypes.nfv.AdditionalServiceData | 1 | References the VDU(s) which implement this service | vip_function | String | 1 | - valid_values: [ high_availability, load_balance ] | Describes the algorithm used to obtain the checksum value | |
requirements: - target: capability: tosca.capabilities.Node relationship: tosca.relationships.DependsOn occurrences: [ 1, UNBOUNDED ] - virtual_link: capability: tosca.capabilities.nfv.VirtualLinkable relationship: tosca.relationships.nfv.VipVirtualLinksToVirtVirtualLinksTo occurrences: [1, 1] |
...
Data
...
tosca.nodes.nfv.VirtualCp:
derived_from: tosca.nodes.nfv.Cp
description: Describes a virtual connection point allowing the access to a number of VNFC instances (based on their respective VDUs).
...
types. (Input from Michael Morris)
- Will refine the following...
Changed
The following data types already in ONAP have been changed from 2.5.1:
...
additionalServiceData
...
- tosca.datatypes.nfv.
...
1
...
References the VDU(s) which implement this service
...
requirements:
- target:
capability: tosca.capabilities.Node
relationship: tosca.relationships.DependsOn
occurrences: [ 1, UNBOUNDED ]
- virtual_link:
capability: tosca.capabilities.nfv.VirtualLinkable
relationship: tosca.relationships.nfv.VirtVirtualLinksTo
occurrences: [1, 1]
- VirtualMemory:
property "numa_enabled" default value changed from false to true.// In ONAP, the default is still false- in ETSI, there is no Change since 2.5.1/2.7.1
- tosca.datatypes.nfv.VnfcConfigurableProperties:
- property "additional_vnfc_configurable_properties" commented out in ONAP dataTypes.yml
- In ETSI, there is no other change since 2.5.1/2.7.1
- tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties:
- property "description" removed
- In ETSI, there is no other change since 2.5.1/2.7.1
Data types. (Input from Michael Morris)
- Will refine the following...
Changed
...
- tosca.datatypes.nfv.VirtualMemory:
- property "numa_enabled" default value changed from false to true
- version in ONAP contains extra properties not in ETSI:
- "watchdog", "vmBootUpTimeOut"
- Keep the extra properties in ONAP; no change in ONAP
- In ETSI, there is no other change since 2.5.1/2.7.1
- property "additional_vnfc_configurable_properties" commented out
- tosca.datatypes.nfv.VnfcAdditionalConfigurablePropertiesL2ProtocolData:
- property "description" removed
- vlan_transparent" now mandatory; change required to Yes; in ONAP change the required to true; default to true;
- property "segmentation_id" is introduced in 2.7.1. Now it is in both ETSI and ONAP, but ETSI defined it as a string, but ONAP defined it as integer; If possible, change it to String to conform to ETSI
- version in ONAP contains extra properties not in ETSI:
- "watchdog", "vmBootUpTimeOut"physical_network" with type String and required false
- tosca.datatypes.nfv.L2ProtocolDataVnfLcmOperationsConfiguration:
- property "vlan_transparent" now mandatory
- version in ONAP contains extra properties not in ETSI:
- "segmentation_id" -> now in ONAP but as a string rather than int
- "physical_network"
- new properties added in ETSI 3.3.1:
- change_current_package: optional, type: tosca.datatypes.nfv.VnfChangeCurrentPackageOperationConfiguration
- create_snapshot: optional, type: tosca.datatypes.nfv.
- VnfCreateSnapshotOperationConfiguration
- revert_to_snapshot: optional, type: tosca.datatypes.nfv.VnfRevertToSnapshotOperationConfiguration
- Add the above properties to ONAP dataTypes.yml
- new properties added:change_current_package, create_snapshot, revert_to_snapshot
- tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
- property "description" removed""; need to remove this description property from ONAP dataType.yml
- there is no change in ETSI since 2.5.1/2.7.1
- toscatosca.datatypes.nfv.VnfScaleOperationConfiguration
- property "scaling_by_more_than_one_step_supported" now mandatory for 3.3.1; change its "required" to true and "default" to true.
- tosca.datatypes.nfv.VnfConfigurableProperties:
- new optional properties added :since 2.7.1
- vnfm_interface_info: optional, type: tosca.datatypes.nfv.VnfmInterfaceInfo
- vnfm, vnfm_oauth_server_info, vnf: optional, type: tosca.datatypes.nfv.OauthServerInfo
- vnf_oauth_server_info: optional, type: tosca.datatypes.nfv.OauthServerInfo
existing property commented out:additional_configurable_property
- In ONAP dataType.yml, change the property "existing property commented out:additional_configurable_properties" to "additional_configurable_property"
- new optional properties added :since 2.7.1
- tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
- new required property added :since 2.7.1
- is_writable_anytime: required true, type: boolean
- existing property removed: (remove it from ONAP dataType.yml)
- existing property removed:
- description
- description
- new required property added :since 2.7.1
- tosca.datatypes.nfv.VnfInfoModifiableAttributes:
existing properties commented out:extensions, metadata
- No change since 2.5.1/2.7.1
- tosca.datatypes.nfv.VnfInfoModifiableAttributesVnfInfoModifiableAttributesExtensions:
- existing properties commented out:property removed: need to remove the following property from ONAP dataTypes.yml
- description
- In ETSI, there is no change since 2.5.1/2.7.1extensions, metadata
- existing properties commented out:property removed: need to remove the following property from ONAP dataTypes.yml
- tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensionsVnfInfoModifiableAttributesMetadata:
- existing property removed: need to remove the following property from ONAP dataTypes.yml
- description
- In ETSI, there is no change since 2.5.1/2.7.1
- existing property removed: need to remove the following property from ONAP dataTypes.yml
- tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadataSwImageData:
- existing property removed:
- description
- new optional property added since 2.7.1; add the property to ONAP dataType.yml
- provider: optional, type: string
- property "checksum" changed type from string to tosca.datatypes.nfv
- .ChecksumData since 2.7.1; change ONAP dataType.yml for this.
- property "min_disk" new constraint added "greater_or_equal: 0 B" since 2.7.1; change ONAP dataType.yml for this
- new optional property added:
- provider
- property "checksum" changed type from string to tosca.datatypes.nfv.ChecksumData
- property "min_diskram" new constraint added "greater_or_equal: 0 B" since 2.7.1; change ONAP dataType.yml for this
- existing property removed:
- tosca.datatypes.nfv.VirtualBlockStorageData:
- property "minsize_of_ramstorage" new constraint added "greater_or_equal: 0 B" since 2.7.1; change ONAP dataType.yml for this
- property "rdma_enabled" now required; change ONAP dataType.yml for this
- tosca.datatypes.nfv.VirtualBlockStorageDataVirtualObjectStorageData:
- property "max_size_of_storage" new constraint added "greater_or_equal: 0 B"
- property "rdma_enabled" now required
- since 2.7.1; change ONAP dataType.yml for this
- tosca.datatypes.nfv.VirtualObjectStorageDataVirtualFileStorageData:
- property "max_size_of_storage" new constraint added "greater_or_equal: 0 B" since 2.7.1; change ONAP dataType.yml for this
- tosca.datatypes.nfv.VirtualFileStorageDataVirtualLinkBitrateLevel:
- existing property removed: need to remove this property from ONAP dataType.yml
- description
- In ETSI, there is no change since 2.5.1/2.7.1property "size_of_storage" new constraint added "greater_or_equal: 0 B"
- existing property removed: need to remove this property from ONAP dataType.yml
- tosca.datatypes.nfv.VirtualLinkBitrateLevelVnfOperationAdditionalParameters:
- existing property removed: need to remove this property from ONAP dataType.yml
- description
- In ETSI, there is no change since 2.5.1/2.7.1
- existing property removed: need to remove this property from ONAP dataType.yml
- tosca.datatypes.nfv.VnfOperationAdditionalParametersVnfChangeFlavourOperationConfiguration:
- existing property removed:
- description
- description
- In ETSI, there is no change since 2.5.1/2.7.1
- existing property removed:
- tosca.datatypes.nfv.VnfChangeFlavourOperationConfigurationVnfChangeExtConnectivityOperationConfiguration:
- existing property removed: need to remove this property from ONAP dataType.yml
- description
- In ETSI, there is no change since 2.5.1/2.7.1
- existing property removed: need to remove this property from ONAP dataType.yml
- tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
- existing property removed:
- description
- existing property removed:
- tosca.datatypes.nfv.VnfcMonitoringParameter
- property "performance_metric" new valid_values added :since 2.7.1; add the new valid_values to ONAP dataType.yml
- v_cpu_usage_mean, v_cpu_usage_peak,v_memory_usage_mean,v_memory_usage_peak, v_disk_usage_mean, v_disk_usage_peak, v_net_byte_incoming, v_net_byte_outgoing, v_net_packet_incoming, v_net_packet_outgoing, usage_mean_vStorage, usage_peak_vStorage
- property "performance_metric" new valid_values added :since 2.7.1; add the new valid_values to ONAP dataType.yml
...
- tosca.datatypes.nfv.VirtualLinkMonitoringParameter:
- property "performance_metric" " valid_values added since 2.7.1; add the new valid_values added:to ONAP dataType.yml
- byte_incoming, byte_outgoing, packet_incoming, packet_outgoing
- property "performance_metric" valid_values removed :since 2.7.1; remove the valid_values from ONAP dataType.yml
- packet_outgoing_virtual_link, packet_incoming_virtual_link
- property "performance_metric" " valid_values added since 2.7.1; add the new valid_values added:to ONAP dataType.yml
...
- tosca.datatypes.nfv.VnfProfile
- new optional property "service_availability_level" since 2.7.1; optional, type: tosca.datatypes.nfv.ServiceAvailability; add the property to ONAP dataType.yml
- tosca.datatypes.nfv.L3AddressData
- version in SDC contains extra property not defined in ETSI: keep the extra property in ONAP dataType.yml
- fixed_ip_address
- In ETSI, there is no change since 2.5.1/2.7.1
- version in SDC contains extra property not defined in ETSI: keep the extra property in ONAP dataType.yml
Unchanged
The following data types are included in SDC but have no changes:
...