Release version 1.13.7
[sdc.git] / catalog-be / src / main / resources / import / tosca / group-types / groupTypes.yml
1 tosca.groups.Root:
2   description: The TOSCA Group Type all other TOSCA Group Types derive from
3   interfaces:
4     Standard:
5       type: tosca.interfaces.node.lifecycle.Standard
6 org.openecomp.groups.heat.HeatStack:
7   derived_from: tosca.groups.Root
8   description: Grouped all heat resources which are in the same heat stack
9   properties:
10     heat_file:
11       type: string
12       description: Heat file which associate to this group/heat stack
13       required: true
14       status: supported
15     description:
16       type: string
17       description: group description
18       required: true
19       status: supported
20 org.openecomp.groups.VfModule:
21   derived_from: tosca.groups.Root
22   description: Grouped all heat resources which are in the same VF Module
23   properties:
24     isBase:
25       type: boolean
26       description: Whether this module should be deployed before other modules
27       required: true
28       default: false
29       status: supported
30     vf_module_label:
31       type: string
32       required: true
33       description: >
34         Alternate textual key used to reference this VF-Module model.
35         Must be unique within the VNF model
36     vf_module_description:
37       type: string
38       required: true
39       description: >
40         Description of the VF-modules contents and purpose
41         (e.g. "Front-End" or "Database Cluster")
42     min_vf_module_instances:
43       type: integer
44       required: true
45       description: The minimum instances of this VF-Module
46     max_vf_module_instances:
47       type: integer
48       required: false
49       description: The maximum instances of this VF-Module
50     initial_count:
51       type: integer
52       required: false
53       description: >
54         The initial count of instances of the VF-Module. The value must be in the
55         range between min_vfmodule_instances and max_vfmodule_instances.
56         If no value provided the initial count is the min_vfmodule_instances.
57     vf_module_type:
58       type: string
59       required: true
60       constraints:
61         - valid_values: ["Base", "Expansion"]
62     volume_group:
63       type: boolean
64       required: true
65       default: false
66       description: >
67         "true" indicates that this VF Module model requires attachment to a Volume
68         Group.
69         VID operator must select the Volume Group instance to attach to a VF-Module
70         at deployment time.
71     availability_zone_count:
72       type: integer
73       required: false
74       description: >
75         Quantity of Availability Zones needed for this VF-Module
76         (source: Extracted from VF-Module HEAT template)
77     vfc_list:
78       type: map
79       entry_schema:
80         description: <vfc_id>:<count>
81         type: string
82       required: false
83       description: >
84         Identifies the set of VM types and their count included in the VF-Module
85 org.openecomp.groups.NetworkCollection:
86   derived_from: tosca.groups.Root
87   description: groups l3-networks in network collection
88   properties:
89     network_collection_function:
90       type: string
91       required: true
92       description: network collection function
93     network_collection_description:
94       type: string
95       required: true
96       description: network collection description, free format text
97 org.openecomp.groups.VfcInstanceGroup:
98   derived_from: tosca.groups.Root
99   description: groups VFCs with same parent port role
100   properties:
101     vfc_instance_group_function:
102       type: string
103       required: true
104       description: function of this VFC group
105     vfc_parent_port_role:
106       type: string
107       required: true
108       description: common role of parent ports of VFCs in this group
109     network_collection_function:
110       type: string
111       required: true
112       description: network collection function assigned to this group
113     subinterface_role:
114       type: string
115       required: true
116       description: common role of subinterfaces of VFCs in this group, criteria the group is created
117   capabilities:
118     vlan_assignment:
119       type: org.openecomp.capabilities.VLANAssignment
120       properties:
121         vfc_instance_group_reference:
122           type: string
123 # NFV group types
124 tosca.groups.nfv.PlacementGroup:
125   derived_from: tosca.groups.Root
126   description: PlacementGroup is used for describing the affinity or anti-affinity relationship applicable between the virtualization containers to be created based on different VDUs, or between internal VLs to be created based on different VnfVirtualLinkDesc(s)
127   properties:
128     description:
129       type: string
130       description: Human readable description of the group
131       required: true
132   members: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink ]