catalog-be/src/main/resources/import/tosca/capability-types/capabilityTypes.yml

   1 tosca.capabilities.Root:
   2   description: The TOSCA root Capability Type all other TOSCA base Capability Types derive from
   3 tosca.capabilities.Attachment:
   4   derived_from: tosca.capabilities.Root
   5 tosca.capabilities.Node:
   6   derived_from: tosca.capabilities.Root
   7 tosca.capabilities.Container:
   8   derived_from: tosca.capabilities.Root
   9   properties:
  10     num_cpus:
  11       type: integer
  12       required: false
  13       constraints:
  14         - greater_or_equal: 1
  15     cpu_frequency:
  16       type: scalar-unit.frequency
  17       required: false
  18       constraints:
  19         - greater_or_equal: 0.1 GHz
  20     disk_size:
  21       type: scalar-unit.size
  22       required: false
  23       constraints:
  24         - greater_or_equal: 0 MB
  25     mem_size:
  26       type: scalar-unit.size
  27       required: false
  28       constraints:
  29         - greater_or_equal: 0 MB
  30 org.openecomp.capabilities.PortMirroring:
  31   derived_from: tosca.capabilities.Root
  32   properties:
  33     connection_point:
  34         type: org.openecomp.datatypes.PortMirroringConnectionPointDescription
  35 tosca.capabilities.Endpoint:
  36   derived_from: tosca.capabilities.Root
  37   properties:
  38     protocol:
  39       type: string
  40       default: tcp
  41     port:
  42       type: PortDef
  43       required: false
  44     secure:
  45       type: boolean
  46       default: false
  47     url_path:
  48       type: string
  49       required: false
  50     port_name:
  51       type: string
  52       required: false
  53     network_name:
  54       type: string
  55       required: false
  56       default: PRIVATE
  57     initiator:
  58       type: string
  59       default: source
  60       constraints:
  61         - valid_values: [ source, target, peer ]
  62     ports:
  63       type: map
  64       required: false
  65       constraints:
  66         - min_length: 1
  67       entry_schema:
  68         type: PortSpec
  69   attributes:
  70     ip_address:
  71       type: string
  72 tosca.capabilities.DatabaseEndpoint:
  73   derived_from: tosca.capabilities.Endpoint
  74 tosca.capabilities.Endpoint.Public:
  75   derived_from: tosca.capabilities.Endpoint
  76   properties:
  77     # Change the default network_name to use the first public network found
  78     network_name: PUBLIC
  79     floating:
  80       description: >
  81         indicates that the public address should be allocated from a pool of floating IPs that are associated with the network.
  82       type: boolean
  83       default: false
  84       status: experimental
  85     dns_name:
  86       description: The optional name to register with DNS
  87       type: string
  88       required: false
  89       status: experimental
  90 tosca.capabilities.Endpoint.Admin:
  91   derived_from: tosca.capabilities.Endpoint
  92   # Change Endpoint secure indicator to true from its default of false
  93   properties:
  94     secure: true
  95 tosca.capabilities.Endpoint.Database:
  96   derived_from: tosca.capabilities.Endpoint
  97 tosca.capabilities.OperatingSystem:
  98   derived_from: tosca.capabilities.Root
  99   properties:
 100     architecture:
 101       type: string
 102       required: false
 103     type:
 104       type: string
 105       required: false
 106     distribution:
 107       type: string
 108       required: false
 109     version:
 110       type: version
 111       required: false
 112 tosca.capabilities.Scalable:
 113   derived_from: tosca.capabilities.Root
 114   properties:
 115     min_instances:
 116       type: integer
 117       default: 1
 118     max_instances:
 119       type: integer
 120       default: 1
 121     default_instances:
 122       type: integer
 123 tosca.capabilities.network.Bindable:
 124   derived_from: tosca.capabilities.Node
 125
 126
 127 tosca.capabilities.Container.Docker:
 128   derived_from: tosca.capabilities.Container
 129   properties:
 130     version:
 131       type: list
 132       required: false
 133       entry_schema: version
 134     publish_all:
 135       type: boolean
 136       default: false
 137       required: false
 138     publish_ports:
 139       type: list
 140       entry_schema: PortSpec
 141       required: false
 142     expose_ports:
 143       type: list
 144       entry_schema: PortSpec
 145       required: false
 146     volumes:
 147       type: list
 148       entry_schema: string
 149       required: false
 150 tosca.capabilities.network.Linkable:
 151   derived_from: tosca.capabilities.Root
 152 org.openecomp.capabilities.AllottedResource:
 153   derived_from: tosca.capabilities.Root
 154 tosca.capabilities.nfv.Metric:
 155   derived_from: tosca.capabilities.Endpoint
 156 org.openecomp.capabilities.Metric:
 157   derived_from: tosca.capabilities.nfv.Metric
 158   description: A node type that includes the Metric capability indicates that it can be monitored.
 159   properties:
 160     unit:
 161       type: string
 162       description: Unit of the metric value
 163       required: true
 164       status: supported
 165     description:
 166       type: string
 167       description: Description of the metric
 168       required: false
 169       status: supported
 170     type:
 171       type: string
 172       description: Type of the metric value, for an example, Cumulative, Delta, Gauge and etc.
 173       required: true
 174       status: supported
 175     category:
 176       type: string
 177       description: Category of the metric, for an example, compute, disk, network, storage and etc.
 178       required: false
 179       status: supported
 180   attributes:
 181     value:
 182       type: string
 183       description: Runtime monitored value
 184       status: supported
 185 org.openecomp.capabilities.metric.Ceilometer:
 186   derived_from: org.openecomp.capabilities.Metric
 187   description: A node type that includes the Metric capability indicates that it can be monitored using ceilometer.
 188   properties:
 189     name:
 190       type: string
 191       description: Ceilometer metric type name to monitor. (The name ceilometer is using)
 192       required: true
 193       status: supported
 194 org.openecomp.capabilities.metric.SnmpPolling:
 195   derived_from: org.openecomp.capabilities.Metric
 196   description: A node type that includes the Metric capability indicates that it can be monitored using snmp polling.
 197   properties:
 198     oid:
 199       type: string
 200       description: Object Id of the metric
 201       required: true
 202       status: supported
 203 org.openecomp.capabilities.metric.SnmpTrap:
 204   derived_from: org.openecomp.capabilities.Metric
 205   description: A node type that includes the Metric capability indicates that it can be monitored using snmp trap.
 206   properties:
 207     oid:
 208       type: string
 209       description: Object Id of the metric
 210       required: true
 211       status: supported
 212 org.openecomp.capabilities.Forwarder:
 213   derived_from: tosca.capabilities.Root
 214 org.openecomp.capabilities.VLANAssignment:
 215   derived_from: tosca.capabilities.Root
 216   description: ability to expose routing information of the internal network
 217   properties:
 218     vfc_instance_group_reference:
 219       type: string
 220       description: Ability to recognize capability per vfc instance group on vnf instance
 221       required: true
 222 org.openecomp.capabilities.RoutingConfiguration:
 223   derived_from: tosca.capabilities.Root
 224 org.openecomp.capabilities.FabricConfiguration:
 225   derived_from: tosca.capabilities.Root
 226
 227 #ONAP types
 228 tosca.capabilities.nfv.VirtualStorage:
 229   derived_from: tosca.capabilities.Root
 230   description: Describes the attachment capabilities related to Vdu.Storage
 231 tosca.capabilities.nfv.VirtualCompute:
 232   derived_from: tosca.capabilities.Node
 233   description: Describes the capabilities related to virtual compute resources
 234   properties:
 235     logical_node:
 236       type: map
 237       description: Describes the Logical Node requirements
 238       required: false
 239       entry_schema:
 240         type: tosca.datatypes.nfv.LogicalNodeData
 241     requested_additional_capabilities:
 242       type: map
 243       description: Describes additional capability for a particular VDU
 244       required: false
 245       entry_schema:
 246         type: tosca.datatypes.nfv.RequestedAdditionalCapability
 247     compute_requirements:
 248       type: map
 249       required: false
 250       entry_schema:
 251         type: string
 252     virtual_memory:
 253       type: tosca.datatypes.nfv.VirtualMemory
 254       description: Describes virtual memory of the virtualized compute
 255       required: true
 256     virtual_cpu:
 257       type: tosca.datatypes.nfv.VirtualCpu
 258       description: Describes virtual CPU(s) of the virtualized compute
 259       required: true
 260     virtual_local_storage:
 261       type: list
 262       description: A list of virtual system disks created and destroyed as part of the VM lifecycle
 263       required: false
 264       entry_schema:
 265         type: tosca.datatypes.nfv.VirtualBlockStorageData
 266         description: virtual system disk definition
 267 tosca.capabilities.nfv.VirtualBindable:
 268   derived_from: tosca.capabilities.Node
 269   description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.VirtualBindsTo relationship type which is used to model the VduHasCpd association
 270 tosca.capabilities.nfv.VirtualLinkable:
 271   derived_from: tosca.capabilities.Root
 272   description: A node type that includes the VirtualLinkable capability indicates that it can be pointed by tosca.relationships.nfv.VirtualLinksTo relationship type
 273 tosca.capabilities.nfv.ExtVirtualLinkable:
 274   derived_from: tosca.capabilities.Root
 275 tosca.capabilities.nfv.Forwarder:
 276   derived_from: tosca.capabilities.Root
 277 tosca.capabilities.nfv.ext.GuestOs:
 278   derived_from: tosca.capabilities.Root
 279 tosca.capabilities.nfv.ext.ImageFile:
 280   derived_from: tosca.capabilities.Root
 281 tosca.capabilities.nfv.ext.LocalAttachment:
 282   derived_from: tosca.capabilities.Root
 283 tosca.capabilities.nfv.ext.Compute.Container.Architecture:
 284   derived_from: tosca.capabilities.Root
 285   properties:
 286     num_cpus:
 287       type: string
 288       required: false
 289     flavor_extra_specs:
 290       type: map
 291       required: false
 292       entry_schema:
 293         type: string
 294     mem_size:
 295       type: string
 296       required: false
 297 tosca.capabilities.nfv.Forwarding:
 298   derived_from: tosca.capabilities.Root
 299