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
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 tosca_definitions_version: tosca_simple_yaml_1_0
18 filename: tosca/capabilities.yml
26 tosca.capabilities.Root:
27 description: This is the default (root) TOSCA Capability Type definition that all other TOSCA Capability Types derive from.
29 tosca.capabilities.Node:
30 derived_from: tosca.capabilities.Root
31 description: The Node capability indicates the base capabilities of a TOSCA Node Type.
33 tosca.capabilities.Container:
34 derived_from: tosca.capabilities.Root
35 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.
38 description: Number of (actual or virtual) CPUs associated with the Compute node.
44 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".
45 type: scalar-unit.frequency
48 - greater_or_equal: 0.1 GHz
50 description: Size of the local disk available to applications running on the Compute node (default unit is MB).
51 type: scalar-unit.size
54 - greater_or_equal: 0 MB
56 description: Size of memory available to applications running on the Compute node (default unit is MB).
57 type: scalar-unit.size
60 - greater_or_equal: 0 MB
62 tosca.capabilities.Endpoint:
63 derived_from: tosca.capabilities.Root
64 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.
67 description: 'The name of the protocol (i.e., the protocol prefix) that the
68 endpoint accepts (any OSI Layer 4-7 protocols). Examples: http, https, ftp,
74 description: The optional port of the endpoint.
75 type: tosca.datatypes.network.PortDef
78 description: Requests for the endpoint to be secure and use credentials supplied on the ConnectsTo relationship.
83 description: The optional URL path of the endpoint's address if applicable for the protocol.
87 description: The optional name (or ID) of the network port this endpoint should be bound to.
91 description: 'The optional name (or ID) of the network this endpoint should
92 be bound to. network_name: PRIVATE | PUBLIC | <network_name> | <network_id>.'
97 description: The optional indicator of the direction of the connection.
107 description: The optional map of ports the Endpoint supports (if more than one).
110 type: tosca.datatypes.network.PortSpec
116 description: 'Note: This is the IP address as propagated up by the associated
117 node''s host (Compute) container.'
120 tosca.capabilities.Endpoint.Public:
121 derived_from: tosca.capabilities.Endpoint
123 This capability represents a public endpoint which is accessible to the general internet (and its public IP address ranges).
124 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.
132 tosca.capabilities.Endpoint.Admin:
133 derived_from: tosca.capabilities.Endpoint
134 description: This is the default TOSCA type that should be used or extended to define a specialized administrator endpoint capability.
137 description: Requests for the endpoint to be secure and use credentials supplied on the ConnectsTo relationship.
143 tosca.capabilities.Endpoint.Database:
144 derived_from: tosca.capabilities.Endpoint
145 description: This is the default TOSCA type that should be used or extended to define a specialized database endpoint capability.
147 tosca.capabilities.Attachment:
148 derived_from: tosca.capabilities.Root
149 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).
151 tosca.capabilities.OperatingSystem:
152 derived_from: tosca.capabilities.Root
153 description: This is the default TOSCA type that should be used to express an Operating System capability for a node.
156 description: 'The Operating System (OS) architecture. Examples of valid values
157 include: x86_32, x86_64, etc.'
161 description: 'The Operating System (OS) type. Examples of valid values include:
162 linux, aix, mac, windows, etc.'
166 description: 'The Operating System (OS) distribution. Examples of valid values
167 for a "type" of "Linux" would include: debian, fedora, rhel and ubuntu.'
171 description: The Operating System version.
175 tosca.capabilities.Scalable:
176 derived_from: tosca.capabilities.Root
177 description: This is the default TOSCA type that should be used to express a scalability capability for a node.
180 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.
184 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.
188 description: 'An optional property that indicates the requested default number
189 of instances that should be the starting number of instances a TOSCA orchestrator
190 should attempt to allocate. Note: The value for this property MUST be in
191 the range between the values set for "min_instances" and "max_instances"
196 tosca.capabilities.network.Bindable:
197 derived_from: tosca.capabilities.Node
198 description: A node type that includes the Bindable capability indicates that it can be bound to a logical network association via a network port.
200 tosca.capabilities.network.Linkable:
201 derived_from: tosca.capabilities.Node
202 description: A node type that includes the Linkable capability indicates that it can be pointed by tosca.relationships.network.LinksTo relationship type.
204 tosca.capabilities.Container.Docker:
205 derived_from: tosca.capabilities.Container