Gitiles
Code Review Sign In
gerrit.opencord.org / monitoring / eb0d11c7455b5ad98f6d8228cf687e7c9277bb2e / . / xos / monitoring_tosca_types.yaml
blob: 8b24efbc45370db185307ef7811f8fcc276b754c [file] [log] [blame]
Matteo Scandoloeb0d11c2017-08-08 13:05:26 -0700[diff] [blame^]1
2# Copyright 2017-present Open Networking Foundation
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
16
rdudyala996d70b2016-10-13 17:40:55 +0000[diff] [blame]17tosca_definitions_version: tosca_simple_yaml_1_0
18
19# compile this with "m4 monitoring_custom_tosca_types.m4 > monitoring_custom_tosca_types.yaml"
20
21# include macros
22# Note: Tosca derived_from isn't working the way I think it should, it's not
23# inheriting from the parent template. Until we get that figured out, use
24# m4 macros do our inheritance
25
26
27# Service
28
29
30# Subscriber
31
32
33
34
35# end m4 macros
36
37
38
39node_types:
40 tosca.nodes.SFlowService:
41 derived_from: tosca.nodes.Root
42 description: >
43 XOS SFlow Collection Service
44 capabilities:
45 scalable:
46 type: tosca.capabilities.Scalable
47 service:
48 type: tosca.capabilities.xos.Service
49 properties:
50 no-delete:
51 type: boolean
52 default: false
53 description: Do not allow Tosca to delete this object
54 no-create:
55 type: boolean
56 default: false
57 description: Do not allow Tosca to create this object
58 no-update:
59 type: boolean
60 default: false
61 description: Do not allow Tosca to update this object
62 kind:
63 type: string
64 default: generic
65 description: Type of service.
66 view_url:
67 type: string
68 required: false
69 description: URL to follow when icon is clicked in the Service Directory.
70 icon_url:
71 type: string
72 required: false
73 description: ICON to display in the Service Directory.
74 enabled:
75 type: boolean
76 default: true
77 published:
78 type: boolean
79 default: true
80 description: If True then display this Service in the Service Directory.
81 public_key:
82 type: string
83 required: false
84 description: Public key to install into Instances to allows Services to SSH into them.
85 private_key_fn:
86 type: string
87 required: false
88 description: Location of private key file
89 versionNumber:
90 type: string
91 required: false
92 description: Version number of Service.
93 sflow_port:
94 type: integer
95 required: false
96 default: 6343
97 description: sFlow listening port
98 sflow_api_port:
99 type: integer
100 required: false
101 default: 33333
102 description: sFlow publish subscribe api listening port
103
104 tosca.nodes.CeilometerService:
105 derived_from: tosca.nodes.Root
106 description: >
107 XOS Ceilometer Service
108 capabilities:
109 scalable:
110 type: tosca.capabilities.Scalable
111 service:
112 type: tosca.capabilities.xos.Service
113 properties:
114 no-delete:
115 type: boolean
116 default: false
117 description: Do not allow Tosca to delete this object
118 no-create:
119 type: boolean
120 default: false
121 description: Do not allow Tosca to create this object
122 no-update:
123 type: boolean
124 default: false
125 description: Do not allow Tosca to update this object
126 kind:
127 type: string
128 default: generic
129 description: Type of service.
130 view_url:
131 type: string
132 required: false
133 description: URL to follow when icon is clicked in the Service Directory.
134 icon_url:
135 type: string
136 required: false
137 description: ICON to display in the Service Directory.
138 enabled:
139 type: boolean
140 default: true
141 published:
142 type: boolean
143 default: true
144 description: If True then display this Service in the Service Directory.
145 public_key:
146 type: string
147 required: false
148 description: Public key to install into Instances to allows Services to SSH into them.
149 private_key_fn:
150 type: string
151 required: false
152 description: Location of private key file
153 versionNumber:
154 type: string
155 required: false
156 description: Version number of Service.
157 ceilometer_pub_sub_url:
158 type: string
159 required: false
Srikanth Vavilapalli71aa28d2017-01-31 00:43:13 +0000[diff] [blame]160 description: Deprecated....REST URL of ceilometer PUB/SUB component
161 ceilometer_enable_pub_sub:
162 type: boolean
163 default: false
164 required: false
165 description: If True then ceilometer PUB/SUB feature will be enabled.
rdudyala996d70b2016-10-13 17:40:55 +0000[diff] [blame]166
167 tosca.nodes.CeilometerTenant:
168 derived_from: tosca.nodes.Root
169 description: >
170 CORD: A Tenant of the Ceilometer Service.
171 properties:
172 kind:
173 type: string
174 default: generic
175 description: Kind of tenant
176
177 tosca.nodes.InfraMonitoringAgentInfo:
178 derived_from: tosca.nodes.Root
179 description: >
180 Infra Monitoring agent info
181 capabilities:
182 inframonitoringagentinfo:
183 type: tosca.capabilities.xos.InfraMonitoringAgentInfo
184 properties:
185 start_url:
186 type: string
187 required: true
188 description: REST URL to be invoked to start monitoring agent
189 start_url_json_data:
190 type: string
191 required: false
192 description: Meta data to be sent along with start API
193 stop_url:
194 type: string
195 required: true
196 description: REST URL to be invoked to stop monitoring agent
197
198 tosca.relationships.ProvidesInfraMonitoringAgentInfo:
199 derived_from: tosca.relationships.Root
200 valid_target_types: [ tosca.capabilities.xos.InfraMonitoringAgentInfo ]
201
202 tosca.capabilities.xos.InfraMonitoringAgentInfo:
203 derived_from: tosca.capabilities.Root
204 description: An XOS Infra MonitoringAgentInfo
205
206 tosca.nodes.MonitoringCollectorPluginInfo:
207 derived_from: tosca.nodes.Root
208 description: >
209 Monitoring collector plugin info
210 capabilities:
211 monitoringcollectorplugininfo:
212 type: tosca.capabilities.xos.MonitoringCollectorPluginInfo
213 properties:
214 plugin_folder_path:
215 type: string
216 required: true
217 description: Folder path pointing to plugin files.
218 plugin_rabbit_exchange:
219 type: string
220 required: true
221 description: RabbitMQ exchange used by Monitoring collector notification plugin
222
223 tosca.relationships.ProvidesMonitoringCollectorPluginInfo:
224 derived_from: tosca.relationships.Root
225 valid_target_types: [ tosca.capabilities.xos.MonitoringCollectorPluginInfo ]
226
227 tosca.capabilities.xos.MonitoringCollectorPluginInfo:
228 derived_from: tosca.capabilities.Root
229 description: An XOS MonitoringCollectorPluginInfo
230
231 tosca.nodes.OpenStackMonitoringPublisher:
232 derived_from: tosca.nodes.Root
233 description: >
234 A OpenStack Publish Tenant of the Monitoring service
235 properties:
236 kind:
237 type: string
238 default: generic
239 description: Kind of tenant
240
241 tosca.nodes.ONOSMonitoringPublisher:
242 derived_from: tosca.nodes.Root
243 description: >
244 A ONOS Publish Tenant of the Monitoring service
245 properties:
246 kind:
247 type: string
248 default: generic
249 description: Kind of tenant
250
251 tosca.relationships.PublishesMonitoringData:
252 derived_from: tosca.relationships.Root
253 valid_target_types: [ tosca.capabilities.xos.Service ]
254
255 tosca.nodes.UserServiceMonitoringPublisher:
256 derived_from: tosca.nodes.Root
257 description: >
258 A Publish Tenant of the Monitoring service user defined services
259 properties:
260 kind:
261 type: string
262 default: generic
263 description: Kind of tenant
264