Newer
Older
derived_from: tosca.datatypes.Root
description: Supports the specification of requirements related to extended resources of a container.
properties:
extended_resource:
type: map
description: The hardware platform specific extended resource. A map of string that contains one single key-value pair that describes one hardware platform specific container requirement.
required: true
entry_schema:
type: string
constraints:
- min_length: 1
- max_length: 1
amount:
type: integer
description: Requested amount of the indicated extended resource.
required: true
tosca.datatypes.nfv.Hugepages:
derived_from: tosca.datatypes.Root
description: Supports the specification of requirements on a particular hugepage size in terms of total memory needs.
properties:
hugepage_size:
type: scalar-unit.size
description: Specifies the size of the hugepage.
required: true
requested_size:
type: scalar-unit.size
description: Specifies the total size required for all the hugepages of the size indicated by hugepage_size.
required: true
tosca.datatypes.nfv.MaxNumberOfImpactedInstances:
derived_from: tosca.datatypes.Root
description: Specifies the maximum number of instances of a given Vdu.Compute node or VnfVirtualLink node that may be impacted simultaneously without impacting the functionality of the group of a given size.
properties:
group_size:
type: integer
description: Determines the size of the group for which the max_number_of_impacted_instances is specified. If not present the size is not limited.
required: false
max_number_of_impacted_instances:
type: integer
description: The maximum number of instances that can be impacted simultaneously within the group of the specified size.
required: true
tosca.datatypes.nfv.MinNumberOfPreservedInstances:
derived_from: tosca.datatypes.Root
description: Specifies the minimum number of instances of a given Vdu.Compute node or VnfVirtualLink node which need to be preserved simultaneously.
properties:
group_size:
type: integer
description: Determines the size of the group for which the min_number_of_preserved_instances is specified. If not present the size is not limited.
required: false
min_number_of_preserved_instances:
type: integer
description: The minimum number of instances which need to be preserved simultaneously within the group of the specified size.
required: true
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
tosca.datatypes.nfv.NfviMaintenanceInfo:
derived_from: tosca.datatypes.Root
description: Provides information related to the constraints and rules applicable to virtualised resources and their groups impacted due to NFVI maintenance operations
properties:
impact_notification_lead_time:
type: scalar-unit.time
description: Specifies the minimum notification lead time requested for upcoming impact of the virtualised resource or their group (i.e. between the notification and the action causing the impact).
required: true
is_impact_mitigation_requested:
type: boolean
description: Indicates whether it is requested that at the time of the notification of an upcoming change that is expected to have an impact on the VNF, virtualised resource(s) of the same characteristics as the impacted ones is/are provided to compensate for the impact (TRUE) or not (FALSE).
required: true
default: false
supported_migration_type:
type: list
description: Specifies the allowed migration types in the order of preference in case of an impact starting with the most preferred type. It is applicable to the Vdu.Compute node and to the VirtualBlockStorage, VirtualObjectStorage and VirtualFileStorage nodes.
required: false
entry_schema:
type: string
constraints:
- valid_values: [ no_migration, offline_migration, live_migration ]
max_undetectable_interruption_time:
type: scalar-unit.time
description: Specifies the maximum interruption time that can go undetected at the VNF level and therefore which will not trigger VNF-internal recovery during live migration. It is applicable to the Vdu.Compute node and to the VirtualBlockStorage, VirtualObjectStorage and VirtualFileStorage nodes.
required: false
min_recovery_time_between_impacts:
type: scalar-unit.time
description: Specifies the time required by the group to recover from an impact, thus, the minimum time requested between consecutive impacts of the group..
required: false
max_number_of_impacted_instances:
type: list
description: Specifies for different group sizes the maximum number of instances that can be impacted simultaneously within the group of virtualised resources without losing functionality.
required: false
entry_schema:
type: tosca.datatypes.nfv.MaxNumberOfImpactedInstances
min_number_of_preserved_instances:
type: list
description: Specifies for different group sizes the minimum number of instances which need to be preserved simultaneously within the group of virtualised resources.
required: false
entry_schema:
type: tosca.datatypes.nfv.MinNumberOfPreservedInstances
artifact_types:
tosca.artifacts.nfv.SwImage:
derived_from: tosca.artifacts.Deployment.Image
description: describes the software image which is directly loaded on the virtualisation container realizing of the VDU or is to be loaded on a virtual storage resource
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
properties:
name:
type: string
description: Name of this software image
required: true
version:
type: string
description: Version of this software image
required: true
provider:
type: string
description: Provider of this software image
required: false
checksum:
type: tosca.datatypes.nfv.ChecksumData
description: Checksum of the software image file
required: true
container_format:
type: string
description: The container format describes the container file format in which software image is provided
required: true
constraints:
- valid_values: [ aki, ami, ari, bare, docker, ova, ovf ]
disk_format:
type: string
description: The disk format of a software image is the format of the underlying disk image
constraints:
- valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ]
min_disk:
type: scalar-unit.size # Number
description: The minimal disk size requirement for this software image
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
constraints:
- greater_or_equal: 0 B
min_ram:
type: scalar-unit.size # Number
description: The minimal RAM requirement for this software image
required: false
constraints:
- greater_or_equal: 0 B
size:
type: scalar-unit.size # Number
description: The size of this software image
required: true
operating_system:
type: string
description: Identifies the operating system used in the software image
required: false
supported_virtualisation_environments:
type: list
description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image
required: false
entry_schema:
type: string
tosca.artifacts.Implementation.nfv.Mistral:
derived_from: tosca.artifacts.Implementation
description: artifacts for Mistral workflows
mime_type: application/x-yaml
file_ext: [ yaml ]
tosca.artifacts.nfv.HelmChart:
derived_from: tosca.artifacts.File
description: describes the Helm chart artifact.
file_ext: [ tar, tar.gz, tgz ]
tosca.capabilities.nfv.VirtualBindable:
derived_from: tosca.capabilities.Node
description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.VirtualBindsTo relationship type which is used to model the VduHasCpd association
tosca.capabilities.nfv.VirtualCompute:
derived_from: tosca.capabilities.Node
description: Describes the capabilities related to virtual compute resources
properties:
logical_node:
type: map
description: Describes the Logical Node requirements
required: false
entry_schema:
type: tosca.datatypes.nfv.LogicalNodeData
requested_additional_capabilities:
type: map
description: Describes additional capability for a particular VDU
required: false
entry_schema:
type: tosca.datatypes.nfv.RequestedAdditionalCapability
type: map
required: false
entry_schema:
type: string
type: tosca.datatypes.nfv.VirtualMemory
description: Describes virtual memory of the virtualized compute
required: true
type: tosca.datatypes.nfv.VirtualCpu
description: Describes virtual CPU(s) of the virtualized compute
required: true
type: list
description: A list of virtual system disks created and destroyed as part of the VM lifecycle
required: false
entry_schema:
type: tosca.datatypes.nfv.VirtualBlockStorageData
description: virtual system disk definition
tosca.capabilities.nfv.VirtualStorage:
derived_from: tosca.capabilities.Root
description: Describes the attachment capabilities related to Vdu.Storage
tosca.capabilities.nfv.TrunkBindable:
derived_from: tosca.capabilities.Node
description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.TrunkBindsTo relationship type which is used to model the trunkPortTopology.
tosca.capabilities.nfv.ContainerDeployable:
derived_from: tosca.capabilities.Node
description: A node type that includes the ContainerDeployable capability indicates that it can be pointed by tosca.relationships.nfv.DeploysTo relationship type
tosca.capabilities.nfv.AssociableVdu:
derived_from: tosca.capabilities.Node
description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.MciopAssociates relationship type which is used to model the associatedVdu property of the MciopProfile information element defined in ETSI GS NFV-IFA 011 [1].
relationship_types:
tosca.relationships.nfv.VirtualBindsTo:
derived_from: tosca.relationships.DependsOn
description: Represents an association relationship between Vdu.Compute or Vdu.OsContainerDeployableUnit and VduCp node types
valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ]
tosca.relationships.nfv.AttachesTo:
derived_from: tosca.relationships.Root
description: Represents an association relationship between the Vdu.Compute or Vdu.OsContainerDeployableUnit and one of the node types, Vdu.VirtualBlockStorage, Vdu.VirtualObjectStorage or Vdu.VirtualFileStorage
valid_target_types: [ tosca.capabilities.nfv.VirtualStorage ]
tosca.relationships.nfv.TrunkBindsTo:
derived_from: tosca.relationships.DependsOn
description: Represents the association relationship between a VduCp node used as a trunk port and other VduSubCp nodes used as subports of the same trunk.
valid_target_types: [ tosca.capabilities.nfv.TrunkBindable ]
tosca.relationships.nfv.DeploysTo:
derived_from: tosca.relationships.DependsOn
description: Represents an association relationship between Vdu.OsContainerDeployableUnit and Vdu.OsContainer node types
valid_target_types: [tosca.capabilities.nfv.ContainerDeployable]
tosca.relationships.nfv.MciopAssociates:
derived_from: tosca.relationships.DependsOn
description: Represents an association relationship between Mciop and Vdu.OsContainerDeployableUnit node types
valid_target_types: [ tosca.capabilities.nfv.AssociableVdu ]
interface_types:
tosca.interfaces.nfv.Vnflcm:
derived_from: tosca.interfaces.Root
description: This interface encompasses a set of TOSCA operations corresponding to the VNF LCM operations defined in ETSI GS NFV-IFA 007 as well as to preamble and postamble procedures to the execution of the VNF LCM operations.
operations:
instantiate:
description: Invoked upon receipt of an Instantiate VNF request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
instantiate_start:
description: Invoked before instantiate
instantiate_end:
description: Invoked after instantiate
terminate:
description: Invoked upon receipt Terminate VNF request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
terminate_start:
description: Invoked before terminate
terminate_end:
description: Invoked after terminate
modify_information:
description: Invoked upon receipt of a Modify VNF Information request
modify_information_start:
description: Invoked before modify_information
modify_information_end:
description: Invoked after modify_information
change_flavour:
description: Invoked upon receipt of a Change VNF Flavour request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
change_flavour_start:
description: Invoked before change_flavour
change_flavour_end:
description: Invoked after change_flavour
change_external_connectivity:
description: Invoked upon receipt of a Change External VNF Connectivity request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
change_external_connectivity_start:
description: Invoked before change_external_connectivity
change_external_connectivity_end:
description: Invoked after change_external_connectivity
operate:
description: Invoked upon receipt of an Operate VNF request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
operate_start:
description: Invoked before operate
operate_end:
description: Invoked after operate
heal:
description: Invoked upon receipt of a Heal VNF request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
inputs:
cause:
type: string
description: Indicates the reason why a healing procedure is required.
required: false
vnfc_instance_ids:
type: list
entry_schema:
type: string
description: List of VNFC instances requiring a healing action.
required: false
heal_start:
description: Invoked before heal
heal_end:
description: Invoked after heal
scale:
description: Invoked upon receipt of a Scale VNF request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
inputs:
type:
type: string
description: Indicates the type of the scale operation requested.
required: false
constraints:
- valid_values: [ scale_out, scale_in ]
aspect:
type: string
description: Identifier of the scaling aspect.
required: false
number_of_steps:
type: integer
description: Number of scaling steps to be executed.
required: true
constraints:
- greater_than: 0
default: 1
scale_start:
description: Invoked before scale
scale_end:
description: Invoked after scale
scale_to_level:
description: Invoked upon receipt of a Scale VNF to Level request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
inputs:
instantiation_level:
type: string
description: Identifier of the target instantiation level of the current deployment flavour to which the VNF is requested to be scaled. Either instantiation_level or scale_info shall be provided.
required: false
scale_info:
type: map # key: aspectId
description: For each scaling aspect of the current deployment flavour, indicates the target scale level to which the VNF is to be scaled. Either instantiation_level or scale_info shall be provided.
required: false
entry_schema:
type: tosca.datatypes.nfv.ScaleInfo
scale_to_level_start:
description: Invoked before scale_to_level
scale_to_level_end:
description: Invoked after scale_to_level
create_snapshot:
description: Invoked upon receipt of a Create VNF snapshot request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
create_snapshot_start:
description: Invoked before create_snapshot
create_snapshot_end:
description: Invoked after create_snapshot
revert_to_snapshot:
description: Invoked upon receipt of a Revert to VNF snapshot request
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
revert_to_snapshot_start:
description: Invoked before revert_to_snapshot
revert_to_snapshot_end:
description: Invoked after revert_to_snapshot
change_current_package:
description: Invoked by tosca.policies.nfv.VnfPackageChange
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
change_current_package_start:
description: Invoked by tosca.policies.nfv.VnfPackageChange
change_current_package_end:
description: Invoked by tosca.policies.nfv.VnfPackageChange
notifications:
change_current_package_notification:
description: Invoked upon receipt of a ChangeCurrentVnfPackage request
change_current_package_start_notification:
description: Invoked before the operation designated to changing the current VNF package
change_current_package_end_notification:
description: Invoked after the operation designated to changing the current VNF package
derived_from: tosca.interfaces.Root
description: This interface is an empty base interface type for deriving VNF specific interface types that include VNF indicator specific notifications.
tosca.interfaces.nfv.ChangeCurrentVnfPackage:
derived_from: tosca.interfaces.Root
description: This interface is an empty base interface type for deriving VNF specific interface types that include VNF Change Current VNF Package specific operation.
# operations:
# operation_name: name of a VNF-specific operation serving the Change current VNF Package request.
# description: Invoked by tosca.policies.nfv.VnfPackageChange
# inputs:
# additional_parameters:
# type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
# required: false
# derived types are expected to introduce additional_parameters with its
# type derived from tosca.datatypes.nfv.VnfOperationAdditionalParameters
node_types:
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
properties:
descriptor_id: # instead of vnfd_id
type: string # UUID
description: Identifier of this VNFD information element. This attribute shall be globally unique
required: true
descriptor_version: # instead of vnfd_version
type: string
description: Identifies the version of the VNFD
required: true
provider: # instead of vnf_provider
type: string
description: Provider of the VNF and of the VNFD
required: true
product_name: # instead of vnf_product_name
type: string
description: Human readable name for the VNF Product
required: true
software_version: # instead of vnf_software_version
type: string
description: Software version of the VNF
required: true
product_info_name: # instead of vnf_product_info_name
type: string
description: Human readable name for the VNF Product
required: false
product_info_description: # instead of vnf_product_info_description
type: string
description: Human readable description of the VNF Product
required: false
type: list
required: true
description: Identifies VNFM(s) compatible with the VNF
entry_schema:
type: string
constraints:
- pattern: (^etsivnfm:v[0-9]?[0-9]\.[0-9]?[0-9]\.[0-9]?[0-9]$)|(^[0-9]+:[a-zA-Z0-9.-]+$)
type: list
description: Information about localization languages of the VNF
required: false
entry_schema:
type: string #IETF RFC 5646 string
default_localization_language:
type: string #IETF RFC 5646 string
description: Default localization language that is instantiated if no information about selected localization language is available
required: false
#type: tosca.datatypes.nfv.VnfConfigurableProperties
#description: Describes the configurable properties of the VNF
#required: false
# derived types are expected to introduce configurable_properties
# with its type derived from tosca.datatypes.nfv.VnfConfigurableProperties
#type: tosca.datatypes.nfv.VnfInfoModifiableAttributes
#description: Describes the modifiable attributes of the VNF
#required: false
# derived types are expected to introduce modifiable_attributes
# with its type derived from
# tosca.datatypes.nfv.VnfInfoModifiableAttributes
lcm_operations_configuration:
type: tosca.datatypes.nfv.VnfLcmOperationsConfiguration
description: Describes the configuration parameters for the VNF LCM operations
required: false
type: map # key: id
entry_schema:
type: tosca.datatypes.nfv.VnfMonitoringParameter
description: Describes monitoring parameters applicable to the VNF.
required: false
type: string
description: Identifier of the Deployment Flavour within the VNFD
required: true
type: string
description: Human readable description of the DF
required: true
type: tosca.datatypes.nfv.VnfProfile
description: Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF
required: false
attributes:
scale_status:
type: map # key: aspectId
description: 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.
entry_schema:
type: tosca.datatypes.nfv.ScaleInfo
requirements:
- virtual_link:
capability: tosca.capabilities.nfv.VirtualLinkable
relationship: tosca.relationships.nfv.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
tosca.nodes.nfv.VnfExtCp:
derived_from: tosca.nodes.nfv.Cp
description: Describes a logical external connection point, exposed by the VNF enabling connection with an external Virtual Link
properties:
virtual_network_interface_requirements:
type: list
description: The actual virtual NIC requirements that is been assigned when instantiating the connection point
required: false
entry_schema:
type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
requirements:
- external_virtual_link:
capability: tosca.capabilities.nfv.VirtualLinkable
relationship: tosca.relationships.nfv.VirtualLinksTo
occurrences: [0, 1]
- internal_virtual_link:
capability: tosca.capabilities.nfv.VirtualLinkable
relationship: tosca.relationships.nfv.VirtualLinksTo
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
type: string
description: Human readable name of the VDU
required: true
type: string
description: Human readable description of the VDU
required: true
type: boolean
description: 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)
required: true
default: false
type: map
description: 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.
required: false
entry_schema:
type: string
type: map # key: id
description: Describes monitoring parameters applicable to a VNFC instantiated from this VDU
required: false
entry_schema:
type: tosca.datatypes.nfv.VnfcMonitoringParameter
#type: tosca.datatypes.nfv.VnfcConfigurableProperties
#required: false
# derived types are expected to introduce
# configurable_properties with its type derived from
# tosca.datatypes.nfv.VnfcConfigurableProperties
type: tosca.datatypes.nfv.VduProfile
description: Defines additional instantiation data for the VDU.Compute node
required: true
type: tosca.datatypes.nfv.BootData
description: 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.
required: false
capabilities:
virtual_compute:
type: tosca.capabilities.nfv.VirtualCompute
occurrences: [ 1, 1 ]
type: tosca.capabilities.nfv.VirtualBindable
occurrences: [ 1, UNBOUNDED ]
requirements:
- virtual_storage:
capability: tosca.capabilities.nfv.VirtualStorage
relationship: tosca.relationships.nfv.AttachesTo
occurrences: [ 0, UNBOUNDED ]
tosca.nodes.nfv.Vdu.VirtualBlockStorage:
derived_from: tosca.nodes.Root
description: This node type describes the specifications of requirements related to virtual block storage resources
properties:
virtual_block_storage_data:
type: tosca.datatypes.nfv.VirtualBlockStorageData
description: Describes the block storage characteristics.
required: true
per_vnfc_instance:
type: boolean
description: Indicates whether the virtual storage descriptor shall be instantiated per VNFC instance.
required: true
nfvi_maintenance_info:
type: tosca.datatypes.nfv.NfviMaintenanceInfo
description: Provides information on the rules to be observed when an instance based on this VirtualBlockStorage is impacted during NFVI operation and maintenance (e.g. NFVI resource upgrades).
capabilities:
virtual_storage:
type: tosca.capabilities.nfv.VirtualStorage
description: Defines the capabilities of virtual_storage.
tosca.nodes.nfv.Vdu.VirtualObjectStorage:
derived_from: tosca.nodes.Root
description: This node type describes the specifications of requirements related to virtual object storage resources
properties:
virtual_object_storage_data:
type: tosca.datatypes.nfv.VirtualObjectStorageData
description: Describes the object storage characteristics.
per_vnfc_instance:
type: boolean
description: Indicates whether the virtual storage descriptor shall be instantiated per VNFC instance.
required: true
default: true
nfvi_maintenance_info:
type: tosca.datatypes.nfv.NfviMaintenanceInfo
description: Provides information on the rules to be observed when an instance based on this VirtualObjectStorage is impacted during NFVI operation and maintenance (e.g. NFVI resource upgrades).
required: false
capabilities:
virtual_storage:
type: tosca.capabilities.nfv.VirtualStorage
description: Defines the capabilities of virtual_storage.
tosca.nodes.nfv.Vdu.VirtualFileStorage:
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
derived_from: tosca.nodes.Root
description: This node type describes the specifications of requirements related to virtual file storage resources
properties:
virtual_file_storage_data:
type: tosca.datatypes.nfv.VirtualFileStorageData
description: Describes the file storage characteristics.
required: true
per_vnfc_instance:
type: boolean
description: Indicates whether the virtual storage descriptor shall be instantiated per VNFC instance.
required: true
default: true
nfvi_maintenance_info:
type: tosca.datatypes.nfv.NfviMaintenanceInfo
description: Provides information on the rules to be observed when an instance based on this VirtualFileStorage is impacted during NFVI operation and maintenance (e.g. NFVI resource upgrades).
required: false
capabilities:
virtual_storage:
type: tosca.capabilities.nfv.VirtualStorage
#description: Defines the capabilities of virtual_storage.
requirements:
- virtual_link:
capability: tosca.capabilities.nfv.VirtualLinkable
relationship: tosca.relationships.nfv.VirtualLinksTo
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
occurrences: [1, 1]
# description: Describes the requirements for linking to virtual link
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
properties:
bitrate_requirement:
type: integer # in bits per second
description: Bitrate requirement in bit per second on this connection point
required: false
constraints:
- greater_or_equal: 0
virtual_network_interface_requirements:
type: list
description: Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD
required: false
entry_schema:
type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
order:
type: integer
description: The order of the NIC on the compute instance (e.g.eth2)
required: false
constraints:
- greater_or_equal: 0
vnic_type:
type: string
description: Describes the type of the virtual network interface realizing the CPs instantiated from this CPD
required: false
constraints:
- valid_values: [ normal, macvtap, direct, baremetal, virtio-forwarder, direct-physical, smart-nic, bridge, ipvlan, loopback, macvlan, ptp, vlan, host-device ]
capabilities:
trunk_binding: # This capability is available only the trunk_mode property value of this VduCp is true and there is at least one VduSubCp defined as subport of the same trunk.
type: tosca.capabilities.nfv.TrunkBindable
occurrences: [ 0, UNBOUNDED ]
requirements:
- virtual_link:
capability: tosca.capabilities.nfv.VirtualLinkable
relationship: tosca.relationships.nfv.VirtualLinksTo
occurrences: [1, 1]
- virtual_binding:
capability: tosca.capabilities.nfv.VirtualBindable
relationship: tosca.relationships.nfv.VirtualBindsTo
occurrences: [0, 1]
tosca.nodes.nfv.VnfVirtualLink:
derived_from: tosca.nodes.Root
description: Describes the information about an internal VNF VL
properties:
connectivity_type:
type: tosca.datatypes.nfv.ConnectivityType
description: Specifies the protocol exposed by the VL and the flow pattern supported by the VL
required: true
description: Provides human-readable information on the purpose of the VL
required: false
test_access:
type: list
description: Test access facilities available on the VL
required: false
entry_schema:
type: string
constraints:
- valid_values: [ passive_monitoring, active_loopback ]
type: tosca.datatypes.nfv.VlProfile
description: Defines additional data for the VL
required: true
type: map #key: id
entry_schema:
type: tosca.datatypes.nfv.VirtualLinkMonitoringParameter
description: Describes monitoring parameters applicable to the VL
required: false
nfvi_maintenance_info:
type: tosca.datatypes.nfv.NfviMaintenanceInfo
description: Provides information on the rules to be observed when an instance based on this VnfVirtualLink is impacted during NFVI operation and maintenance (e.g. NFVI resource upgrades).
required: false
capabilities:
virtual_linkable:
type: tosca.capabilities.nfv.VirtualLinkable
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
properties:
dedicated_ip_address:
type: boolean
description: Indicates whether the VIP address shall be different from the addresses allocated to all associated VduCp instances or shall be the same as one of them.
required: true
vip_function:
type: string
description: "Indicates the function the virtual IP address is used for: high availability or load balancing. When used for high availability, only one of the internal VDU CP instances or VNF external CP instances that share the virtual IP is bound to the VIP address at a time. When used for load balancing purposes all CP instances that share the virtual IP are bound to it."
required: true
constraints:
- valid_values: [ high_availability, load_balance ]
requirements:
- target:
capability: tosca.capabilities.Node
node: tosca.nodes.nfv.VduCp
relationship: tosca.relationships.DependsOn
occurrences: [ 1, UNBOUNDED ]
- virtual_link:
capability: tosca.capabilities.nfv.VirtualLinkable
relationship: tosca.relationships.nfv.VipVirtualLinksTo
occurrences: [1, 1]
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
tosca.nodes.nfv.VduSubCp:
derived_from: tosca.nodes.nfv.VduCp
description: describes network connectivity between a VNFC instance based on this VDU and an internal VL through a trunk port
properties:
segmentation_type:
type: string
description: Specifies the encapsulation type for the traffics coming in and out of the trunk subport.
required: false
constraints:
- valid_values: [ vlan, inherit ]
segmentation_id:
type: integer
description: Specifies the segmentation ID for the subport, which is used to differentiate the traffics on different networks coming in and out of the trunk port.
required: false
constraints:
- greater_or_equal: 0
requirements:
- trunk_binding:
capability: tosca.capabilities.nfv.TrunkBindable
relationship: tosca.relationships.nfv.TrunkBindsTo
node: tosca.nodes.nfv.VduCp
occurrences: [1, 1]
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
tosca.nodes.nfv.Vdu.OsContainer:
derived_from: tosca.nodes.Root
description: Describes the resources of a single OS container within a VDU
properties:
name:
type: string
description: Human readable name of the OS container
required: true
description:
type: string
description: Human readable description of the OS container
required: true
requested_cpu_resources:
type: integer
description: Number of CPU resources requested for the OS container (e.g. in milli-CPU-s).
required: false
constraints:
- greater_or_equal: 0
cpu_resource_limit:
type: integer
description: Number of CPU resources the OS container can maximally use (e.g. in milli-CPU).
required: false
constraints:
- greater_or_equal: 0
requested_memory_resources:
type: scalar-unit.size
description: Amount of memory resources requested for the OS container (e.g. in MB).
required: false
memory_resource_limit:
type: scalar-unit.size
description: Amount of memory resources the OS container can maximum use (e.g. in MB).
required: false
requested_ephemeral_storage_resources:
type: scalar-unit.size
description: Size of ephemeral storage resources requested for the OS container (e.g. in GB).
required: false
ephemeral_storage_resource_limit:
type: scalar-unit.size
description: Size of ephemeral storage resources the OS container can maximum use (e.g. in GB).
required: false
extended_resource_requests:
type: list
description: Extended resources and their respective amount required by the container.
required: false
entry_schema:
type: tosca.datatypes.nfv.ExtendedResourceData
constraints:
- min_length: 1
huge_pages_resources:
type: list
description: The requirement for huge pages resources. Each element in the list indicates a hugepage size and the total memory requested for hugepages of that size.
required: false
entry_schema:
type: tosca.datatypes.nfv.Hugepages
capabilities:
container_deployable:
type: tosca.capabilities.nfv.ContainerDeployable
occurrences: [ 1, UNBOUNDED ]
tosca.nodes.nfv.Vdu.OsContainerDeployableUnit:
derived_from: tosca.nodes.Root
description: Describes the aggregate of container of a VDU (when realized as OS containers) which supporting the description of the deployment and operational behavior of a VNFC
properties:
name:
type: string
description: Human readable name of the VDU
required: true
description:
type: string
description: Human readable description of the VDU
required: true
logical_node:
type: map
description: Describes the Logical Node requirements
required: false
entry_schema:
type: tosca.datatypes.nfv.LogicalNodeData
requested_additional_capabilities:
type: map
description: Describes additional capability for a particular OS container
required: false
entry_schema:
type: tosca.datatypes.nfv.RequestedAdditionalCapability
nfvi_constraints:
type: map
description: 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.
required: false
entry_schema:
type: string
# configurable_properties:
# type: tosca.datatypes.nfv.VnfcConfigurableProperties
# required: false
# derived types are expected to introduce
# configurable_properties with its type derived from
# tosca.datatypes.nfv.VnfcConfigurableProperties
vdu_profile:
type: tosca.datatypes.nfv.VduProfile
description: Defines additional instantiation data for the Vdu.OsContainerDeployableUnit node
required: true
mcio_constraint_params:
type: list
entry_schema:
type: string
constraints:
- valid_values:
- affinity_nfvi_pop
- affinity_zone
- affinity_zone_group
- affinity_nfvi_node
- affinity_cis_node
- anti_affinity_nfvi_pop
- anti_affinity_zone
- anti_affinity_zone_group
- anti_affinity_nfvi_node
- anti_affinity_cis_node
- local_affinity_nfvi_pop
- local_affinity_zone
- local_affinity_zoneGroup
- local_affinity_nfvi_node
- local_affinity_cis_node
- local_anti_affinity_nfvi_pop
- local_anti_affinity_zone
- local_anti_affinity_zone_group
- local_anti_affinity_nfvi_node
- local_anti_affinity_cis_node
- node_additional_capability_ssd
- node_additional_capability_dpdk
- node_additional_capability_sriov
- node_additional_capability_gpu
- node_additional_capability_fpga
- node_additional_capability_cpu_pin
- node_capability_logical_numa
- node_pool
description: Defines the parameter names for constraints expected to be assigned to MCIOs realizing this Vdu.OsContainerDeployableUnit. The value specifies the standardized semantical context of the MCIO constraints.
required: false
capabilities:
virtual_binding:
type: tosca.capabilities.nfv.VirtualBindable
occurrences: [ 0, UNBOUNDED ]
associable:
type: tosca.capabilities.nfv.AssociableVdu
occurrences: [ 1, 1 ]
requirements:
- virtual_storage:
capability: tosca.capabilities.nfv.VirtualStorage
relationship: tosca.relationships.nfv.AttachesTo
occurrences: [ 0, UNBOUNDED ]
- container:
capability: tosca.capabilities.nfv.ContainerDeployable
relationship: tosca.relationships.nfv.DeploysTo
occurrences: [ 1, UNBOUNDED ]
tosca.nodes.nfv.Mciop:
derived_from: tosca.nodes.Root
description: Representation of the object described by the mciop artifact, capable of being profiled by the properties of the MciopProfile information element defined in ETSI GS NFV-IFA 011 [1].