Initial OpenECOMP SDC commit
[sdc.git] / catalog-be / src / main / resources / import / tosca / data-types / dataTypes.yml
1 tosca.datatypes.Root:
2   description: The TOSCA root Data Type all other TOSCA base Data Types derive from
3
4 integer:
5   derived_from: tosca.datatypes.Root
6
7 string:
8   derived_from: tosca.datatypes.Root
9
10 boolean:
11   derived_from: tosca.datatypes.Root
12
13 float:
14   derived_from: tosca.datatypes.Root
15
16 json:
17   derived_from: tosca.datatypes.Root  
18
19 list:
20   derived_from: tosca.datatypes.Root
21
22 map:
23   derived_from: tosca.datatypes.Root
24
25 tosca.datatypes.Credential: 
26   derived_from: tosca.datatypes.Root
27   properties: 
28     protocol: 
29       type: string
30       required: false
31     token_type: 
32       type: string
33       default: password
34     token: 
35       type: string
36     keys:
37       type: map
38       required: false
39       entry_schema:
40         type: string
41     user:
42       type: string
43       required: false
44
45 tosca.datatypes.TimeInterval: 
46   derived_from: tosca.datatypes.Root
47   properties:
48     start_time: 
49       type: timestamp
50       required: true
51     end_time: 
52       type: timestamp
53       required: true
54
55 tosca.datatypes.network.NetworkInfo:
56   derived_from: tosca.datatypes.Root
57   properties:  
58     network_name: 
59       type: string
60     network_id: 
61       type: string
62     addresses:
63       type: list
64       entry_schema:
65         type: string
66
67 tosca.datatypes.network.PortInfo: 
68   derived_from: tosca.datatypes.Root
69   properties:  
70     port_name: 
71       type: string
72     port_id: 
73       type: string
74     network_id: 
75       type: string
76     mac_address: 
77       type: string
78     addresses:
79       type: list
80       entry_schema:
81         type: string
82
83 tosca.datatypes.network.PortDef:
84   derived_from: integer
85   constraints: 
86     - in_range: [ 1, 65535 ]
87
88 tosca.datatypes.network.PortSpec: 
89   derived_from: tosca.datatypes.Root
90   properties:  
91     protocol: 
92       type: string
93       required: true
94       default: tcp
95       constraints:
96         - valid_values: [ udp, tcp, igmp ]
97     target:  
98       type: tosca.datatypes.network.PortDef
99     target_range:
100       type: range 
101       constraints:
102         - in_range: [ 1, 65535 ]
103     source:
104       type: tosca.datatypes.network.PortDef
105     source_range:
106       type: range
107       constraints:
108         - in_range: [ 1, 65535 ]
109
110
111
112 org.openecomp.datatypes.heat.network.AddressPair:
113   derived_from: tosca.datatypes.Root
114   description: MAC/IP address pairs
115   properties:
116     mac_address:
117       type: string
118       description: MAC address
119       required: false
120       status: SUPPORTED
121     ip_address:
122       type: string
123       description: IP address
124       required: false
125       status: SUPPORTED
126 org.openecomp.datatypes.heat.network.subnet.HostRoute:
127   derived_from: tosca.datatypes.Root
128   description: Host route info for the subnet
129   properties:
130     destination:
131       type: string
132       description: The destination for static route
133       required: false
134       status: SUPPORTED
135     nexthop:
136       type: string
137       description: The next hop for the destination
138       required: false
139       status: SUPPORTED
140       
141 org.openecomp.datatypes.heat.network.AllocationPool:
142   derived_from: tosca.datatypes.Root
143   description: The start and end addresses for the allocation pool
144   properties:
145     start:
146       type: string
147       description: Start address for the allocation pool
148       required: false
149       status: SUPPORTED
150     end:
151       type: string
152       description: End address for the allocation pool
153       required: false
154       status: SUPPORTED
155
156 org.openecomp.datatypes.heat.network.neutron.Subnet:
157   derived_from: tosca.datatypes.Root
158   description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances
159   properties:
160     tenant_id:
161       type: string
162       description: The ID of the tenant who owns the network
163       required: false
164       status: SUPPORTED
165     enable_dhcp:
166       type: boolean
167       description: Set to true if DHCP is enabled and false if DHCP is disabled
168       required: false
169       default: true
170       status: SUPPORTED
171     ipv6_address_mode:
172       type: string
173       description: IPv6 address mode
174       required: false
175       status: SUPPORTED
176       constraints:
177       - valid_values:
178         - dhcpv6-stateful
179         - dhcpv6-stateless
180         - slaac
181     ipv6_ra_mode:
182       type: string
183       description: IPv6 RA (Router Advertisement) mode
184       required: false
185       status: SUPPORTED
186       constraints:
187       - valid_values:
188         - dhcpv6-stateful
189         - dhcpv6-stateless
190         - slaac
191     value_specs:
192       type: map
193       description: Extra parameters to include in the request
194       required: false
195       default: {
196         }
197       status: SUPPORTED
198       entry_schema:
199         type: string
200     allocation_pools:
201        type: list
202        description: The start and end addresses for the allocation pools
203        required: false
204        status: SUPPORTED
205        entry_schema:
206          type: org.openecomp.datatypes.heat.network.AllocationPool
207     subnetpool:
208       type: string
209       description: The name or ID of the subnet pool
210       required: false
211       status: SUPPORTED
212     dns_nameservers:
213       type: list
214       description: A specified set of DNS name servers to be used
215       required: false
216       default: [
217         ]
218       status: SUPPORTED
219       entry_schema:
220         type: string     
221     host_routes:
222       type: list
223       description: The gateway IP address
224       required: false
225       status: SUPPORTED
226       entry_schema:
227         type: org.openecomp.datatypes.heat.network.subnet.HostRoute
228     ip_version:
229       type: integer
230       description: The gateway IP address
231       required: false
232       default: 4
233       status: SUPPORTED
234       constraints:
235       - valid_values:
236         - '4'
237         - '6'
238     name:
239       type: string
240       description: The name of the subnet
241       required: false
242       status: SUPPORTED
243     prefixlen:
244       type: integer
245       description: Prefix length for subnet allocation from subnet pool
246       required: false
247       status: SUPPORTED
248       constraints:
249       - greater_or_equal: 0
250     cidr:
251       type: string
252       description: The CIDR
253       required: false
254       status: SUPPORTED
255     gateway_ip:
256       type: string
257       description: The gateway IP address
258       required: false
259       status: SUPPORTED
260
261 org.openecomp.datatypes.heat.novaServer.network.PortExtraProperties:
262   derived_from: tosca.datatypes.Root
263   description: Nova server network expand properties for port
264   properties:
265     port_security_enabled:
266       type: boolean
267       description: Flag to enable/disable port security on the port
268       required: false
269       status: SUPPORTED
270     mac_address:
271       type: string
272       description: MAC address to give to this port
273       required: false
274       status: SUPPORTED
275     admin_state_up:
276       type: boolean
277       description: The administrative state of this port
278       required: false
279       default: true
280       status: SUPPORTED
281     qos_policy:
282       type: string
283       description: The name or ID of QoS policy to attach to this port
284       required: false
285       status: SUPPORTED
286     allowed_address_pairs:
287       type: list
288       description: Additional MAC/IP address pairs allowed to pass through the port
289       required: false
290       status: SUPPORTED
291       entry_schema:
292         type: org.openecomp.datatypes.heat.network.AddressPair
293     binding:vnic_type:
294       type: string
295       description: The vnic type to be bound on the neutron port
296       required: false
297       status: SUPPORTED
298       constraints:
299       - valid_values:
300         - macvtap
301         - direct
302         - normal
303     value_specs:
304       type: map
305       description: Extra parameters to include in the request
306       required: false
307       default: {
308         }
309       status: SUPPORTED
310       entry_schema:
311         type: string
312 org.openecomp.datatypes.heat.novaServer.network.AddressInfo:
313   derived_from: tosca.datatypes.network.NetworkInfo
314   description: Network addresses with corresponding port id
315   properties:
316     port_id:
317       type: string
318       description: Port id
319       required: false
320       status: SUPPORTED
321 org.openecomp.datatypes.heat.neutron.port.FixedIps:
322   derived_from: tosca.datatypes.Root
323   description: subnet/ip_address
324   properties:
325     subnet:
326       type: string
327       description: Subnet in which to allocate the IP address for this port
328       required: false
329       status: SUPPORTED
330     ip_address:
331       type: string
332       description: IP address desired in the subnet for this port
333       required: false
334       status: SUPPORTED
335 org.openecomp.datatypes.heat.FileInfo:
336   derived_from: tosca.datatypes.Root
337   description: Heat File Info
338   properties:
339     file:
340       type: string
341       description: The required URI string (relative or absolute) which can be used to locate the file
342       required: true
343       status: SUPPORTED
344     file_type:
345       type: string
346       description: The type of the file
347       required: true
348       status: SUPPORTED
349       constraints:
350       - valid_values:
351         - base
352         - env
353         - volume
354         - network
355 org.openecomp.datatypes.heat.contrail.network.rule.PortPairs:
356     derived_from: tosca.datatypes.Root
357     description: source and destination port pairs
358     properties:
359       start_port:
360         type: string
361         description: Start port
362         required: false
363         status: SUPPORTED
364       end_port:
365         type: string
366         description: End port
367         required: false
368         status: SUPPORTED
369 org.openecomp.datatypes.heat.contrail.network.rule.Rule:
370     derived_from: tosca.datatypes.Root
371     description: policy rule
372     properties:
373       src_ports:
374         type: list
375         description: Source ports
376         required: false
377         status: SUPPORTED
378         entry_schema:
379           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
380       protocol:
381         type: string
382         description: Protocol
383         required: false
384         status: SUPPORTED
385       dst_addresses:
386         type: list
387         description: Destination addresses
388         required: false
389         status: SUPPORTED
390         entry_schema:
391           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
392       apply_service:
393         type: string
394         description: Service to apply
395         required: false
396         status: SUPPORTED
397       dst_ports:
398         type: list
399         description: Destination ports
400         required: false
401         status: SUPPORTED
402         entry_schema:
403           type: org.openecomp.datatypes.heat.contrail.network.rule.PortPairs
404       src_addresses:
405         type: list
406         description: Source addresses
407         required: false
408         status: SUPPORTED
409         entry_schema:
410           type: org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork
411       direction:
412         type: string
413         description: Direction
414         required: false
415         status: SUPPORTED
416 org.openecomp.datatypes.heat.contrail.network.rule.RuleList:
417     derived_from: tosca.datatypes.Root
418     description: list of policy rules
419     properties:
420       policy_rule:
421         type: list
422         description: Contrail network rule
423         required: false
424         status: SUPPORTED
425         entry_schema:
426           type: corg.openecomp.datatypes.heat.contrail.network.rule.Rule
427 org.openecomp.datatypes.heat.contrail.network.rule.VirtualNetwork:
428     derived_from: tosca.datatypes.Root
429     description: source and destination addresses
430     properties:
431       virtual_network:
432         type: string
433         description: Virtual network
434         required: false
435         status: SUPPORTED
436
437 org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule:
438     derived_from: tosca.datatypes.Root
439     description: Rules Pairs
440     properties:
441       remote_group_id:
442         type: string
443         description: The remote group ID to be associated with this security group rule
444         required: false
445         status: SUPPORTED
446       protocol:
447         type: string
448         description: The protocol that is matched by the security group rule
449         required: false
450         status: SUPPORTED
451         constraints:
452         - valid_values:
453           - tcp
454           - udp
455           - icmp
456       ethertype:
457         type: string
458         description: Ethertype of the traffic
459         required: false
460         default: IPv4
461         status: SUPPORTED
462         constraints:
463         - valid_values:
464           - IPv4
465           - IPv6
466       port_range_max:
467         type: integer
468         description: 'The maximum port number in the range that is matched by the
469           security group rule. '
470         required: false
471         status: SUPPORTED
472         constraints:
473         - in_range:
474           - 0
475           - 65535
476       remote_ip_prefix:
477         type: string
478         description: The remote IP prefix (CIDR) to be associated with this security group rule
479         required: false
480         status: SUPPORTED
481       remote_mode:
482         type: string
483         description: Whether to specify a remote group or a remote IP prefix
484         required: false
485         default: remote_ip_prefix
486         status: SUPPORTED
487         constraints:
488         - valid_values:
489           - remote_ip_prefix
490           - remote_group_id
491       direction:
492         type: string
493         description: The direction in which the security group rule is applied
494         required: false
495         default: ingress
496         status: SUPPORTED
497         constraints:
498         - valid_values:
499           - egress
500           - ingress
501       port_range_min:
502         type: integer
503         description: The minimum port number in the range that is matched by the security group rule.
504         required: false
505         status: SUPPORTED
506         constraints:
507         - in_range:
508           - 0
509           - 65535
510 org.openecomp.datatypes.heat.substitution.SubstitutionFiltering:
511     derived_from: tosca.datatypes.Root
512     description: Substitution Filter
513     properties:
514       substitute_service_template:
515         type: string
516         description: Substitute Service Template
517         required: true
518         status: SUPPORTED
519       index_value:
520         type: integer
521         description: Index value of the substitution service template runtime instance
522         required: false
523         default: 0
524         status: SUPPORTED
525         constraints:
526         - greater_or_equal: 0
527       count:
528         type: string
529         description: Count
530         required: false
531         default: 1
532         status: SUPPORTED
533       scaling_enabled:
534         type: boolean
535         description: Indicates whether service scaling is enabled
536         required: false
537         default: true
538         status: SUPPORTED
539       mandatory:
540         type: boolean
541         description: Mandatory
542         required: false
543         default: true
544         status: SUPPORTED
545 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence:
546     derived_from: tosca.datatypes.Root
547     description: network policy refs data sequence
548     properties:
549       network_policy_refs_data_sequence_major:
550         type: integer
551         description: Network Policy ref data sequence Major
552         required: false
553         status: SUPPORTED
554       network_policy_refs_data_sequence_minor:
555         type: integer
556         description: Network Policy ref data sequence Minor
557         required: false
558         status: SUPPORTED
559 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefData:
560     derived_from: tosca.datatypes.Root
561     description: network policy refs data
562     properties:
563       network_policy_refs_data_sequence:
564         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.RefDataSequence
565         description: Network Policy ref data sequence
566         required: false
567         status: SUPPORTED
568 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet:
569     derived_from: tosca.datatypes.Root
570     description: Network Ipam Ref Data Subnet
571     properties:
572       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix_len:
573         type: string
574         description: Network ipam refs data ipam subnets ip prefix len
575         required: false
576         status: SUPPORTED
577       network_ipam_refs_data_ipam_subnets_subnet_ip_prefix:
578         type: string
579         description: Network ipam refs data ipam subnets ip prefix
580         required: false
581         status: SUPPORTED
582 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList:
583     derived_from: tosca.datatypes.Root
584     description: Network Ipam Ref Data Subnet List
585     properties:
586       network_ipam_refs_data_ipam_subnets_subnet:
587         type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnet
588         description: Network ipam refs data ipam subnets
589         required: false
590         status: SUPPORTED
591       network_ipam_refs_data_ipam_subnets_addr_from_start:
592         type: string
593         description: Network ipam refs data ipam subnets addr from start
594         required: false
595         status: SUPPORTED
596 org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.IpamRefData:
597     derived_from: tosca.datatypes.Root
598     description: Network Ipam Ref Data
599     properties:
600       network_ipam_refs_data_ipam_subnets:
601         type: list
602         description: Network ipam refs data ipam subnets
603         required: false
604         status: SUPPORTED
605         entry_schema:
606           type: org.openecomp.datatypes.heat.contrailV2.virtual.network.rule.ref.data.IpamSubnetList
607 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork:
608     derived_from: tosca.datatypes.Root
609     description: source addresses
610     properties:
611       network_policy_entries_policy_rule_src_addresses_virtual_network:
612         type: string
613         description: Source addresses Virtual network
614         required: false
615         status: SUPPORTED
616 org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork:
617     derived_from: tosca.datatypes.Root
618     description: destination addresses
619     properties:
620       network_policy_entries_policy_rule_dst_addresses_virtual_network:
621         type: string
622         description: Destination addresses Virtual network
623         required: false
624         status: SUPPORTED
625 org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs:
626     derived_from: tosca.datatypes.Root
627     description: destination port pairs
628     properties:
629       network_policy_entries_policy_rule_dst_ports_start_port:
630         type: string
631         description: Start port
632         required: false
633         status: SUPPORTED
634       network_policy_entries_policy_rule_dst_ports_end_port:
635         type: string
636         description: End port
637         required: false
638         status: SUPPORTED
639 org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs:
640     derived_from: tosca.datatypes.Root
641     description: source port pairs
642     properties:
643       network_policy_entries_policy_rule_src_ports_start_port:
644         type: string
645         description: Start port
646         required: false
647         status: SUPPORTED
648       network_policy_entries_policy_rule_src_ports_end_port:
649         type: string
650         description: End port
651         required: false
652         status: SUPPORTED
653 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
654     derived_from: tosca.datatypes.Root
655     description: Action List
656     properties:
657       network_policy_entries_policy_rule_action_list_simple_action:
658         type: string
659         description: Simple Action
660         required: false
661         status: SUPPORTED
662       network_policy_entries_policy_rule_action_list_apply_service:
663         type: list
664         description: Apply Service
665         required: false
666         status: SUPPORTED
667         entry_schema:
668           type: string
669 org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList:
670     derived_from: tosca.datatypes.Root
671     description: Action List
672     properties:
673       network_policy_entries_policy_rule_action_list_simple_action:
674         type: string
675         description: Simple Action
676         required: false
677         status: SUPPORTED
678       network_policy_entries_policy_rule_action_list_apply_service:
679         type: list
680         description: Apply Service
681         required: false
682         status: SUPPORTED
683         entry_schema:
684           type: string
685 org.openecomp.datatypes.heat.contrailV2.network.rule.Rule:
686     derived_from: tosca.datatypes.Root
687     description: policy rule
688     properties:
689       network_policy_entries_policy_rule_dst_addresses:
690         type: list
691         description: Destination addresses
692         required: false
693         status: SUPPORTED
694         entry_schema:
695           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstVirtualNetwork
696       network_policy_entries_policy_rule_dst_ports:
697         type: list
698         description: Destination ports
699         required: false
700         status: SUPPORTED
701         entry_schema:
702           type: org.openecomp.datatypes.heat.contrailV2.network.rule.DstPortPairs
703       network_policy_entries_policy_rule_protocol:
704         type: string
705         description: Protocol
706         required: false
707         status: SUPPORTED
708       network_policy_entries_policy_rule_src_addresses:
709         type: list
710         description: Source addresses
711         required: false
712         status: SUPPORTED
713         entry_schema:
714           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcVirtualNetwork
715       network_policy_entries_policy_rule_direction:
716         type: string
717         description: Direction
718         required: false
719         status: SUPPORTED
720       network_policy_entries_policy_rule_src_ports:
721         type: list
722         description: Source ports
723         required: false
724         status: SUPPORTED
725         entry_schema:
726           type: org.openecomp.datatypes.heat.contrailV2.network.rule.SrcPortPairs
727       network_policy_entries_policy_rule_action_list:
728         type: org.openecomp.datatypes.heat.contrailV2.network.rule.ActionList
729         description: Action list
730         required: false
731         status: SUPPORTED
732 org.openecomp.datatypes.heat.contrailV2.network.rule.RuleList:
733     derived_from: tosca.datatypes.Root
734     description: list of policy rules
735     properties:
736       network_policy_entries_policy_rule:
737         type: list
738         description: Contrail network rule
739         required: false
740         status: SUPPORTED
741         entry_schema:
742           type: org.openecomp.datatypes.heat.contrailV2.network.rule.Rule
743 org.openecomp.datatypes.heat.network.contrail.port.StaticRoute:
744     derived_from: tosca.datatypes.Root
745     description: static route
746     properties:
747       prefix:
748         type: string
749         description: Route prefix
750         required: false
751         status: SUPPORTED
752       next_hop:
753         type: string
754         description: Next hop
755         required: false
756         status: SUPPORTED
757       next_hop_type:
758         type: string
759         description: Next hop type
760         required: false
761         status: SUPPORTED
762 org.openecomp.datatypes.heat.network.contrail.AddressPair:
763     derived_from: tosca.datatypes.Root
764     description: Address Pair
765     properties:
766       address_mode:
767         type: string
768         description: Address mode active-active or active-standy
769         required: false
770         status: SUPPORTED
771         constraints:
772         - valid_values:
773           - active-active
774           - active-standby
775       prefix:
776         type: string
777         description: IP address prefix
778         required: false
779         status: SUPPORTED
780       mac_address:
781         type: string
782         description: Mac address
783         required: false
784         status: SUPPORTED
785 org.openecomp.datatypes.heat.network.contrail.InterfaceData:
786     derived_from: tosca.datatypes.Root
787     description: Interface Data
788     properties:
789       static_routes:
790         type: list
791         description: An ordered list of static routes to be added to this interface
792         required: false
793         status: SUPPORTED
794         entry_schema:
795           type: org.openecomp.datatypes.heat.network.contrail.port.StaticRoute
796       virtual_network:
797         type: string
798         description: Virtual Network for this interface
799         required: true
800         status: SUPPORTED
801       allowed_address_pairs:
802         type: list
803         description: List of allowed address pair for this interface
804         required: false
805         status: SUPPORTED
806         entry_schema:
807           type: org.openecomp.datatypes.heat.network.contrail.AddressPair
808       ip_address:
809         type: string
810         description: IP for this interface
811         required: false
812         status: SUPPORTED
813 org.openecomp.datatypes.heat.contrailV2.virtual.machine.interface.Properties:
814     derived_from: tosca.datatypes.Root
815     description: Virtual Machine Interface Properties.
816     properties:
817       virtual_machine_interface_properties_service_interface_type:
818         type: string
819         description: Service Interface Type.
820         required: false
821         status: SUPPORTED