2 description: The TOSCA root Data Type all other TOSCA base Data Types derive from
5 derived_from: tosca.datatypes.Root
8 derived_from: tosca.datatypes.Root
11 derived_from: tosca.datatypes.Root
14 derived_from: tosca.datatypes.Root
17 derived_from: tosca.datatypes.Root
20 derived_from: tosca.datatypes.Root
23 derived_from: tosca.datatypes.Root
26 derived_from: tosca.datatypes.Root
29 derived_from: tosca.datatypes.Root
32 derived_from: tosca.datatypes.Root
35 derived_from: scalar-unit
38 derived_from: scalar-unit
40 scalar-unit.frequency:
41 derived_from: scalar-unit
44 derived_from: scalar-unit
46 tosca.datatypes.Credential:
47 derived_from: tosca.datatypes.Root
66 org.openecomp.datatypes.PortMirroringConnectionPointDescription:
67 derived_from: tosca.datatypes.Root
79 description: deprecated
82 description: deprecated
84 tosca.datatypes.TimeInterval:
85 derived_from: tosca.datatypes.Root
94 tosca.datatypes.network.NetworkInfo:
95 derived_from: tosca.datatypes.Root
106 tosca.datatypes.network.PortInfo:
107 derived_from: tosca.datatypes.Root
122 tosca.datatypes.network.PortDef:
123 derived_from: integer
125 - in_range: [ 1, 65535 ]
127 tosca.datatypes.network.PortSpec:
128 derived_from: tosca.datatypes.Root
135 - valid_values: [ udp, tcp, igmp ]
137 type: tosca.datatypes.network.PortDef
141 - in_range: [ 1, 65535 ]
143 type: tosca.datatypes.network.PortDef
147 - in_range: [ 1, 65535 ]
149 ###################new Data Types Onboarding Integration##########################
151 org.openecomp.datatypes.heat.network.AddressPair:
152 derived_from: tosca.datatypes.Root
153 description: MAC/IP address pairs
157 description: MAC address
162 description: IP address
166 org.openecomp.datatypes.heat.network.subnet.HostRoute:
167 derived_from: tosca.datatypes.Root
168 description: Host route info for the subnet
172 description: The destination for static route
177 description: The next hop for the destination
181 org.openecomp.datatypes.heat.network.AllocationPool:
182 derived_from: tosca.datatypes.Root
183 description: The start and end addresses for the allocation pool
187 description: Start address for the allocation pool
192 description: End address for the allocation pool
196 org.openecomp.datatypes.heat.network.neutron.Subnet:
197 derived_from: tosca.datatypes.Root
198 description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
202 description: The ID of the tenant who owns the network
207 description: Set to true if DHCP is enabled and false if DHCP is disabled
213 description: IPv6 address mode
223 description: IPv6 RA (Router Advertisement) mode
233 description: Extra parameters to include in the request
240 description: The start and end addresses for the allocation pools
244 type: org.openecomp.datatypes.heat.network.AllocationPool
247 description: The name or ID of the subnet pool
252 description: A specified set of DNS name servers to be used
259 description: The gateway IP address
263 type: org.openecomp.datatypes.heat.network.subnet.HostRoute
266 description: The gateway IP address
276 description: The name of the subnet
281 description: Prefix length for subnet allocation from subnet pool
285 - greater_or_equal: 0
288 description: The CIDR
293 description: The gateway IP address
297 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
298 derived_from: tosca.datatypes.Root
299 description: Nova server network expand properties for port
301 port_security_enabled:
303 description: Flag to enable/disable port security on the port
308 description: MAC address to give to this port
313 description: The administrative state of this port
319 description: The name or ID of QoS policy to attach to this port
322 allowed_address_pairs:
324 description: Additional MAC/IP address pairs allowed to pass through the port
328 type: org.openecomp.datatypes.heat.network.AddressPair
331 description: The vnic type to be bound on the neutron port
341 description: Extra parameters to include in the request
347 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
348 derived_from: tosca.datatypes.network.NetworkInfo
349 description: Network addresses with corresponding port id
357 org.openecomp.datatypes.heat.neutron.port.FixedIps:
358 derived_from: tosca.datatypes.Root
359 description: subnet/ip_address
363 description: Subnet in which to allocate the IP address for this port
368 description: IP address desired in the subnet for this port
373 description: Subnet in which to allocate the IP address for this port
377 org.openecomp.datatypes.heat.FileInfo:
378 derived_from: tosca.datatypes.Root
379 description: Heat File Info
383 description: The required URI string (relative or absolute) which can be used to locate the file
388 description: The type of the file
398 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
399 derived_from: tosca.datatypes.Root
400 description: source and destination port pairs
404 description: Start port
409 description: End port
413 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
414 derived_from: tosca.datatypes.Root
415 description: policy rule
419 description: Source ports
423 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
426 description: Protocol
431 description: Destination addresses
435 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
438 description: Service to apply
443 description: Destination ports
447 type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
450 description: Source addresses
454 type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
457 description: Direction
461 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
462 derived_from: tosca.datatypes.Root
463 description: list of policy rules
467 description: Contrail network rule
471 type: org.openecomp.datatypes.heat.contrail.network.rule.Rule
473 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
474 derived_from: tosca.datatypes.Root
475 description: source and destination addresses
479 description: Virtual network
483 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
484 derived_from: tosca.datatypes.Root
485 description: Rules Pairs
489 description: The remote group ID to be associated with this security group rule
494 description: The protocol that is matched by the security group rule
504 description: Ethertype of the traffic
514 description: 'The maximum port number in the range that is matched by the security group rule. '
523 description: The remote IP prefix (CIDR) to be associated with this security group rule
528 description: Whether to specify a remote group or a remote IP prefix
530 default: remote_ip_prefix
538 description: The direction in which the security group rule is applied
548 description: The minimum port number in the range that is matched by the security group rule.
556 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
557 derived_from: tosca.datatypes.Root
558 description: Substitution Filter
560 substitute_service_template:
562 description: Substitute Service Template
567 description: Index value of the substitution service template runtime instance
572 - greater_or_equal: 0
581 description: Indicates whether service scaling is enabled
587 description: Mandatory
592 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
593 derived_from: tosca.datatypes.Root
594 description: network policy refs data sequence
596 network_policy_refs_data_sequence_major:
598 description: Network Policy ref data sequence Major
601 network_policy_refs_data_sequence_minor:
603 description: Network Policy ref data sequence Minor
607 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
608 derived_from: tosca.datatypes.Root
609 description: network policy refs data
611 network_policy_refs_data_sequence:
612 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
613 description: Network Policy ref data sequence
617 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
618 derived_from: tosca.datatypes.Root
619 description: Network Ipam Ref Data Subnet
621 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
623 description: Network ipam refs data ipam subnets ip prefix len
626 network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
628 description: Network ipam refs data ipam subnets ip prefix
632 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
633 derived_from: tosca.datatypes.Root
634 description: Network Ipam Ref Data Subnet List
636 network_ipam_refs_data_ipam_subnets_subnet:
637 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
638 description: Network ipam refs data ipam subnets
641 network_ipam_refs_data_ipam_subnets_addr_from_start:
643 description: Network ipam refs data ipam subnets addr from start
647 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
648 derived_from: tosca.datatypes.Root
649 description: Network Ipam Ref Data
651 network_ipam_refs_data_ipam_subnets:
653 description: Network ipam refs data ipam subnets
657 type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
659 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
660 derived_from: tosca.datatypes.Root
661 description: source addresses
663 network_policy_entries_policy_rule_src_addresses_virtual_network:
665 description: Source addresses Virtual network
669 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
670 derived_from: tosca.datatypes.Root
671 description: destination addresses
673 network_policy_entries_policy_rule_dst_addresses_virtual_network:
675 description: Destination addresses Virtual network
679 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
680 derived_from: tosca.datatypes.Root
681 description: destination port pairs
683 network_policy_entries_policy_rule_dst_ports_start_port:
685 description: Start port
688 network_policy_entries_policy_rule_dst_ports_end_port:
690 description: End port
694 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
695 derived_from: tosca.datatypes.Root
696 description: source port pairs
698 network_policy_entries_policy_rule_src_ports_start_port:
700 description: Start port
703 network_policy_entries_policy_rule_src_ports_end_port:
705 description: End port
709 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
710 derived_from: tosca.datatypes.Root
711 description: Action List
713 network_policy_entries_policy_rule_action_list_simple_action:
715 description: Simple Action
718 network_policy_entries_policy_rule_action_list_apply_service:
720 description: Apply Service
726 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
727 derived_from: tosca.datatypes.Root
728 description: policy rule
730 network_policy_entries_policy_rule_dst_addresses:
732 description: Destination addresses
736 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
737 network_policy_entries_policy_rule_dst_ports:
739 description: Destination ports
743 type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
744 network_policy_entries_policy_rule_protocol:
746 description: Protocol
749 network_policy_entries_policy_rule_src_addresses:
751 description: Source addresses
755 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
756 network_policy_entries_policy_rule_direction:
758 description: Direction
761 network_policy_entries_policy_rule_src_ports:
763 description: Source ports
767 type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
768 network_policy_entries_policy_rule_action_list:
769 type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
770 description: Action list
774 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
775 derived_from: tosca.datatypes.Root
776 description: list of policy rules
778 network_policy_entries_policy_rule:
780 description: Contrail network rule
784 type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
786 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
787 derived_from: tosca.datatypes.Root
788 description: static route
792 description: Route prefix
797 description: Next hop
802 description: Next hop type
806 org.openecomp.datatypes.heat.network.contrail.AddressPair:
807 derived_from: tosca.datatypes.Root
808 description: Address Pair
812 description: Address mode active-active or active-standy
821 description: IP address prefix
826 description: Mac address
830 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
831 derived_from: tosca.datatypes.Root
832 description: Interface Data
836 description: An ordered list of static routes to be added to this interface
840 type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
843 description: Virtual Network for this interface
846 allowed_address_pairs:
848 description: List of allowed address pair for this interface
852 type: org.openecomp.datatypes.heat.network.contrail.AddressPair
855 description: IP for this interface
859 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
860 derived_from: tosca.datatypes.Root
861 description: Virtual Machine Interface Properties.
863 virtual_machine_interface_properties_service_interface_type:
865 description: Service Interface Type.
869 org.openecomp.datatypes.Root:
870 derived_from: tosca.datatypes.Root
872 The ECOMP root Data Type all other Data Types derive from
878 A placeholder for missing properties that would be included in future ecomp model versions.
882 org.openecomp.datatypes.AssignmentRequirements:
883 derived_from: org.openecomp.datatypes.Root
887 "true" indicates that assignment is required
892 description: number of assignments required
896 org.openecomp.datatypes.network.SubnetAssignments:
897 derived_from: org.openecomp.datatypes.Root
899 ip_network_address_plan:
902 description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
906 description: \"true\" indicates the network has 1 or more policies
910 - valid_values: [4,6]
912 description: The IP version of the subnet
916 description: The default subnet CIDR mask
921 description: Quantity of subnets that must be initially assigned
923 org.openecomp.datatypes.network.IPv4SubnetAssignments:
924 derived_from: org.openecomp.datatypes.network.SubnetAssignments
929 description: Indicates IPv4 subnet assignments
931 org.openecomp.datatypes.network.IPv6SubnetAssignments:
932 derived_from: org.openecomp.datatypes.network.SubnetAssignments
937 description: Indicates IPv6 subnet assignments
939 org.openecomp.datatypes.network.NetworkAssignments:
940 derived_from: org.openecomp.datatypes.Root
942 ecomp_generated_network_assignment:
947 \"true\" indicates that the network assignments will be auto-generated by ECOMP
948 \"false\" indicates operator-supplied Network assignments file upload is required (e.g. VID will present prompt to operator to upload operator-supplied Network assignments file).
952 description: \"true\" means this network is shared by multiple Openstack tenants
958 \"true\" means this Contrail external network
959 ipv4_subnet_default_assignment:
960 type: org.openecomp.datatypes.network.IPv4SubnetAssignments
962 description: IPv4 defualt subnet assignments
963 ipv6_subnet_default_assignment:
964 type: org.openecomp.datatypes.network.IPv6SubnetAssignments
966 description: IPv6 defualt subnet assignments
970 description: Related Networks List.
972 type: org.openecomp.datatypes.network.RelatedNetworksAssignments
976 description: \"true\" indicates that network is trunked
979 org.openecomp.datatypes.network.ProviderNetwork:
980 derived_from: org.openecomp.datatypes.Root
985 description: \"true\" indicates that this a Neutron provider type of network
986 physical_network_name:
990 - valid_values: ["Physnet41", "Physnet42", "Physnet43", "Physnet44", "Physnet21", "Physnet22", "sriovnet1", "sriovnet2", "oam"]
992 Identifies the NUMA processor cluster to which this physical network interface belongs.
993 NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
998 - valid_values: ["NUMA 0", "NUMA 1"]
1000 PNIC instance within the NUMA processor cluster
1001 PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
1005 description: PNIC instance within the NUMA processor cluster
1007 org.openecomp.datatypes.network.NetworkFlows:
1008 derived_from: org.openecomp.datatypes.Root
1014 description: \"true\" indicates the network has 1 or more policies
1018 description: "Identifies the specific Cloud network policy that must be applied to this network (source: from Policy Manager)."
1023 description: \"true\" indicates the network has 1 or more vpn bindings
1027 description: "Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source: A&AI)"
1029 org.openecomp.datatypes.network.VlanRequirements:
1030 derived_from: org.openecomp.datatypes.Root
1035 description: reference to a vlan range plan
1040 - valid_values: ["c-tag", "s-tag"]
1041 description: identifies the vlan type (e.g., c-tag)
1045 description: identifies the number of vlan tags to assign to the CP from the plan
1047 org.openecomp.datatypes.network.IpRequirements:
1048 derived_from: org.openecomp.datatypes.Root
1058 description: identifies the number of ip address to assign to the CP from the plan
1078 description: identifies the number of ip address to assign to the CP from the plan
1079 type: org.openecomp.datatypes.AssignmentRequirements
1081 floating_ip_count_required:
1082 type: org.openecomp.datatypes.AssignmentRequirements
1084 ip_address_plan_name:
1091 org.openecomp.datatypes.network.MacAssignments:
1092 derived_from: org.openecomp.datatypes.Root
1097 description: reference to a MAC address range plan
1101 description: identifies the number of MAC addresses to assign to the CP from the plan
1103 org.openecomp.datatypes.CSProperties:
1104 derived_from: org.openecomp.datatypes.Root
1114 description: maxNumberofUEs
1119 description: latency
1123 description: expDataRateDL
1127 description: expDataRateUL
1131 description: coverageAreaList
1135 - valid_values: ["stationary", "nomadic","restricted mobility","fully mobility"]
1137 description: uEMobilityLevel
1141 description: useInterval
1142 resourceSharingLevel:
1147 - valid_values: ["Shared", "Non-shared"]
1148 description: resourceSharingLevel
1150 org.openecomp.datatypes.NSCapabilities:
1151 derived_from: org.openecomp.datatypes.Root
1156 description: pLMNIdList
1161 description: maxNumberofUEs
1166 description: latency
1170 - valid_values: ["stationary", "nomadic","restricted mobility","fully mobility"]
1172 description: uEMobilityLevel
1173 resourceSharingLevel:
1178 - valid_values: ["Shared", "Non-shared"]
1179 description: resourceSharingLevel
1185 - valid_values: ["eMBB", "uRLLC", "mIot"]
1190 description: availability
1194 description: dLThptPerUE
1198 description: uLThptPerUE
1202 description: maxPktSize
1206 description: termDensity
1210 description: activityFactor
1218 description: survivalTime
1222 description: reliability
1226 description: dLThptPerSlice
1230 description: uLThptPerSlice
1234 description: maxNumberofConns
1236 org.openecomp.datatypes.NSSCapabilities:
1237 derived_from: org.openecomp.datatypes.Root
1242 description: pLMNIdList
1247 description: maxNumberofUEs
1252 description: latency
1256 - valid_values: ["stationary", "nomadic","restricted mobility","fully mobility"]
1258 description: uEMobilityLevel
1259 resourceSharingLevel:
1264 - valid_values: ["Shared", "Non-shared"]
1265 description: resourceSharingLevel
1271 - valid_values: ["eMBB", "uRLLC", "mIot"]
1276 description: expDataRateDL
1280 description: expDataRateUL
1284 description: areaTrafficCapDL
1288 description: areaTrafficCapUL
1292 description: overallUserDensity
1296 description: activityFactor
1297 cSAvailabilityTarget:
1300 description: cSAvailabilityTarget
1301 cSReliabilityMeanTime:
1304 description: cSReliabilityMeanTime
1308 description: expDataRate
1312 description: msgSizeByte
1313 transferIntervalTarget:
1316 description: transferIntervalTarget
1320 description: survivalTime
1321 maxNumberofPDUSession:
1324 description: maxNumberofPDUSession
1326 org.openecomp.datatypes.ServiceProfile:
1327 derived_from: org.openecomp.datatypes.Root
1336 description: pLMNIdList
1341 description: maxNumberofUEs
1346 description: latency
1353 description: activityFactor
1357 description: coverageAreaTAList
1361 - valid_values: ["stationary", "nomadic","restricted mobility","fully mobility"]
1363 description: uEMobilityLevel
1364 resourceSharingLevel:
1369 - valid_values: ["Shared", "Non-shared"]
1370 description: resourceSharingLevel
1376 - valid_values: ["eMBB", "uRLLC", "mIot"]
1381 description: availability
1385 description: reliability
1389 description: dLThptPerUE
1393 description: uLThptPerUE
1397 description: maxPktSize
1401 description: termDensity
1409 description: survivalTime
1413 description: dLThptPerSlice
1417 description: uLThptPerSlice
1421 description: maxNumberofConns
1423 org.openecomp.datatypes.SliceProfile:
1424 derived_from: org.openecomp.datatypes.Root
1433 description: pLMNIdList
1438 description: maxNumberofUEs
1443 description: latency
1447 description: expDataRateDL
1451 description: expDataRateUL
1455 description: areaTrafficCapDL
1459 description: areaTrafficCapUL
1463 description: overallUserDensity
1467 description: activityFactor
1471 description: coverageAreaTAList
1475 - valid_values: ["stationary", "nomadic","restricted mobility","fully mobility"]
1477 description: uEMobilityLevel
1478 resourceSharingLevel:
1483 - valid_values: ["Shared", "Non-shared"]
1484 description: resourceSharingLevel
1490 - valid_values: ["eMBB", "uRLLC", "mIot"]
1492 cSAvailabilityTarget:
1495 description: cSAvailabilityTarget
1496 cSReliabilityMeanTime:
1499 description: cSReliabilityMeanTime
1503 description: expDataRate
1507 description: msgSizeByte
1508 transferIntervalTarget:
1511 description: transferIntervalTarget
1515 description: survivalTime
1516 maxNumberofPDUSession:
1519 description: maxNumberofPDUSession
1521 org.openecomp.datatypes.EcompHoming:
1522 derived_from: org.openecomp.datatypes.Root
1524 ecomp_selected_instance_node_target:
1529 \"true\" indicates that the target deployment node for this instance will be auto-selected by ECOMP
1530 \"false\" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the
1531 operator-selected target node for the deployment of this Network instance).
1535 description: Referenc to a service level homing policy that ECOMP will use for instance deployment target node
1536 instance_node_target:
1539 description: Instance target deployment node
1541 org.openecomp.datatypes.EcompNaming:
1542 derived_from: org.openecomp.datatypes.Root
1544 ecomp_generated_naming:
1549 \"true\" indicates that the name for the instance will be auto-generated by ECOMP.
1550 \"false\" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1554 description: Referenc to naming policy that ECOMP will use when the name is auto-generated
1556 org.openecomp.datatypes.network.MacRequirements:
1557 derived_from: org.openecomp.datatypes.Root
1560 description: reference to a MAC address range plan
1564 description: identifies the number of MAC addresses to assign to the CP from the plan
1568 description: identifies the number of MAC addresses to assign to the CP from the plan
1569 type: org.openecomp.datatypes.AssignmentRequirements
1571 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp:
1572 derived_from: tosca.datatypes.Root
1573 description: Virtual Machine Sub Interface Address Pair IP.
1577 description: IP Prefix.
1582 description: IP Prefix Len.
1586 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.MacAddress:
1587 derived_from: tosca.datatypes.Root
1588 description: Virtual Machine Sub Interface Mac Address.
1592 description: Mac Addresses List.
1598 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.Properties:
1599 derived_from: tosca.datatypes.Root
1600 description: Virtual Machine Sub Interface VLAN Properties.
1602 sub_interface_vlan_tag:
1604 description: Sub Interface VLAN Tag.
1608 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair:
1609 derived_from: tosca.datatypes.Root
1610 description: Virtual Machine Sub Interface Address Pair.
1614 description: Address Mode.
1618 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairIp
1628 org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPairs:
1629 derived_from: tosca.datatypes.Root
1630 description: Virtual Machine Sub Interface Address Pairs.
1632 allowed_address_pair:
1634 description: Addresses pair List.
1638 type: org.openecomp.datatypes.heat.contrailV2.virtual.machine.subInterface.AddressPair
1640 org.openecomp.datatypes.Naming:
1641 derived_from: org.openecomp.datatypes.Root
1643 ecomp_generated_naming:
1645 "true" indicates that the name for the instance will be auto-generated by ECOMP. "false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1650 description: Reference to naming policy that ECOMP will use when the name is auto-generated
1654 description: indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
1659 org.openecomp.datatypes.flavors.ComputeFlavor:
1660 derived_from: tosca.datatypes.Root
1665 type: scalar-unit.size
1667 type: scalar-unit.size
1669 org.openecomp.datatypes.flavors.LicenseFlavor:
1670 derived_from: tosca.datatypes.Root
1675 org.openecomp.datatypes.flavors.VendorInfo:
1676 derived_from: tosca.datatypes.Root
1678 manufacturer_reference_number:
1683 org.openecomp.datatypes.flavors.DeploymentFlavor:
1684 derived_from: tosca.datatypes.Root
1689 type: org.openecomp.datatypes.flavors.VendorInfo
1691 type: org.openecomp.datatypes.flavors.ComputeFlavor
1693 type: org.openecomp.datatypes.flavors.LicenseFlavor
1696 org.openecomp.datatypes.ImageInfo:
1697 derived_from: tosca.datatypes.Root
1705 description: checksum/signature
1711 org.openecomp.datatypes.network.RelatedNetworksAssignments:
1712 derived_from: org.openecomp.datatypes.Root
1714 related_network_role:
1716 description: The network role of the related network, sharing provider network.
1720 tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties:
1721 derived_from: tosca.datatypes.Root
1722 description: VnfcAdditionalConfigurableProperties type is an empty base type for deriving data types for describing additional configurable properties for a given VNFC.
1723 # below description properties added as optional, since atleast one property required to define a dataType in SDC
1728 tosca.datatypes.nfv.VnfcConfigurableProperties:
1729 derived_from: tosca.datatypes.Root
1730 description: Defines the configurable properties of a VNFC
1732 additional_vnfc_configurable_properties:
1733 type: tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
1734 description: Describes additional configuration for VNFC that can be modified using the ModifyVnfInfo operation
1736 # derived types are expected to introduce
1737 # additional_vnfc_configurable_properties with its type derived from
1738 # tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
1739 tosca.datatypes.nfv.RequestedAdditionalCapability:
1740 derived_from: tosca.datatypes.Root
1741 description: describes requested additional capability for a particular VDU
1743 requested_additional_capability_name:
1745 description: Identifies a requested additional capability for the VDU.
1749 description: Indicates whether the requested additional capability is mandatory for successful operation.
1751 min_requested_additional_capability_version:
1753 description: Identifies the minimum version of the requested additional capability.
1755 preferred_requested_additional_capability_version:
1757 description: Identifies the preferred version of the requested additional capability.
1759 target_performance_parameters:
1761 description: Identifies specific attributes, dependent on the requested additional capability type.
1765 tosca.datatypes.nfv.VirtualMemory:
1766 derived_from: tosca.datatypes.Root
1767 description: supports the specification of requirements related to virtual memory of a virtual compute resource
1770 type: scalar-unit.size
1771 description: Amount of virtual memory.
1773 virtual_mem_oversubscription_policy:
1775 description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
1777 vdu_mem_requirements:
1779 description: The hardware platform specific VDU memory requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific VDU memory requirements.
1785 description: It specifies the memory allocation to be cognisant of the relevant process/core allocation.
1788 tosca.datatypes.nfv.VirtualCpuPinning:
1789 derived_from: tosca.datatypes.Root
1790 description: Supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource
1792 virtual_cpu_pinning_policy:
1794 description: 'Indicates the policy for CPU pinning. The policy can take values of "static" or "dynamic". In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). In case of "static" the allocation is requested to be according to the virtual_cpu_pinning_rule.'
1797 - valid_values: [ static, dynamic ]
1798 virtual_cpu_pinning_rule:
1800 description: Provides the list of rules for allocating virtual CPU cores to logical CPU cores/threads
1804 tosca.datatypes.nfv.VirtualCpu:
1805 derived_from: tosca.datatypes.Root
1806 description: Supports the specification of requirements related to virtual CPU(s) of a virtual compute resource
1810 description: CPU architecture type. Examples are x86, ARM
1814 description: Number of virtual CPUs
1819 type: scalar-unit.frequency
1820 description: Minimum virtual CPU clock rate
1822 virtual_cpu_oversubscription_policy:
1824 description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads.
1826 vdu_cpu_requirements:
1828 description: The hardware platform specific VDU CPU requirements. A map of strings that contains a set of key-value pairs describing VDU CPU specific hardware platform requirements.
1832 virtual_cpu_pinning:
1833 type: tosca.datatypes.nfv.VirtualCpuPinning
1834 description: The virtual CPU pinning configuration for the virtualised compute resource.
1836 tosca.datatypes.nfv.LogicalNodeData:
1837 derived_from: tosca.datatypes.Root
1838 description: Describes compute, memory and I/O requirements associated with a particular VDU.
1840 logical_node_requirements:
1842 description: The logical node-level compute, memory and I/O requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific deployment requirements, including the number of CPU cores on this logical node, a memory configuration specific to a logical node or a requirement related to the association of an I/O device with the logical node.
1846 tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
1847 derived_from: tosca.datatypes.Root
1848 description: Describes requirements on a virtual network interface
1852 description: Provides a human readable name for the requirement.
1856 description: Provides a human readable description of the requirement.
1860 description: Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
1862 network_interface_requirements:
1864 description: The network interface requirements. A map of strings that contain a set of key-value pairs that describes the hardware platform specific network interface deployment requirements.
1868 nic_io_requirements:
1869 type: tosca.datatypes.nfv.LogicalNodeData
1870 description: references (couples) the CP with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CP.
1873 tosca.datatypes.nfv.injectFile: #used for vCPE usecase
1874 derived_from: tosca.datatypes.Root
1882 tosca.datatypes.nfv.L2AddressData:
1883 derived_from: tosca.datatypes.Root
1884 description: Describes the information on the MAC addresses to be assigned to a connection point.
1886 mac_address_assignment:
1888 description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
1890 tosca.datatypes.nfv.L3AddressData:
1891 derived_from: tosca.datatypes.Root
1892 description: Provides information about Layer 3 level addressing scheme and parameters applicable to a CP
1894 ip_address_assignment:
1896 description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
1898 floating_ip_activated:
1900 description: Specifies if the floating IP scheme is activated on the Connection Point or not
1904 description: Defines address type. The address type should be aligned with the address type supported by the layer_protocols properties of the parent VnfExtCp
1907 - valid_values: [ ipv4, ipv6 ]
1908 number_of_ip_address:
1910 description: Minimum number of IP addresses to be assigned
1914 fixed_ip_address: #Introduced from Beijing release, only used for vCPE usecase
1919 tosca.datatypes.nfv.AddressData:
1920 derived_from: tosca.datatypes.Root
1921 description: Describes information about the addressing scheme and parameters applicable to a CP
1925 description: Describes the type of the address to be assigned to a connection point. The content type shall be aligned with the address type supported by the layerProtocol property of the connection point
1928 - valid_values: [ mac_address, ip_address ]
1930 type: tosca.datatypes.nfv.L2AddressData
1931 description: Provides the information on the MAC addresses to be assigned to a connection point.
1934 type: tosca.datatypes.nfv.L3AddressData
1935 description: Provides the information on the IP addresses to be assigned to a connection point
1937 tosca.datatypes.nfv.ConnectivityType:
1938 derived_from: tosca.datatypes.Root
1939 description: describes additional connectivity information of a virtualLink
1943 description: Identifies the protocol a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire).The top layer protocol of the virtualLink protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers.
1948 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
1951 description: Identifies the flow pattern of the connectivity
1954 - valid_values: [ line, tree, mesh ]
1955 tosca.datatypes.nfv.VlFlavour:
1956 derived_from: tosca.datatypes.Root
1960 tosca.datatypes.nfv.ext.AddressPairs:
1968 tosca.datatypes.nfv.ext.FloatingIP:
1976 tosca.datatypes.nfv.ext.LocationInfo:
1987 tosca.datatypes.nfv.ext.HostRouteInfo:
1995 tosca.datatypes.nfv.ext.InjectData:
2003 tosca.datatypes.nfv.ext.zte.WatchDog:
2011 tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
2016 affinity_antiaffinity:
2019 tosca.datatypes.nfv.VduProfile:
2020 derived_from: tosca.datatypes.Root
2021 description: describes additional instantiation data for a given Vdu.Compute used in a specific deployment flavour.
2023 min_number_of_instances:
2025 description: Minimum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
2028 - greater_or_equal: 0
2029 max_number_of_instances:
2031 description: Maximum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
2034 - greater_or_equal: 0
2035 watchdog: #Introduced from Beijing release, only used for vCPE usecase, outside the scope of SOL001 v2.5.1
2038 vmBootUpTimeOut: #Introduced from Beijing release, only used for vCPE usecase, outside the scope of SOL001 v2.5.1
2041 tosca.datatypes.nfv.LinkBitrateRequirements:
2042 derived_from: tosca.datatypes.Root
2043 description: describes the requirements in terms of bitrate for a virtual link
2046 type: integer # in bits per second
2047 description: Specifies the throughput requirement in bits per second of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN).
2050 - greater_or_equal: 0
2052 type: integer # in bits per second
2053 description: Specifies the throughput requirement in bits per second of leaf connections to the link when applicable to the connectivity type (e.g. for E-Tree and E LAN branches).
2056 - greater_or_equal: 0
2057 tosca.datatypes.nfv.Qos:
2058 derived_from: tosca.datatypes.Root
2059 description: describes QoS data for a given VL used in a VNF deployment flavour
2062 type: scalar-unit.time #Number [ms]
2063 description: Specifies the maximum latency
2067 packet_delay_variation:
2068 type: scalar-unit.time #Number [ms]
2069 description: Specifies the maximum jitter
2072 - greater_or_equal: 0 s
2074 type: float #Number [0 ..1]
2075 description: Specifies the maximum packet loss ratio
2078 - in_range: [ 0.0, 1.0 ]
2080 tosca.datatypes.nfv.IpAllocationPool:
2081 derived_from: tosca.datatypes.Root
2082 description: Specifies a range of IP addresses
2086 description: The IP address to be used as the first one in a pool of addresses derived from the cidr block full IP range
2090 description: The IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range
2092 tosca.datatypes.nfv.L2ProtocolData:
2093 derived_from: tosca.datatypes.Root
2094 description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour.
2098 description: Identifies the network name associated with this L2 protocol.
2102 description: Specifies the network type for this L2 protocol.The value may be overridden at run-time.
2105 - valid_values: [ flat, vlan, vxlan, gre ]
2108 description: Specifies whether to support VLAN transparency for this L2 protocol or not.
2113 description: Specifies the maximum transmission unit (MTU) value for this L2 protocol.
2117 segmentation_id: #Introduced from Beijing release, only used for vCPE usecase, outside the scope of SOL001 v2.5.1
2120 physical_network: #Introduced from Beijing release, only used for vCPE usecase, outside the scope of SOL001 v2.5.1
2123 tosca.datatypes.nfv.L3ProtocolData:
2124 derived_from: tosca.datatypes.Root
2125 description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour.
2129 description: Identifies the network name associated with this L3 protocol.
2133 description: Specifies IP version of this L3 protocol.The value of the ip_version property shall be consistent with the value of the layer_protocol in the connectivity_type property of the virtual link node.
2136 - valid_values: [ ipv4, ipv6 ]
2139 description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time.
2141 ip_allocation_pools:
2143 description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time.
2146 type: tosca.datatypes.nfv.IpAllocationPool
2149 description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time.
2153 description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time.
2157 description: Specifies IPv6 address mode. May be present when the value of the ipVersion attribute is "ipv6" and shall be absent otherwise. The value may be overridden at run-time.
2160 - valid_values: [ slaac, dhcpv6-stateful, dhcpv6-stateless ]
2161 tosca.datatypes.nfv.VirtualLinkProtocolData:
2162 derived_from: tosca.datatypes.Root
2163 description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour
2165 associated_layer_protocol:
2167 description: Identifies one of the protocols a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire) as specified by the connectivity_type property.
2170 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
2172 type: tosca.datatypes.nfv.L2ProtocolData
2173 description: Specifies the L2 protocol data for a virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise.
2176 type: tosca.datatypes.nfv.L3ProtocolData
2177 description: Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise.
2180 tosca.datatypes.nfv.VlProfile:
2181 derived_from: tosca.datatypes.Root
2182 description: Describes additional instantiation data for a given VL used in a specific VNF deployment flavour.
2184 max_bitrate_requirements:
2185 type: tosca.datatypes.nfv.LinkBitrateRequirements
2186 description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile.
2188 min_bitrate_requirements:
2189 type: tosca.datatypes.nfv.LinkBitrateRequirements
2190 description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
2193 type: tosca.datatypes.nfv.Qos
2194 description: Specifies the QoS requirements of a VL instantiated according to this profile.
2196 virtual_link_protocol_data:
2198 description: Specifies the protocol data for a virtual link.
2201 type: tosca.datatypes.nfv.VirtualLinkProtocolData
2202 tosca.datatypes.nfv.VduLevel:
2203 derived_from: tosca.datatypes.Root
2204 description: Indicates for a given Vdu.Compute in a given level the number of instances to deploy
2206 number_of_instances:
2208 description: Number of instances of VNFC based on this VDU to deploy for this level.
2211 - greater_or_equal: 0
2212 tosca.datatypes.nfv.ScaleInfo:
2213 derived_from: tosca.datatypes.Root
2214 description: Indicates for a given scaleAspect the corresponding scaleLevel
2218 description: The scale level for a particular aspect
2221 - greater_or_equal: 0
2222 tosca.datatypes.nfv.ScalingAspect:
2223 derived_from: tosca.datatypes.Root
2232 type: integer # positiveInteger
2235 - greater_or_equal: 0
2240 type: string # Identifier
2241 tosca.datatypes.nfv.InstantiationLevel:
2242 derived_from: tosca.datatypes.Root
2243 description: Describes the scale level for each aspect that corresponds to a given level of resources to be instantiated within a deployment flavour in term of the number VNFC instances
2247 description: Human readable description of the level
2250 type: map # key: aspectId
2251 description: Represents for each aspect the scale level that corresponds to this instantiation level. scale_info shall be present if the VNF supports scaling.
2254 type: tosca.datatypes.nfv.ScaleInfo
2256 tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
2257 derived_from: tosca.datatypes.Root
2258 description: represents information that affect the invocation of the InstantiateVnf operation.
2263 tosca.datatypes.nfv.VnfScaleOperationConfiguration:
2264 derived_from: tosca.datatypes.Root
2265 description: Represents information that affect the invocation of the ScaleVnf operation
2267 scaling_by_more_than_one_step_supported:
2269 description: Signals whether passing a value larger than one in the numScalingSteps parameter of the ScaleVnf operation is supported by this VNF.
2272 tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
2273 derived_from: tosca.datatypes.Root
2274 description: represents information that affect the invocation of the ScaleVnfToLevel operation
2276 arbitrary_target_levels_supported:
2278 description: Signals whether scaling according to the parameter "scaleInfo" is supported by this VNF
2280 tosca.datatypes.nfv.VnfHealOperationConfiguration:
2281 derived_from: tosca.datatypes.Root
2282 description: represents information that affect the invocation of the HealVnf operation
2286 description: Supported "cause" parameter values
2290 tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
2291 derived_from: tosca.datatypes.Root
2292 description: represents information that affect the invocation of the TerminateVnf
2294 min_graceful_termination_timeout:
2295 type: scalar-unit.time # For TOSCA V1.2 use type as scalar-unit.time instead of integer
2296 description: Minimum timeout value for graceful termination of a VNF instance
2298 max_recommended_graceful_termination_timeout:
2299 type: scalar-unit.time # For TOSCA V1.2 use type as scalar-unit.time instead of integer
2300 description: Maximum recommended timeout value that can be needed to gracefully terminate a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
2302 tosca.datatypes.nfv.VnfOperateOperationConfiguration:
2303 derived_from: tosca.datatypes.Root
2304 description: represents information that affect the invocation of the OperateVnf operation
2306 min_graceful_stop_timeout:
2307 type: scalar-unit.time
2308 description: Minimum timeout value for graceful stop of a VNF instance
2310 max_recommended_graceful_stop_timeout:
2311 type: scalar-unit.time
2312 description: Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
2314 tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration:
2315 derived_from: tosca.datatypes.Root
2316 description: represents information that affect the invocation of the ChangeVnfFlavour operation
2321 tosca.datatypes.nfv.VnfProfile:
2322 derived_from: tosca.datatypes.Root
2323 description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF.
2325 instantiation_level:
2327 description: 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.
2329 min_number_of_instances:
2331 description: Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
2334 - greater_or_equal: 0
2335 max_number_of_instances:
2337 description: Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
2340 - greater_or_equal: 0
2341 service_availability_level:
2343 description: If present, specifies the service availability level for the VNF instance created from this profile.
2346 - greater_or_equal: 1
2347 tosca.datatypes.nfv.UriAuthority:
2348 derived_from: tosca.datatypes.Root
2349 description: information that corresponds to the authority component of a URI as specified in IETF RFC 3986 [8]
2352 type: string # shall comply with IETF RFC 3986
2353 description: user_info field of the authority component of a URI
2356 type: string # shall comply with IETF RFC 3986
2357 description: host field of the authority component of a URI
2360 type: string # shall comply with IETF RFC 3986
2361 description: port field of the authority component of a URI
2363 tosca.datatypes.nfv.UriComponents:
2364 derived_from: tosca.datatypes.Root
2365 description: information used to build a URI that complies with IETF RFC 3986 [8].
2368 type: string # shall comply with IETF RFC3986
2369 description: scheme component of a URI.
2372 type: tosca.datatypes.nfv.UriAuthority
2373 description: Authority component of a URI
2376 type: string # shall comply with IETF RFC 3986
2377 description: path component of a URI.
2380 type: string # shall comply with IETF RFC 3986
2381 description: query component of a URI.
2384 type: string # shall comply with IETF RFC 3986
2385 description: fragment component of a URI.
2387 tosca.datatypes.nfv.InterfaceDetails:
2388 derived_from: tosca.datatypes.Root
2389 description: information used to access an interface exposed by a VNF
2392 type: tosca.datatypes.nfv.UriComponents
2393 description: Provides components to build a Uniform Ressource Identifier (URI) where to access the interface end point.
2395 interface_specific_data:
2397 description: Provides additional details that are specific to the type of interface considered.
2401 tosca.datatypes.nfv.VirtualLinkMonitoringParameter:
2402 derived_from: tosca.datatypes.Root
2403 description: Represents information on virtualised resource related performance metrics applicable to the VNF.
2407 description: Human readable name of the monitoring parameter
2411 description: Identifies a performance metric derived from those defined in ETSI GS NFV-IFA 027.The packetOutgoingVirtualLink and packetIncomingVirtualLink metrics shall be obtained by aggregation the PacketOutgoing and PacketIncoming measurements defined in clause 7.1 of GS NFV-IFA 027 of all virtual link ports attached to the virtual link to which the metrics apply.
2414 - valid_values: [ packet_outgoing_virtual_link, packet_incoming_virtual_link, byte_incoming, byte_outgoing, packet_incoming, packet_outgoing ]
2416 type: scalar-unit.time
2417 description: Describes the recommended periodicity at which to collect the performance information.
2421 tosca.datatypes.nfv.VnfcMonitoringParameter:
2422 derived_from: tosca.datatypes.Root
2423 description: Represents information on virtualised resource related performance metrics applicable to the VNF.
2427 description: Human readable name of the monitoring parameter
2431 description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
2434 - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_int_cp, byte_outgoing_vnf_int_cp, packet_incoming_vnf_int_cp, packet_outgoing_vnf_int_cp, 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 ]
2436 type: scalar-unit.time
2437 description: Describes the recommended periodicity at which to collect the performance information.
2441 tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
2442 derived_from: tosca.datatypes.Root
2443 description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation
2448 tosca.datatypes.nfv.VnfMonitoringParameter:
2449 derived_from: tosca.datatypes.Root
2450 description: Represents information on virtualised resource related performance metrics applicable to the VNF.
2454 description: Human readable name of the monitoring parameter
2458 description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
2461 - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, 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 ]
2463 type: scalar-unit.time
2464 description: Describes the recommended periodicity at which to collect the performance information.
2468 tosca.datatypes.nfv.VnfChangeCurrentPackageOperationConfiguration:
2469 derived_from: tosca.datatypes.Root
2470 description: represents information that affect the invocation of the change current VNF Package operation.
2471 # This data type definition is reserved for future use in the present document.
2473 tosca.datatypes.nfv.VnfCreateSnapshotOperationConfiguration:
2474 derived_from: tosca.datatypes.Root
2475 description: represents information that affect the invocation of the CreateVnfSnapshot operation
2476 # This data type definition is reserved for future use in the present document.
2478 tosca.datatypes.nfv.VnfRevertToSnapshotOperationConfiguration:
2479 derived_from: tosca.datatypes.Root
2480 description: represents information that affect the invocation of the RevertToVnfSnapshot operation
2481 # This data type definition is reserved for future use in the present document.
2483 tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
2484 derived_from: tosca.datatypes.Root
2485 description: Represents information to configure lifecycle management operations
2488 type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
2489 description: Configuration parameters for the InstantiateVnf operation
2492 type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
2493 description: Configuration parameters for the ScaleVnf operation
2496 type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
2497 description: Configuration parameters for the ScaleVnfToLevel operation
2500 type: tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration
2501 description: Configuration parameters for the changeVnfFlavourOpConfig operation
2504 type: tosca.datatypes.nfv.VnfHealOperationConfiguration
2505 description: Configuration parameters for the HealVnf operation
2508 type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
2509 description: Configuration parameters for the TerminateVnf operation
2512 type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
2513 description: Configuration parameters for the OperateVnf operation
2515 change_ext_connectivity:
2516 type: tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration
2517 description: Configuration parameters for the changeExtVnfConnectivityOpConfig operation
2519 change_current_package:
2520 type: tosca.datatypes.nfv.VnfChangeCurrentPackageOperationConfiguration
2521 description: Configuration parameters for the ChangeCurrentVnfPackage operation
2524 type: tosca.datatypes.nfv.VnfCreateSnapshotOperationConfiguration
2525 description: Configuration parameters for the CreateVnfSnapshot operation
2528 type: tosca.datatypes.nfv.VnfRevertToSnapshotOperationConfiguration
2529 description: Configuration parameters for the RevertToVnfSnapshot operation
2531 tosca.datatypes.nfv.CpProtocolData:
2532 derived_from: tosca.datatypes.Root
2533 description: Describes and associates the protocol layer that a CP uses together with other protocol and connection point information
2535 associated_layer_protocol:
2538 description: One of the values of the property layer_protocols of the CP
2540 - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
2543 description: Provides information on the addresses to be assigned to the CP
2545 type: tosca.datatypes.nfv.AddressData
2547 tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
2548 derived_from: tosca.datatypes.Root
2549 description: is an empty base type for deriving data types for describing additional configurable properties for a given VNF
2550 # below description properties added as optional, since atleast one property required to define a dataType in SDC
2554 is_writable_anytime:
2556 description: It specifies whether these additional configurable properties are writeable (TRUE) at anytime (i.e. prior to / at instantiation time as well as after instantiation).or (FALSE) only prior to / at instantiation time. If this property is not present, the additional configurable properties are writable anytime
2558 tosca.datatypes.nfv.VnfmInterfaceInfo:
2559 derived_from: tosca.datatypes.Root
2560 description: describes information enabling the VNF instance to access the NFV-MANO interfaces produced by the VNFM
2564 description: Identifies an interface produced by the VNFM.
2567 - valid_values: [ vnf_lcm, vnf_pm, vnf_fm ]
2569 type: tosca.datatypes.nfv.InterfaceDetails
2570 description: Provide additional data to access the interface endpoint
2574 description: Provides credential enabling access to the interface
2578 tosca.datatypes.nfv.OauthServerInfo:
2579 derived_from: tosca.datatypes.Root
2580 description: information to enable discovery of the authorization server
2582 #This data type definition is reserved for future use in the present document
2583 tosca.datatypes.nfv.VnfConfigurableProperties:
2584 derived_from: tosca.datatypes.Root
2585 description: indicates configuration properties for a given VNF (e.g. related to auto scaling and auto healing).
2587 is_autoscale_enabled:
2589 description: It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. If the properties is not present for configuring, then VNF property is not supported
2591 is_autoheal_enabled:
2593 description: It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. If the properties is not present for configuring, then VNF property is not supported
2595 vnfm_interface_info:
2596 type: tosca.datatypes.nfv.VnfmInterfaceInfo
2597 description: Contains information enabling access to the NFV-MANO interfaces produced by the VNFM (e.g. URIs and credentials). If the property is not present, then configuring this VNF property is not supported.
2599 vnfm_oauth_server_info:
2600 type: tosca.datatypes.nfv.OauthServerInfo
2601 description: Contains information to enable discovery of the authorization server protecting access to VNFM interfaces. If the property is not present, then configuring this VNF property is not supported.
2603 vnf_oauth_server_info:
2604 type: tosca.datatypes.nfv.OauthServerInfo
2605 description: Contains information to enable discovery of the authorization server to validate the access tokens provided by the VNFM when the VNFM accesses the VNF interfaces, if that functionality (token introspection) is supported by the authorization server. If the property is not present, then configuring this VNF property is not supported.
2607 additional_configurable_properties:
2608 description: It provides VNF specific configurable properties that can be modified using the ModifyVnfInfo operation
2610 type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
2611 # derived types are expected to introduce
2612 # additional_configurable_properties with its type derived from
2613 # tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
2614 tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
2615 derived_from: tosca.datatypes.Root
2616 description: is an empty base type for deriving data types for describing VNF-specific extension
2617 # below description properties added as optional, since atleast one property required to define a dataType in SDC
2622 tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
2623 derived_from: tosca.datatypes.Root
2624 description: is an empty base type for deriving data types for describing VNF-specific metadata
2629 tosca.datatypes.nfv.VnfInfoModifiableAttributes:
2630 derived_from: tosca.datatypes.Root
2631 description: Describes VNF-specific extension and metadata for a given VNF
2634 type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
2635 description: \"Extension\" properties of VnfInfo that are writeable
2637 # derived types are expected to introduce
2638 # extensions with its type derived from
2639 # tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
2641 type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
2642 description: \"Metadata\" properties of VnfInfo that are writeable
2644 # derived types are expected to introduce
2645 # metadata with its type derived from
2646 # tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
2648 tosca.datatypes.nfv.VirtualLinkBitrateLevel:
2649 derived_from: tosca.datatypes.Root
2650 description: Describes bitrate requirements applicable to the virtual link instantiated from a particicular VnfVirtualLink
2655 bitrate_requirements:
2656 type: tosca.datatypes.nfv.LinkBitrateRequirements
2657 description: Virtual link bitrate requirements for an instantiation level or bitrate delta for a scaling step
2660 tosca.datatypes.nfv.VnfOperationAdditionalParameters:
2661 derived_from: tosca.datatypes.Root
2662 description: Is an empty base type for deriving data type for describing VNF-specific parameters to be passed when invoking lifecycle management operations
2663 # below description properties added as optional, since atleast one property required to define a dataType in SDC
2668 tosca.datatypes.nfv.VirtualFileStorageData:
2669 derived_from: tosca.datatypes.Root
2670 description: VirtualFileStorageData describes file storage requirements associated with compute resources in a particular VDU
2673 type: scalar-unit.size
2674 description: Size of virtualized storage resource
2676 file_system_protocol:
2678 description: The shared file system protocol (e.g. NFS, CIFS)
2680 tosca.datatypes.nfv.VirtualObjectStorageData:
2681 derived_from: tosca.datatypes.Root
2682 description: VirtualObjectStorageData describes object storage requirements associated with compute resources in a particular VDU
2684 max_size_of_storage:
2685 type: scalar-unit.size
2686 description: Maximum size of virtualized storage resource
2688 tosca.datatypes.nfv.VirtualBlockStorageData:
2689 derived_from: tosca.datatypes.Root
2690 description: VirtualBlockStorageData describes block storage requirements associated with compute resources in a particular VDU, either as a local disk or as virtual attached storage
2693 type: scalar-unit.size
2694 description: Size of virtualised storage resource
2696 vdu_storage_requirements:
2698 description: The hardware platform specific storage requirements. A map of strings that contains a set of key-value pairs that represents the hardware platform specific storage deployment requirements.
2704 description: Indicates if the storage support RDMA
2707 tosca.datatypes.nfv.ChecksumData:
2708 derived_from: tosca.datatypes.Root
2709 description: Describes information about the result of performing a checksum operation over some arbitrary data
2713 description: Describes the algorithm used to obtain the checksum value
2716 - valid_values: [sha-224, sha-256, sha-384, sha-512 ]
2719 description: Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers
2722 tosca.datatypes.nfv.SwImageData:
2723 derived_from: tosca.datatypes.Root
2724 description: describes information related to a software image artifact
2725 properties: # in SOL001 v0.8.0: "properties or metadata:"
2728 description: Name of this software image
2732 description: Version of this software image
2736 description: Provider of this software image
2740 description: Checksum of the software image file
2744 description: The container format describes the container file format in which software image is provided
2747 - valid_values: [ aki, ami, ari, bare, docker, ova, ovf ]
2750 description: The disk format of a software image is the format of the underlying disk image
2753 - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ]
2755 type: scalar-unit.size # Number
2756 description: The minimal disk size requirement for this software image
2759 type: scalar-unit.size # Number
2760 description: The minimal RAM requirement for this software image
2763 type: scalar-unit.size # Number
2764 description: The size of this software image
2768 description: Identifies the operating system used in the software image
2770 supported_virtualisation_environments:
2772 description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image
2776 tosca.datatypes.nfv.NsVirtualLinkQos:
2777 derived_from: tosca.datatypes.nfv.Qos
2778 description: describes QoS data for a given VL used in a VNF deployment flavour
2783 - greater_or_equal: 0
2784 description: Specifies the priority level in case of congestion on the underlying physical links
2786 tosca.datatypes.nfv.ServiceAvailability:
2787 derived_from: tosca.datatypes.Root
2788 description: service availability
2792 description: service availability levels
2795 - valid_values: [ level1, level2, level3 ]
2796 tosca.datatypes.nfv.NsVlProfile:
2797 derived_from: tosca.datatypes.Root
2798 description: Describes additional instantiation data for a given NsVirtualLink used in a specific NS deployment flavour.
2800 max_bitrate_requirements:
2801 type: tosca.datatypes.nfv.LinkBitrateRequirements
2802 description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile.
2804 min_bitrate_requirements:
2805 type: tosca.datatypes.nfv.LinkBitrateRequirements
2806 description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
2809 type: tosca.datatypes.nfv.NsVirtualLinkQos
2810 description: Specifies the QoS requirements of a VL instantiated according to this profile.
2812 service_availability:
2813 type: tosca.datatypes.nfv.ServiceAvailability
2814 description: Network service virtual link service availability levels, as described in ETSI GS NFV-REL 001
2816 service_availability_level:
2818 description: Specifies the service availability level for the VL instance created from this profile
2821 - greater_or_equal: 1
2823 tosca.datatypes.nfv.NsProfile:
2824 derived_from: tosca.datatypes.Root
2825 description: describes a profile for instantiating NSs of a particular NS DF according to a specific NSD and NS DF.
2827 ns_instantiation_level:
2829 description: Identifier of the instantiation level of the NS DF to be used for instantiation. If not present, the default instantiation level as declared in the NSD shall be used.
2831 min_number_of_instances:
2833 description: Minimum number of instances of the NS based on this NSD that is permitted to exist for this NsProfile.
2836 - greater_or_equal: 0
2837 max_number_of_instances:
2839 description: Maximum number of instances of the NS based on this NSD that is permitted to exist for this NsProfile.
2842 - greater_or_equal: 0
2845 description: Identifies the applicable network service DF within the scope of the NSD.
2848 tosca.datatypes.nfv.MciopProfile:
2849 derived_from: tosca.datatypes.Root
2850 description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF.
2854 description: dentifies the MCIOP in the VNF package.
2858 description: Indicates the order in which this MCIOP shall be deployed in relation to other MCIOPs. A lower value specifies an earlier deployment.
2861 - greater_or_equal: 0
2862 affinityOrAntiAffinityGroupId:
2864 description: List of VDUs which are associated to this MCIOP and which are deployed using this MCIOP
2870 description: List of VDUs which are associated to this MCIOP and which are deployed using this MCIOP
2874 tosca.datatypes.nfv.BootDataVimSpecificProperties:
2875 derived_from: tosca.datatypes.Root
2876 description: describes the VIM specific information used for selecting VIM specific capabilities when setting the boot data.
2880 description: Discriminator for the different types of the VIM information.
2884 description: Properties used for selecting VIM specific capabilities when setting the boot data
2888 tosca.datatypes.nfv.KvpData:
2889 derived_from: tosca.datatypes.Root
2890 description: describes a set of key-value pairs information used to customize a virtualised compute resource at boot time by using only key-value pairs data.
2894 description: A map of strings that contains a set of key-value pairs that describes the information for configuring the virtualised compute resource.
2898 tosca.datatypes.nfv.ContentOrFileData:
2899 derived_from: tosca.datatypes.Root
2900 description: describes a string content or a file information used to customize a virtualised compute resource at boot time by using string content or file.
2904 description: 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..
2910 description: The string information used to customize a virtualised compute resource at boot time.
2914 description: The URL to a file contained in the VNF package used to customize a virtualised compute resource. The content shall comply with IETF RFC 3986 [8].
2918 description: The URL address when inject a file into the virtualised compute resource. The content shall comply with IETF RFC 3986 [8].
2920 tosca.datatypes.nfv.BootData:
2921 derived_from: tosca.datatypes.Root
2922 description: describes the information used to customize a virtualised compute resource at boot time.
2924 vim_specific_properties:
2925 type: tosca.datatypes.nfv.BootDataVimSpecificProperties
2926 description: Properties used for selecting VIM specific capabilities when setting the boot data.
2929 type: tosca.datatypes.nfv.KvpData
2930 description: A set of key-value pairs for configuring a virtual compute resource.
2932 content_or_file_data:
2933 type: tosca.datatypes.nfv.ContentOrFileData
2934 description: A string content or a file for configuring a virtual compute resource.
2936 tosca.datatypes.nfv.ServicePortData:
2937 derived_from: tosca.datatypes.Root
2938 description: describes the service identifying port properties exposed by the VirtualCp
2942 description: The name of the port exposed by the VirtualCp.
2946 description: The L4 protocol for this port exposed by the VirtualCp.
2954 description: The L4 port number exposed by the VirtualCp.
2958 description: Specifies whether the port attribute value is allowed to be configurable.
2960 tosca.datatypes.nfv.AdditionalServiceData:
2961 derived_from: tosca.datatypes.Root
2962 description: describes the additional service data of the VirtualCp used to expose properties of the VirtualCp to NFV-MANO.
2966 description: Service port numbers exposed by the VirtualCp.
2969 type: tosca.datatypes.nfv.ServicePortData
2972 description: Service matching information exposed by the VirtualCp.
2974 tosca.datatypes.nfv.NsOperationAdditionalParameters:
2975 derived_from: tosca.datatypes.Root
2976 description: Is an empty base type for deriving data types for describing NS-specific additional parameters to be passed when invoking NS lifecycle management operations
2978 tosca.datatypes.nfv.Mask:
2979 derived_from: tosca.datatypes.Root
2982 description: Indicates the offset between the last bit of the source mac address and the first bit of the sequence of bits to be matched.
2986 description: Indicates the number of bits to be matched.
2990 description: Provide the sequence of bit values to be matched.
2993 tosca.datatypes.nfv.NsMonitoringParameter:
2994 derived_from: tosca.datatypes.Root
2995 description: Represents information on virtualised resource related performance metrics applicable to the NS.
2999 description: Human readable name of the monitoring parameter
3003 description: Identifies a performance metric to be monitored, according to ETSI GS NFV-IFA 027.
3006 - valid_values: [byte_incoming_sap, byte_outgoing_sap, packet_incoming_sap, packet_outgoing_sap, byte_incoming, byte_outgoing, packet_incoming, packet_outgoing ]
3008 type: scalar-unit.time
3009 description: Describes the periodicity at which to collect the performance information.
3015 ##### Partner service domain datatypes ######
3017 onap.datatypes.partner.access_details:
3018 derived_from: tosca.datatypes.Root
3022 description: id of the site
3024 dsl_stability_profile:
3026 description: profile of stability
3033 partner_priorty_assist:
3035 description: assistance flag
3040 description: backup requirement flag
3045 description: applicable to FTTN service
3048 service_restoration_sla:
3050 description: This is the service restoration SLA from an partner perspective.
3058 onap.datatypes.partner.bandwidth:
3059 derived_from: tosca.datatypes.Root
3063 description: type of bandwidth
3072 description: down speed
3093 description: up speed
3114 description: unit of speed
3122 description: 16 digit id
3125 onap.datatypes.partner.service_details:
3126 derived_from: tosca.datatypes.Root
3129 type: onap.datatypes.partner.bandwidth
3130 description: bandwidth details for access
3142 type: onap.datatypes.partner.access_details
3145 onap.datatypes.partner.sppartner_details:
3146 derived_from: tosca.datatypes.Root
3150 description: Partner URL to access and provision the service
3154 description: UUID of the service definition defined in the partner catalog
3158 description: Authentication details to access the Service URL
3162 description: Authentication details to access the Service URL
3165 onap.datatypes.ToscaConceptIdentifier:
3166 derived_from: tosca.datatypes.Root
3175 tosca.datatypes.asd.networkInterfaceRequirements:
3176 derived_from: tosca.datatypes.Root
3178 description: "Describes the datatype for network interface requirements"
3182 Information about whether the CP instantiated from this Cp is
3183 in Trunk mode (802.1Q or other). When operating in "trunk mode",
3184 the Cp is capable of carrying traffic for several VLANs.
3185 Absence of this property implies that trunkMode is not configured
3186 for the Cp i.e. It is equivalent to boolean value "false".
3192 Identifies whether application expects IP address assignment to be
3193 managed by the cluster infrastructure (CNI IPAM plugin), or
3194 configured by orchestrator via for example helm input parameter,
3195 or if IP assignment is handled by the application itself.
3199 - valid_values: ["infraProvided", "orchestrated", "userManaged"]
3200 default: "infraProvided"
3203 Indicates what type of network interface the application expects.
3204 Kernel based virtual netdev based on CNIs such as ovs | bridge |
3205 macvlan | ipvlan, or PCIe dev directly visible in application
3206 namespace with kernel or userspace driver or bonded with the Bond
3207 CNI, or userspace-CNI based network interface
3208 (requires DPDK-OVS/VPP vSwitch).
3212 - valid_values: ["kernel.netdev", "direct.userdriver", "direct.kerneldriver", "direct.bond", "userspace"]
3213 default: "kernel.netdev"
3216 This attribute describes verified realization options for the
3217 network interface in question. Currently listed options
3218 (virtio and memif) are applicable for the interfaceType “userspace”.
3224 - valid_values: ["virtio", "memif"]
3225 interface_redundancy:
3227 Identifies switch-plane redundancy method the application uses,
3228 and that node infrastructure is required to comply with.
3229 "infraProvided", “left” and “right”: The container sees a
3230 single vNIC that a) the infrastructure bonds over both switchplanes
3231 or b) that is connected to the network via only left or
3232 right the switchplane.
3233 The other cases are for a mated pair of vnics connecting to
3234 same network, but where one vNIC connects
3235 via left switch plane and the other via right switch plane,
3236 and where the application manages the redundancy.
3237 "activePassiveBond": the application bonds with move of MAC address.
3238 "activeActiveBond“: bonded left/right links must be part of a multi-chassis LAG
3239 "activePassiveL3": application will move application IP address between the vNICs.
3240 "activeActiveL3": the application uses anycast/ECMP.
3244 - valid_values: ["infraProvided", "actPassBond", "actActBond", "actPassL3", "actActL3", "Left", "Right"]
3245 default: "infraProvided"
3248 Identifies for the direct.userdriver interface type, the physical
3249 nics the driver is verified to work with.
3250 Allowed values for nic types must be handled via a registry or be standardized.
3256 tosca.datatypes.asd.paramMappings:
3258 derived_from: tosca.datatypes.Root
3259 description: "Describes the datatype for parameter mapping"
3263 When present, this attribute specifies the name of the deployment
3264 artifact input parameter through which the orchestrator can
3265 configure the loadbalancerIP parameter of the K8s service
3266 or ingress controller that the extCpdData represents.
3267 Note: The format of the Content strings is specific for each different
3268 orchestration templating technology used (Helm, Teraform, etc.).
3269 Currently only a format for use with Helm charts is suggested:
3270 "<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
3271 Whether the optional parts of the format are present depends on how the
3272 parameter is declared in the helm chart. An example is:
3273 "chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.LBIP".
3278 When present, this attribute specifies the name of the deployment
3279 artifact input parameter through which the orchestrator can
3280 configure the extermalIPs parameter of the K8s service or ingress
3281 controller, or the pod network interface annotation, that the
3282 extCpdData represents.
3283 Note: The format of the Content strings is specific for each different
3284 orchestration templating technology used (Helm, Teraform, etc.).
3285 Currently only a format for use with Helm charts is suggested:
3286 "<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
3287 Whether the optional parts of the format are present depends on how the
3288 parameter is declared in the helm chart. An example is:
3289 "chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.extIP".
3296 Specifies, for an extCpdData respesenting a secondary network interface,
3297 the name(s) of the deployment artifact input parameter(s) through which
3298 the orchestrator can provide the names of the network attachment
3299 definitions (NADs) the orchestrator has created as base for the network
3300 interface the extCpdData represents.
3301 Note 1: When the extCpdData represent a networkRedundant/mated-pair of
3302 sriov interfaces, there are references to 2 or 3 related NADs needed
3303 to be passed, while for other interface types only one NAD reference
3304 is needed to be passed.
3305 Note 2: The format of the Content strings is specific for each different
3306 orchestration templating technology used (Helm, Teraform, etc.).
3307 Currently only a format for use with Helm charts is suggested:
3308 "<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
3309 Whether the optional parts of the format are present depends on how the
3310 parameter is declared in the helm chart. An example is:
3311 chartName:"subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.nadName".
3312 Note 3: A direct attached (passthrough) network interface, such as an sriov
3313 interface, attaches to a network via only one of the two switch planes
3314 in the infrastructure.
3315 When using a direct attached network interface one therefore commonly in a
3316 pod uses a mated pair of sriov network attachments, where each interface
3317 attaches same network but via different switchplane.
3318 The application uses the mated pair of network interfaces as a single
3319 logical “swith-path-redundant” network interface – and this is represented
3320 by a single extCpdData.
3321 Also there is a case where a third “bond” attachment interface is used in
3322 the pod, bonding the two direct interfaces so that the application do not
3323 need to handle the redundancy issues – application just uses the bond interface.
3324 In this case, all three attachments are together making up a logical
3325 “switch-path-redundant” network interface represented by a single extCpdData.
3326 When three NADs are used in the extCpdData the NAD implementing the bond attachment
3327 interface is provided through the parameter indicated in the third place in
3328 the nadNames attribute.
3335 Specifies, for an extCpdData respesenting a secondary network interface,
3336 the name of the deployment artifact input parameter through which the orchestrator
3337 can provide the namespace where the NetworkAttachmentDefinitions (NADs) are located.
3338 Attribute may be omitted if the namespace is same as the application
3340 Note: The format of the Content strings is specific for each different
3341 orchestration templating technology used (Helm, Teraform, etc.).
3342 Currently only a format for use with Helm charts is suggested:
3343 "<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
3344 Whether the optional parts of the format are present depends on how the
3345 parameter is declared in the helm chart. An example is:
3346 "chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.NameSpace".
3350 tosca.datatypes.asd.extCpdData:
3352 derived_from: tosca.datatypes.Root
3353 description: "Describes the datatype for external connection point definition data"
3356 description: "The identifier of this extCpdData"
3361 This property describes for a particular ExtCpd instance
3362 what service it exposes.
3365 virtual_link_requirement:
3367 Refers in an abstract way to the network or multiple networks that
3368 the ExtCpd shall be exposed on (ex: OAM, EndUser, backhaul, LI, etc)
3371 network_interface_realization_requirements:
3373 Details container implementation specific requirements on
3374 the NetworkAttachmentDefinition
3376 type: tosca.datatypes.asd.networkInterfaceRequirements
3377 input_param_mappings:
3379 Information on what helm chart input parameters that
3380 are required to be configured for this extCpd
3382 type: tosca.datatypes.asd.paramMappings
3385 Kubernetes API resource name for the resource manifest for the service,
3386 ingress controller or pod
3390 tosca.datatypes.asd.enhancedClusterCapabilities:
3392 derived_from: tosca.datatypes.Root
3393 description: "Describes the datatype for parameter mapping"
3397 Describes the minimal required Kernel version, e.g. 4.15.0.
3398 Coded as displayed by linux command uname –r
3401 required_kernel_modules:
3403 Required kernel modules are coded as listed by linux lsmod command,
3404 e.g. ip6_tables, cryptd, nf_nat etc.
3409 conflicting_kernel_modules:
3411 Kernel modules, which must not be present in the target environment.
3412 The kernel modules are coded as listed by linux lsmod command,
3413 e.g., ip6_tables, cryptd, nf_nat etc.
3414 Example: Linux kernel SCTP module, which would conflict with use of
3415 proprietary user space SCTP stack provided by the application.
3420 required_custom_resources:
3422 List the custom resource kinds required to be supported in the target
3423 environment. The list shall include those custom resource kinds which
3424 are not delivered with the application.
3428 type: tosca.datatypes.asd.customResourceRequirement
3431 This attribute allows to associate arbitrary labels to clusters.
3432 These can indicate special infrastructure capabilities (e.g., NW acceleration,
3433 GPU compute, etc.). The intent of these labels is to serve as a set of
3434 values that can help in application placement decisions.
3435 clusterLabels follow the Kubernetes label key-value-nomenclature
3436 (https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/).
3437 It is recommended that labels follow a standardized meaning e.g. for node
3438 features (https://kubernetes-sigs.github.io/node-feature-discovery/v0.9/get-started/features.html#table-of-contents).
3441 - feature.node.kubernetes.io/cpu-cpuid.AESNI: true
3447 description: a list of the name of the required K8s plugin
3451 type: tosca.datatypes.asd.requiredPlugin
3453 tosca.datatypes.asd.customResourceRequirement:
3455 derived_from: tosca.datatypes.Root
3457 kind: "Redis", apiVersion: "kubedb.com/v1alpha1"
3460 description: "the name of the custom resource requirement"
3464 description: "the api version of the custom resource requirement"
3468 tosca.datatypes.asd.requiredPlugin:
3470 derived_from: tosca.datatypes.Root
3471 description: "the required K8s plugin"
3474 description: "the name of the required K8s plugin"
3478 description: "the version of the required K8s plugin"