src/test/resources/ymlFiles/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_0
  16
  17 #metadata:
  18 #  filename: tosca/capabilities.yml
  19 #  version: '1.0'
  20
  21 imports:
  22 - data.yml
  23
  24 capability_types:
  25   tosca.capabilities.Root:
  26     description: This is the default (root) TOSCA Capability Type definition that all other TOSCA Capability Types derive from.
  27
  28   tosca.capabilities.Node:
  29     derived_from: tosca.capabilities.Root
  30     description: The Node capability indicates the base capabilities of a TOSCA Node Type.
  31
  32   tosca.capabilities.Container:
  33     derived_from: tosca.capabilities.Root
  34     description: The Container capability, when included on a Node Type or Template definition, indicates that the node can act as a container for (or a host for) one or more other declared Node Types.
  35     properties:
  36       num_cpus:
  37         description: Number of (actual or virtual) CPUs associated with the Compute node.
  38         type: integer
  39         required: false
  40         constraints:
  41         - greater_or_equal: 1
  42       cpu_frequency:
  43         description: Specifies the operating frequency of CPU's core. This property expresses the expected frequency of one (1) CPU as provided by the property "num_cpus".
  44         type: scalar-unit.frequency
  45         required: false
  46         constraints:
  47         - greater_or_equal: 0.1 GHz
  48       disk_size:
  49         description: Size of the local disk available to applications running on the Compute node (default unit is MB).
  50         type: scalar-unit.size
  51         required: false
  52         constraints:
  53         - greater_or_equal: 0 MB
  54       mem_size:
  55         description: Size of memory available to applications running on the Compute node (default unit is MB).
  56         type: scalar-unit.size
  57         required: false
  58         constraints:
  59         - greater_or_equal: 0 MB
  60
  61   tosca.capabilities.Endpoint:
  62     derived_from: tosca.capabilities.Root
  63     description: This is the default TOSCA type that should be used or extended to define a network endpoint capability. This includes the information to express a basic endpoint with a single port or a complex endpoint with multiple ports. By default the Endpoint is assumed to represent an address on a private network unless otherwise specified.
  64     properties:
  65       protocol:
  66         description: 'The name of the protocol (i.e., the protocol prefix) that the
  67           endpoint accepts (any OSI Layer 4-7 protocols). Examples: http, https, ftp,
  68           tcp, udp, etc.'
  69         type: string
  70         default: tcp
  71         required: true
  72       port:
  73         description: The optional port of the endpoint.
  74         type: tosca.datatypes.network.PortDef
  75         required: false
  76       secure:
  77         description: Requests for the endpoint to be secure and use credentials supplied on the ConnectsTo relationship.
  78         type: boolean
  79         default: false
  80         required: false
  81       url_path:
  82         description: The optional URL path of the endpoint's address if applicable for the protocol.
  83         type: string
  84         required: false
  85       port_name:
  86         description: The optional name (or ID) of the network port this endpoint should be bound to.
  87         type: string
  88         required: false
  89       network_name:
  90         description: 'The optional name (or ID) of the network this endpoint should
  91           be bound to. network_name: PRIVATE | PUBLIC | <network_name> | <network_id>.'
  92         type: string
  93         default: PRIVATE
  94         required: false
  95       initiator:
  96         description: The optional indicator of the direction of the connection.
  97         type: string
  98         default: source
  99         required: false
 100         constraints:
 101         - valid_values:
 102           - source
 103           - target
 104           - peer
 105       ports:
 106         description: The optional map of ports the Endpoint supports (if more than one).
 107         type: map
 108         entry_schema:
 109           type: tosca.datatypes.network.PortSpec
 110         required: false
 111         constraints:
 112         - min_length: 1
 113     attributes:
 114       ip_address:
 115         description: 'Note: This is the IP address as propagated up by the associated
 116           node''s host (Compute) container.'
 117         type: string
 118
 119   tosca.capabilities.Endpoint.Public:
 120     derived_from: tosca.capabilities.Endpoint
 121     description: |-
 122       This capability represents a public endpoint which is accessible to the general internet (and its public IP address ranges).
 123       This public endpoint capability also can be used to create a floating (IP) address that the underlying network assigns from a pool allocated from the application's underlying public network. This floating address is managed by the underlying network such that can be routed an application's private address and remains reliable to internet clients.
 124     properties:
 125       network_name:
 126         type: string
 127         default: PUBLIC
 128         constraints:
 129         - equal: PUBLIC
 130
 131   tosca.capabilities.Endpoint.Admin:
 132     derived_from: tosca.capabilities.Endpoint
 133     description: This is the default TOSCA type that should be used or extended to define a specialized administrator endpoint capability.
 134     properties:
 135       secure:
 136         description: Requests for the endpoint to be secure and use credentials supplied on the ConnectsTo relationship.
 137         type: boolean
 138         default: true
 139         constraints:
 140         - equal: true
 141
 142   tosca.capabilities.Endpoint.Database:
 143     derived_from: tosca.capabilities.Endpoint
 144     description: This is the default TOSCA type that should be used or extended to define a specialized database endpoint capability.
 145
 146   tosca.capabilities.Attachment:
 147     derived_from: tosca.capabilities.Root
 148     description: This is the default TOSCA type that should be used or extended to define an attachment capability of a (logical) infrastructure device node (e.g., BlockStorage node).
 149
 150   tosca.capabilities.OperatingSystem:
 151     derived_from: tosca.capabilities.Root
 152     description: This is the default TOSCA type that should be used to express an Operating System capability for a node.
 153     properties:
 154       architecture:
 155         description: 'The Operating System (OS) architecture. Examples of valid values
 156           include: x86_32, x86_64, etc.'
 157         type: string
 158         required: false
 159       type:
 160         description: 'The Operating System (OS) type. Examples of valid values include:
 161           linux, aix, mac, windows, etc.'
 162         type: string
 163         required: false
 164       distribution:
 165         description: 'The Operating System (OS) distribution. Examples of valid values
 166           for a "type" of "Linux" would include: debian, fedora, rhel and ubuntu.'
 167         type: string
 168         required: false
 169       version:
 170         description: The Operating System version.
 171         type: version
 172         required: false
 173
 174   tosca.capabilities.Scalable:
 175     derived_from: tosca.capabilities.Root
 176     description: This is the default TOSCA type that should be used to express a scalability capability for a node.
 177     properties:
 178       min_instances:
 179         description: This property is used to indicate the minimum number of instances that should be created for the associated TOSCA Node Template by a TOSCA orchestrator.
 180         type: integer
 181         default: 1
 182       max_instances:
 183         description: This property is used to indicate the maximum number of instances that should be created for the associated TOSCA Node Template by a TOSCA orchestrator.
 184         type: integer
 185         default: 1
 186       default_instances:
 187         description: 'An optional property that indicates the requested default number of instances that should be the starting number of instances a TOSCA orchestrator should attempt to allocate. Note The value for this property MUST be in
 188           the range between the values set for "min_instances" and "max_instances"
 189           properties.'
 190         type: integer
 191         required: false
 192
 193   tosca.capabilities.network.Bindable:
 194     derived_from: tosca.capabilities.Node
 195     description: A node type that includes the Bindable capability indicates that it can be bound to a logical network association via a network port.
 196
 197   tosca.capabilities.network.Linkable:
 198     derived_from: tosca.capabilities.Node
 199     description: A node type that includes the Linkable capability indicates that it can be pointed by tosca.relationships.network.LinksTo relationship type.
 200
 201   tosca.capabilities.Container.Docker:
 202     derived_from: tosca.capabilities.Container
 203     properties:
 204       version:
 205         type: list
 206         entry_schema: version
 207         required: false
 208       publish_all:
 209         type: boolean
 210         default: false
 211         required: false
 212       publish_ports:
 213         type: list
 214         entry_schema: PortSpec
 215         required: false
 216       expose_ports:
 217         type: list
 218         entry_schema: PortSpec
 219         required: false
 220       volumes:
 221         type: list
 222         entry_schema: string
 223         required: false
 224   org.openecomp.capabilities.attachment.DeploymentFlavor:
 225     derived_from: tosca.capabilities.Attachment
 226     description: The Node capability indicates the base capabilities of a TOSCA Node Type.
 227     properties:
 228       DeploymentFlavor:
 229         type: map
 230         description: Deployment flavors instance
 231         required: true
 232         status: supported
 233         entry_schema:
 234             type: org.openecomp.datatypes.DeploymentFlavor
 235
 236   org.openecomp.capabilities.metric.SnmpTrap:
 237     derived_from: org.openecomp.capabilities.Metric
 238     description: A node type that includes the Metric capability indicates that it can be monitored using snmp trap.
 239     properties:
 240       oid:
 241         description: Object Id of the metric
 242         type: string
 243         status: supported
 244         required: true
 245
 246   org.openecomp.capabilities.AllottedResource:
 247     derived_from: tosca.capabilities.Root
 248
 249   org.openecomp.capabilities.metric.SnmpPolling:
 250     derived_from: org.openecomp.capabilities.Metric
 251     description: A node type that includes the Metric capability indicates that it can be monitored using snmp polling.
 252     properties:
 253       oid:
 254         description: Object Id of the metric
 255         type: string
 256         status: supported
 257         required: true
 258
 259   org.openecomp.capabilities.metric.Ceilometer:
 260     derived_from: org.openecomp.capabilities.Metric
 261     description: A node type that includes the Metric capability indicates that it can be monitored using ceilometer.
 262     properties:
 263       name:
 264         description: Ceilometer metric type name to monitor. (The name ceilometer is using)
 265         type: string
 266         status: supported
 267         required: true
 268
 269   org.openecomp.capabilities.Metric:
 270     derived_from: tosca.capabilities.Endpoint
 271     description: A node type that includes the Metric capability indicates that it can be monitored.
 272     properties:
 273       unit:
 274         description: Unit of the metric value
 275         type: string
 276         status: supported
 277         required: true
 278       description:
 279         description: Description of the metric
 280         type: string
 281         status: supported
 282         required: false
 283       type:
 284         description: Type of the metric value, for an example, Cumulative, Delta, Gauge and etc.
 285         type: string
 286         status: supported
 287         required: true
 288       category:
 289         description: Category of the metric, for an example, compute, disk, network, storage and etc.
 290         type: string
 291         status: supported
 292         required: false
 293     attributes:
 294       value:
 295         description: Runtime monitored value
 296         type: string
 297         status: supported