common/onap-tosca-datatype/src/main/resources/globalTypes/openecomp/capabilities.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/capabilities.yml
  19   version: '1.0'
  20
  21 imports:
  22 - openecomp_index:
  23     file: _index.yml
  24
  25 capability_types:
  26
  27   org.openecomp.capabilities.attachment.DeploymentFlavor:
  28     derived_from: tosca.capabilities.Attachment
  29     description: The Node capability indicates the base capabilities of a TOSCA Node Type.
  30     properties:
  31       DeploymentFlavor:
  32         type: map
  33         description: Deployment flavors instance
  34         required: true
  35         status: SUPPORTED
  36         entry_schema:
  37             type: org.openecomp.datatypes.DeploymentFlavor
  38
  39   org.openecomp.capabilities.metric.SnmpTrap:
  40     derived_from: org.openecomp.capabilities.Metric
  41     description: A node type that includes the Metric capability indicates that it can be monitored using snmp trap.
  42     properties:
  43       oid:
  44         description: Object Id of the metric
  45         type: string
  46         status: SUPPORTED
  47         required: true
  48
  49   org.openecomp.capabilities.AllottedResource:
  50     derived_from: tosca.capabilities.Root
  51
  52   org.openecomp.capabilities.metric.SnmpPolling:
  53     derived_from: org.openecomp.capabilities.Metric
  54     description: A node type that includes the Metric capability indicates that it can be monitored using snmp polling.
  55     properties:
  56       oid:
  57         description: Object Id of the metric
  58         type: string
  59         status: SUPPORTED
  60         required: true
  61
  62   org.openecomp.capabilities.metric.Ceilometer:
  63     derived_from: org.openecomp.capabilities.Metric
  64     description: A node type that includes the Metric capability indicates that it can be monitored using ceilometer.
  65     properties:
  66       name:
  67         description: Ceilometer metric type name to monitor. (The name ceilometer is using)
  68         type: string
  69         status: SUPPORTED
  70         required: true
  71
  72   org.openecomp.capabilities.Metric:
  73     derived_from: tosca.capabilities.Endpoint
  74     description: A node type that includes the Metric capability indicates that it can be monitored.
  75     properties:
  76       unit:
  77         description: Unit of the metric value
  78         type: string
  79         status: SUPPORTED
  80         required: true
  81       description:
  82         description: Description of the metric
  83         type: string
  84         status: SUPPORTED
  85         required: false
  86       type:
  87         description: Type of the metric value, for an example, Cumulative, Delta, Gauge and etc.
  88         type: string
  89         status: SUPPORTED
  90         required: true
  91       category:
  92         description: Category of the metric, for an example, compute, disk, network, storage and etc.
  93         type: string
  94         status: SUPPORTED
  95         required: false
  96     attributes:
  97       value:
  98         description: Runtime monitored value
  99         type: string
 100         status: SUPPORTED
 101
 102   org.openecomp.capabilities.Forwarder:
 103       derived_from: tosca.capabilities.Root
 104   # New capability types for Port Mirroring
 105   org.openecomp.capabilities.PortMirroring:
 106     derived_from: tosca.capabilities.Root
 107     properties:
 108       connection_point:
 109         type: org.openecomp.datatypes.PortMirroringConnectionPointDescription
 110         required: true
 111
 112   org.openecomp.capabilities.VLANAssignment:
 113     derived_from: tosca.capabilities.Root
 114     description: ability to expose routing information of the internal network
 115     properties:
 116        vfc_instance_group_reference:
 117           type: string
 118           description: ability to recognize capability per vfc instance group on vnf instance
 119           required: true