[SDC-29] Amdocs OnBoard 1707 initial commit.
[sdc.git] / openecomp-be / backend / openecomp-sdc-vendor-software-product-manager / src / test / resources / extractServiceComposition / toscaGlobalServiceTemplates / openecomp / 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_openecomp_1_0
16
17 metadata:
18   filename: openecomp/data.yml
19   version: '1.0'
20
21 imports:
22 - openecomp_index:
23     file: _index.yml
24
25 data_types:
26
27   org.openecomp.datatypes.network.ProviderNetwork:
28     derived_from: org.openecomp.datatypes.Root
29     properties:
30       is_provider_network:
31         description: \"true\" indicates that this a Neutron provider type of network
32         type: boolean
33         required: true
34       physical_network_name:
35         description: |
36           Identifies the NUMA processor cluster to which this physical network interface belongs. NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
37         type: string
38         required: false
39         constraints:
40         - valid_values:
41           - Physnet41
42           - Physnet42
43           - Physnet43
44           - Physnet44
45           - Physnet21
46           - Physnet22
47       numa:
48         description: |
49           PNIC instance within the NUMA processor cluster PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
50         type: string
51         required: false
52         constraints:
53         - valid_values:
54           - NUMA 0
55           - NUMA 1
56       pnic_instance:
57         description: PNIC instance within the NUMA processor cluster
58         type: integer
59         required: false
60
61   org.openecomp.datatypes.DeploymentFlavor:
62     derived_from: tosca.datatypes.Root
63     description: Deployment Flavor
64     properties:
65       name:
66         description: Deployment Flavor Name
67         type: string
68         status: SUPPORTED
69         required: true
70       license_feature_group:
71         description: license feature group associated with Deployment Flavor
72         type: org.openecomp.datatypes.FeatureGroup
73         status: SUPPORTED
74         required: true
75       compute_size:
76         description: Size of VM
77         type: org.openecomp.datatypes.ComputeFlavor
78         status: SUPPORTED
79         required: true
80
81   org.openecomp.datatypes.FeatureGroup:
82     derived_from: tosca.datatypes.Root
83     description: License Feature Group
84     properties:
85       license_feature_group_ref:
86         description: Deployment Flavor Name
87         type: string
88         status: SUPPORTED
89         required: true
90       part_number:
91         description: refrence part number related to feature group
92         type: string
93         status: SUPPORTED
94         required: true
95         
96   org.openecomp.datatypes.EcompHoming:
97     derived_from: org.openecomp.datatypes.Root
98     properties:
99       ecomp_selected_instance_node_target:
100         description: |
101           "true" indicates that the target deployment node for this instance will be auto-selected by OPENECOMP "false" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the operator-selected target node for the deployment of this Network instance).
102         type: boolean
103         default: false
104         required: true
105       homing_policy:
106         description: Referenc to a service level homing policy that OPENECOMP will use for instance deployment target node
107         type: string
108         required: false
109       instance_node_target:
110         description: Instance target deployment node
111         type: string
112         required: false
113
114   org.openecomp.datatypes.AssignmentRequirements:
115     derived_from: org.openecomp.datatypes.Root
116     properties:
117       is_required:
118         description: |
119           "true" indicates that assignment is required
120         type: boolean
121         default: false
122         required: true
123       count:
124         description: number of assignments required
125         type: integer
126         required: false    
127
128
129   org.openecomp.datatypes.network.IpRequirements:
130     derived_from: org.openecomp.datatypes.Root
131     properties:
132       ip_version:
133         type: integer
134         required: true
135         constraints:
136         - valid_values:
137           - 4
138           - 6
139       ip_count:
140         description: identifies the number of ip address to assign to the CP from the plan
141         type: org.openecomp.datatypes.AssignmentRequirements
142         required: true
143       floating_ip_count:
144         type: org.openecomp.datatypes.AssignmentRequirements
145         required: false
146       subnet_role:
147         type: string
148         required: false
149       assingment_method:
150         type: string
151         required: true
152         constraints:
153         - valid_values:
154           - fixed
155           - dhcp
156
157   org.openecomp.datatypes.network.PhysicalNetwork:
158     derived_from: org.openecomp.datatypes.Root
159     properties:
160       provider_network:
161         description: true indicates that this a Neutron provider type of network
162         type: boolean
163         required: true
164       physical_network_name:
165         description: |
166           Identifies the NUMA processor cluster to which this physical network interface belongs. NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. "01" = NUMA 0, "11" = NUMA 1)
167         type: string
168         required: false
169         constraints:
170         - valid_values:
171           - Physnet-SRIOV-1
172           - Physnet-SRIOV-2
173           - Physnet-SRIOV-11
174           - Physnet-SRIOV-12
175       numa:
176         description: |
177           PNIC instance within the NUMA processor cluster PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
178         type: string
179         required: false
180         constraints:
181         - valid_values:
182           - NUMA 0
183           - NUMA 1
184       pnic_instance:
185         description: PNIC instance within the NUMA processor cluster
186         type: integer
187         required: false
188
189   org.openecomp.datatypes.network.VlanRequirements:
190     derived_from: org.openecomp.datatypes.Root
191     properties:
192       vlan_range_plan:
193         description: reference to a vlan range plan
194         type: string
195         required: true
196       vlan_type:
197         description: identifies the vlan type (e.g., c-tag)
198         type: string
199         required: true
200         constraints:
201         - valid_values:
202           - c-tag
203           - s-tag
204       vlan_count:
205         description: identifies the number of vlan tags to assign to the CP from the plan
206         type: integer
207         required: true
208
209   org.openecomp.datatypes.ComputeFlavor:
210     derived_from: tosca.datatypes.Root
211     description: Compute Flavor (Size)
212     properties:
213       name:
214         description: Compute Flavor Name
215         type: string
216         status: SUPPORTED
217         required: true
218       num_cpus:
219         description: Number of cpu
220         type: integer
221         status: SUPPORTED
222         required: true
223       disk_size:
224         description: Disk size
225         type: scalar-unit.size
226         status: SUPPORTED
227         required: true
228       mem_size:
229         description: Memory size
230         type: scalar-unit.size
231         status: SUPPORTED
232         required: true
233
234   org.openecomp.datatypes.network.MacAssignments:
235     derived_from: org.openecomp.datatypes.Root
236     properties:
237       mac_range_plan:
238         description: reference to a MAC address range plan
239         type: string
240         required: true
241       mac_count:
242         description: identifies the number of MAC addresses to assign to the CP from the plan
243         type: integer
244         required: true
245
246   org.openecomp.datatypes.network.MacRequirements:
247     derived_from: org.openecomp.datatypes.Root
248     properties:
249       mac_range_plan:
250         description: reference to a MAC address range plan
251         type: string
252         required: true
253       mac_count:
254         description: identifies the number of MAC addresses to assign to the CP from the plan
255         type: org.openecomp.datatypes.AssignmentRequirements
256         required: true
257
258   org.openecomp.datatypes.network.SubnetAssignments:
259     derived_from: org.openecomp.datatypes.Root
260     properties:
261       ip_network_address_plan:
262         description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
263         type: string
264         required: false
265       dhcp_enabled:
266         description: \"true\" indicates the network has 1 or more policies
267         type: boolean
268         required: false
269       ip_version:
270         description: The IP version of the subnet
271         type: integer
272         required: true
273         constraints:
274         - valid_values:
275           - 4
276           - 6
277       cidr_mask:
278         description: The default subnet CIDR mask
279         type: integer
280         required: true
281       min_subnets_count:
282         description: Quantity of subnets that must be initially assigned
283         type: integer
284         default: 1
285         required: true
286
287   org.openecomp.datatypes.Artifact:
288     derived_from: org.openecomp.datatypes.Root
289     properties:
290       artifact_name:
291         description: Artifcat name
292         type: string
293         required: true
294       artifact_type:
295         description: Artifcat type
296         type: string
297         required: true
298       artifact_uuid:
299         description: Artifcat UUID
300         type: string
301         required: true
302       artifact_checksum:
303         description: Artifact checksum
304         type: string
305         required: true
306       artifact_url:
307         description: Artifcay URL. Can also include only the file name
308         type: string
309         required: true
310
311   org.openecomp.datatypes.network.IPv4SubnetAssignments:
312     derived_from: org.openecomp.datatypes.network.SubnetAssignments
313     properties:
314       use_ipv4:
315         description: Indicates IPv4 subnet assignments
316         type: boolean
317         required: true
318
319   org.openecomp.datatypes.Root:
320     derived_from: tosca.datatypes.Root
321     description: |
322       The AT&T root Data Type all other Data Types derive from
323     properties:
324       supplemental_data:
325         type: map
326         entry_schema:
327           type: string
328           description: |
329             A placeholder for missing properties that would be included in future openecomp model
330             versions. fromat <key>:<value>
331
332
333   org.openecomp.datatypes.substitution.SubstitutionFiltering:
334     derived_from: tosca.datatypes.Root
335     description: Substitution Filter
336     properties:
337       substitute_service_template:
338         description: Substitute Service Template
339         type: string
340         status: SUPPORTED
341         required: true
342       index_value:
343         description: Index value of the substitution service template runtime instance
344         type: integer
345         status: SUPPORTED
346         default: 0
347         required: false
348         constraints:
349         - greater_or_equal: 0
350       count:
351         description: Count
352         type: string
353         status: SUPPORTED
354         default: 1
355         required: false
356       scaling_enabled:
357         description: Indicates whether service scaling is enabled
358         type: boolean
359         status: SUPPORTED
360         default: true
361         required: false
362       mandatory:
363         description: Mandatory
364         type: boolean
365         status: SUPPORTED
366         required: false
367
368   org.openecomp.datatypes.network.NetworkFlows:
369     derived_from: org.openecomp.datatypes.Root
370     properties:
371       is_network_policy:
372         description: true indicates the network has 1 or more policies
373         type: boolean
374         default: false
375         required: false
376       network_policy:
377         description: Identifies the specific OPENECOMP Contrail network policy that must be applied to this network (source - from Policy Manager)
378         type: string
379         required: false
380       vpn_binding:
381         description: Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source - A&AI)
382         type: string
383         required: false
384
385   org.openecomp.datatypes.network.NetworkAssignments:
386     derived_from: org.openecomp.datatypes.Root
387     properties:
388       ecomp_generated_network_assignment:
389         description: |
390           "true" indicates that the network assignments will be auto-generated by OPENECOMP "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).
391         type: boolean
392         default: false
393         required: true
394       network_assignments_file:
395         description: Filename of the template that specifies all of the configurable name/value pairs of Network assignments in this Network model
396         type: string
397         required: false
398       multi_tenant:
399         description: true means this network is shared by multiple Openstack tenants
400         type: boolean
401         default: true
402         required: true
403       min_subnets_count:
404         description: Quantity of subnets that must be initially assigned
405         type: integer
406         required: true
407       ip_network_address_plan:
408         description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
409         type: string
410         required: true
411       vlan_network_address_plan:
412         description: Reference to VLAN or other address plan ID used to assign subnets to this network
413         type: string
414         required: true
415
416   org.openecomp.datatypes.network.IPv6SubnetAssignments:
417     derived_from: org.openecomp.datatypes.network.SubnetAssignments
418     properties:
419       use_ipv6:
420         description: Indicates IPv6 subnet assignments
421         type: boolean
422         required: true
423
424   org.openecomp.datatypes.EcompNaming:
425     derived_from: org.openecomp.datatypes.Root
426     properties:
427       ecomp_generated_naming:
428         description: |
429           "true" indicates that the name for the instance will be auto-generated by OPENECOMP. "false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
430         type: boolean
431         default: true
432         required: true
433       naming_policy:
434         description: Referenc to naming policy that OPENECOMP will use when the name is auto-generated
435         type: string
436         required: false
437                 
438   org.openecomp.datatypes.Naming:
439     derived_from: org.openecomp.datatypes.Root
440     properties:
441       ecomp_generated_naming:
442         description: |
443           "true" indicates that the name for the instance will be auto-generated by OPENECOMP. "false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
444         type: boolean
445         default: true
446         required: true
447   
448   org.openecomp.datatypes.EcompGeneratedNaming:
449     derived_from: org.openecomp.datatypes.Naming
450     properties:
451       naming_policy:
452         description: Referenc to naming policy that OPENECOMP will use when the name is auto-generated
453         type: string
454         required: false
455                                 
456   org.openecomp.datatypes.UserDefinedNaming:
457     derived_from: org.openecomp.datatypes.Naming
458     properties:
459       instance_name:
460         description: Reference to naming policy that OPENECOMP will use when the name is auto-generated
461         type: string
462         required: false
463