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