Page History

...

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 

VNF Data Model

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

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

OsContainer VDU  Data Model

VDU OsContainer Data Model

VDU OsContainerGroup Data Model

MciopProfile Data Model

VnfInstantiateOperationConfiguration Data Model

VnfMonitoringParameter Data Model

VnfProfile Data Model

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).

...

#     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

  description: describes a specific VDU

...

vduId

...

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.

VnfInstantiateOperationConfiguration Data Model

VnfMonitoringParameter Data Model

...

BootData Data Model

SwImageData Data Model

...

BootDataVimSpecificProperties Data Model

KvpData Data Model

ContentOrFileData Data Model

BootData Data Model

ChecksumData Data Model

vduCp Data Model

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.

...

data

...

map of String

...

0..n

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
• 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
• The configurable_properties is still out of scope in Honolulu

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

...

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
• 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
• The configurable_properties is still out of scope in Honolulu

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

...

#VirtualCp Data Model

...

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
  VduProfile:
  • 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
  tosca.datatypes.nfv.VnfcConfigurableProperties:
  • property "additional_vnfc_configurable_properties" commented out
• tosca.datatypes.nfv.VnfcAdditionalConfigurablePropertiesL2ProtocolData:
  • property "description" removed
  tosca.datatypes.nfv.VduProfile:
  • 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.
  VnfLcmOperationsConfiguration:
  • • 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" 

• 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

  
  

  • 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

  
  

  • 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

  
  

  • tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadataSwImageData:
    • existing property removed:
      • description
    tosca
    • 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
    .SwImageData:
    • .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

  
  

  
  

  • 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"

  
  

  • 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

  
  

  • tosca.datatypes.nfv.VnfOperationAdditionalParametersVnfChangeFlavourOperationConfiguration:
    • existing property removed:
      • description
      : need to remove this property from ONAP dataType.yml
      • description
    • In ETSI, there is no change since 2.5.1/2.7.1

  
  

  • 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

  
  

  • tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
    • existing property removed:
      • description
  • 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

  ...

  • 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

  ...

  • 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

  Unchanged

   The following data types are included in SDC but have no changes:

  ...