common/onap-tosca-datatype/src/main/resources/globalTypes/openecomp/groups.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/groups.yml
  19   version: '1.0'
  20
  21 imports:
  22 - openecomp_index:
  23     file: _index.yml
  24
  25 group_types:
  26
  27   org.openecomp.groups.VfModule:
  28     derived_from: tosca.groups.Root
  29     description: Grouped all heat resources which are in the same VF Module
  30     properties:
  31       isBase:
  32         description: Whether this module should be deployed before other modules
  33         type: boolean
  34         status: SUPPORTED
  35         default: false
  36         required: true
  37       vf_module_label:
  38         description: |
  39           Alternate textual key used to reference this VF-Module model.  Must be unique within the VNF model
  40         type: string
  41         required: true
  42       vf_module_description:
  43         description: |
  44           Description of the VF-modules contents and purpose   (e.g. "Front-End" or "Database Cluster")
  45         type: string
  46         required: true
  47       min_vf_module_instances:
  48         description: The minimum instances of this VF-Module
  49         type: integer
  50         required: true
  51       max_vf_module_instances:
  52         description: The maximum instances of this VF-Module
  53         type: integer
  54         required: false
  55       initial_count:
  56         description: |
  57           The initial count of instances of the VF-Module. The value must be in the  range between min_vfmodule_instances and max_vfmodule_instances. If no value provided the initial count is the min_vfmodule_instances.
  58         type: integer
  59         required: false
  60       vf_module_type:
  61         type: string
  62         required: true
  63         constraints:
  64         - valid_values:
  65           - Base
  66           - Expansion
  67       volume_group:
  68         description: |
  69           "true" indicates that this VF Module model requires attachment to a Volume   Group.  VID operator must select the Volume Group instance to attach to a VF-Module  at deployment time.
  70         type: boolean
  71         default: false
  72         required: true
  73
  74   org.openecomp.groups.VfcInstanceGroup:
  75     derived_from: tosca.groups.Root
  76     description: groups VFCs with same parent port role
  77     properties:
  78       vfc_instance_group_function:
  79         type: string
  80         required: true
  81         description: role of this VFC group
  82       vfc_parent_port_role:
  83         type: string
  84         required: true
  85         description: common role of parent ports of VFCs in this group
  86       network_collection_function:
  87         type: string
  88         required: true
  89         description: network collection role assigned to this group
  90       subinterface_role:
  91         type: string
  92         required: true
  93         description: common role of subinterfaces of VFCs in this group, criteria the group is created