[SDC-29] Amdocs OnBoard 1707 initial commit.
[sdc.git] / openecomp-be / lib / openecomp-sdc-enrichment-lib / openecomp-sdc-enrichment-impl / src / test / resources / mock / toscaGlobalServiceTemplates / tosca / capabilities.yml
1 tosca_definitions_version: tosca_simple_yaml_1_0
2 metadata:
3   filename: tosca/capabilities.yml
4   version: '1.0'
5 imports:
6 - tosca_index:
7     file: _index.yml
8 capability_types:
9   tosca.capabilities.Root:
10     description: This is the default (root) TOSCA Capability Type definition that all other TOSCA Capability Types derive from.
11   tosca.capabilities.Node:
12     derived_from: tosca.capabilities.Root
13     description: The Node capability indicates the base capabilities of a TOSCA Node Type.
14   tosca.capabilities.Container:
15     derived_from: tosca.capabilities.Root
16     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.
17     properties:
18       num_cpus:
19         type: integer
20         description: Number of (actual or virtual) CPUs associated with the Compute node.
21         required: false
22         status: SUPPORTED
23         constraints:
24         - greater_or_equal: 1
25       cpu_frequency:
26         type: scalar-unit.frequency
27         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".
28         required: false
29         status: SUPPORTED
30         constraints:
31         - greater_or_equal: 0.1 GHz
32       disk_size:
33         type: scalar-unit.size
34         description: Size of the local disk available to applications running on the Compute node (default unit is MB).
35         required: false
36         status: SUPPORTED
37         constraints:
38         - greater_or_equal: 0 MB
39       mem_size:
40         type: scalar-unit.size
41         description: Size of memory available to applications running on the Compute node (default unit is MB).
42         required: false
43         status: SUPPORTED
44         constraints:
45         - greater_or_equal: 0 MB
46   tosca.capabilities.Endpoint:
47     derived_from: tosca.capabilities.Root
48     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.
49     properties:
50       protocol:
51         type: string
52         description: 'The name of the protocol (i.e., the protocol prefix) that the
53           endpoint accepts (any OSI Layer 4-7 protocols). Examples: http, https, ftp,
54           tcp, udp, etc.'
55         required: true
56         default: tcp
57         status: SUPPORTED
58       port:
59         type: tosca.datatypes.network.PortDef
60         description: The optional port of the endpoint.
61         required: false
62         status: SUPPORTED
63       secure:
64         type: boolean
65         description: Requests for the endpoint to be secure and use credentials supplied on the ConnectsTo relationship.
66         required: false
67         default: false
68         status: SUPPORTED
69       url_path:
70         type: string
71         description: The optional URL path of the endpoint's address if applicable for the protocol.
72         required: false
73         status: SUPPORTED
74       port_name:
75         type: string
76         description: The optional name (or ID) of the network port this endpoint should be bound to.
77         required: false
78         status: SUPPORTED
79       network_name:
80         type: string
81         description: 'The optional name (or ID) of the network this endpoint should
82           be bound to. network_name: PRIVATE | PUBLIC | <network_name> | <network_id>.'
83         required: false
84         default: PRIVATE
85         status: SUPPORTED
86       initiator:
87         type: string
88         description: The optional indicator of the direction of the connection.
89         required: false
90         default: source
91         status: SUPPORTED
92         constraints:
93         - valid_values:
94           - source
95           - target
96           - peer
97       ports:
98         type: map
99         description: The optional map of ports the Endpoint supports (if more than one).
100         required: false
101         status: SUPPORTED
102         constraints:
103         - min_length: 1
104         entry_schema:
105           type: tosca.datatypes.network.PortSpec
106     attributes:
107       ip_address:
108         type: string
109         description: 'Note: This is the IP address as propagated up by the associated
110           node''s host (Compute) container.'
111         status: SUPPORTED
112   tosca.capabilities.Endpoint.Public:
113     derived_from: tosca.capabilities.Endpoint
114     description: |-
115       This capability represents a public endpoint which is accessible to the general internet (and its public IP address ranges).
116       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.
117     properties:
118       network_name:
119         type: string
120         required: true
121         default: PUBLIC
122         status: SUPPORTED
123         constraints:
124         - equal: PUBLIC
125   tosca.capabilities.Endpoint.Admin:
126     derived_from: tosca.capabilities.Endpoint
127     description: This is the default TOSCA type that should be used or extended to define a specialized administrator endpoint capability.
128     properties:
129       secure:
130         type: boolean
131         description: Requests for the endpoint to be secure and use credentials supplied on the ConnectsTo relationship.
132         required: true
133         default: true
134         status: SUPPORTED
135         constraints:
136         - equal: true
137   tosca.capabilities.Endpoint.Database:
138     derived_from: tosca.capabilities.Endpoint
139     description: This is the default TOSCA type that should be used or extended to define a specialized database endpoint capability.
140   tosca.capabilities.Attachment:
141     derived_from: tosca.capabilities.Root
142     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).
143   tosca.capabilities.OperatingSystem:
144     derived_from: tosca.capabilities.Root
145     description: This is the default TOSCA type that should be used to express an Operating System capability for a node.
146     properties:
147       architecture:
148         type: string
149         description: 'The Operating System (OS) architecture. Examples of valid values
150           include: x86_32, x86_64, etc.'
151         required: false
152         status: SUPPORTED
153       type:
154         type: string
155         description: 'The Operating System (OS) type. Examples of valid values include:
156           linux, aix, mac, windows, etc.'
157         required: false
158         status: SUPPORTED
159       distribution:
160         type: string
161         description: 'The Operating System (OS) distribution. Examples of valid values
162           for a "type" of "Linux" would include: debian, fedora, rhel and ubuntu.'
163         required: false
164         status: SUPPORTED
165       version:
166         type: version
167         description: The Operating System version.
168         required: false
169         status: SUPPORTED
170   tosca.capabilities.Scalable:
171     derived_from: tosca.capabilities.Root
172     description: This is the default TOSCA type that should be used to express a scalability capability for a node.
173     properties:
174       min_instances:
175         type: integer
176         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.
177         required: true
178         default: 1
179         status: SUPPORTED
180       max_instances:
181         type: integer
182         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.
183         required: true
184         default: 1
185         status: SUPPORTED
186       default_instances:
187         type: integer
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"
192           properties.'
193         required: false
194         status: SUPPORTED
195   tosca.capabilities.network.Bindable:
196     derived_from: tosca.capabilities.Node
197     description: A node type that includes the Bindable capability indicates that it can be bound to a logical network association via a network port.
198   tosca.capabilities.network.Linkable:
199     derived_from: tosca.capabilities.Node
200     description: A node type that includes the Linkable capability indicates that it can be pointed by tosca.relationships.network.LinksTo relationship type.
201   tosca.capabilities.Container.Docker:
202     derived_from: tosca.capabilities.Container
203     properties:
204       version:
205         type: list
206         required: false
207         status: SUPPORTED
208         entry_schema:
209           type: version
210       publish_all:
211         type: boolean
212         required: false
213         default: false
214         status: SUPPORTED
215       publish_ports:
216         type: list
217         required: false
218         status: SUPPORTED
219         entry_schema:
220           type: PortSpec
221       expose_ports:
222         type: list
223         required: false
224         status: SUPPORTED
225         entry_schema:
226           type: PortSpec
227       volumes:
228         type: list
229         required: false
230         status: SUPPORTED
231         entry_schema:
232           type: string