7d92a0884792f32cb16954f1a12ff8f9d5221c5f
[policy/clamp.git] /
1 tosca_definitions_version: tosca_simple_yaml_1_3
2 policy_types:
3    onap.policies.Monitoring:
4       derived_from: tosca.policies.Root
5       version: 1.0.0
6       name: onap.policies.Monitoring
7       description: a base policy type for all policies that govern monitoring provisioning
8    onap.policies.monitoring.dcae-pm-subscription-handler:
9       derived_from: onap.policies.Monitoring
10       version: 1.0.0
11       properties:
12          subscription:
13             type: map
14             description: PM Subscription Handler Subscription
15             entry_schema:
16                type: onap.datatypes.monitoring.subscription
17 data_types:
18    onap.datatypes.monitoring.subscription:
19       derived_from: tosca.datatypes.Root
20       properties:
21          subscriptionName:
22             type: string
23             description: Name of the subscription
24             required: true
25          administrativeState:
26             type: string
27             description: State of the subscription
28             required: true
29             constraints:
30             -  valid_values:
31                - LOCKED
32                - UNLOCKED
33          fileBasedGP:
34             type: integer
35             description: File based granularity period
36             required: true
37          fileLocation:
38             type: string
39             description: ROP file location
40             required: true
41          nfTypeModelInvariantId:
42             type: string
43             description: Network function invariant ID
44             required: true
45          nfFilter:
46             type: map
47             description: Network function filter
48             required: true
49             entry_schema:
50                type: onap.datatypes.monitoring.nfFilter
51          measurementGroups:
52             type: list
53             description: Measurement Groups
54             required: true
55             entry_schema:
56                type: onap.datatypes.monitoring.measurementGroups
57    onap.datatypes.monitoring.nfFilter:
58       derived_from: tosca.datatypes.Root
59       properties:
60          nfNames:
61             type: list
62             description: List of network functions
63             required: true
64             #default: []
65             entry_schema:
66                type: string
67          swVersions:
68             type: list
69             description: List of software versions
70             required: true
71             #default: []
72             entry_schema:
73                type: string
74    onap.datatypes.monitoring.measurementGroups:
75       derived_from: tosca.datatypes.Root
76       properties:
77          measurementGroup:
78             type: map
79             description: Measurement Group
80             required: true
81             entry_schema:
82                type: onap.datatypes.monitoring.measurementGroup
83    onap.datatypes.monitoring.measurementGroup:
84       derived_from: tosca.datatypes.Root
85       properties:
86          measurementTypes:
87             type: list
88             description: List of measurement types
89             required: true
90             #default: []
91             entry_schema:
92                type: onap.datatypes.monitoring.measurementTypes
93          managedObjectDNsBasic:
94             type: list
95             description: List of managed object distinguished names
96             required: true
97             #default: []
98             entry_schema:
99                type: onap.datatypes.monitoring.managedObjectDNsBasics
100    onap.datatypes.monitoring.measurementTypes:
101       derived_from: tosca.datatypes.Root
102       properties:
103          measurementType:
104             type: map
105             description: Measurement type object
106             required: true
107             entry_schema:
108                type: onap.datatypes.monitoring.measurementType
109    onap.datatypes.monitoring.measurementType:
110       derived_from: tosca.datatypes.Root
111       properties:
112          measurementType:
113             type: string
114             description: Measurement type
115             required: true
116    onap.datatypes.monitoring.managedObjectDNsBasics:
117       derived_from: tosca.datatypes.Root
118       properties:
119          managedObjectDNsBasic:
120             type: map
121             description: Managed object distinguished name object
122             required: true
123             entry_schema:
124                type: onap.datatypes.monitoring.managedObjectDNsBasic
125    onap.datatypes.monitoring.managedObjectDNsBasic:
126       derived_from: tosca.datatypes.Root
127       properties:
128          DN:
129             type: string
130             description: Managed object distinguished name
131             required: true
132 capability_types:
133   org.onap.EventProducer:
134     properties:
135       carrier_protocol_type:
136         type: string
137         required: true
138         constraints:
139         - valid_values:
140           - DMAAP_message_router
141           - SOMETHING_ELSE
142           - REST
143       data_format:
144         type: string
145         required: true
146         constraints:
147         - valid_values:
148           - JSON
149           - YAML
150           - JMS
151       event_format:
152         type: string
153         required: true
154       event_format_version:
155         type: string
156         required: false
157       config_keys:
158         type: list
159         required: false
160         entry_schema:
161           type: string
162           constraints:
163           - valid_values:
164             - all valid values should be added here
165             - if not specified, events of any config key may be generated
166             - 'examples for config_key: ves-measurement, ves-syslog, tca_handle_out,
167               etc.'
168     version: 0.0.1
169     derived_from: tosca.capabilities.Root
170   org.onap.EventConsumer:
171     properties:
172       responding_capability:
173         type: string
174         required: false
175       carrier_protocol_type:
176         type: string
177         required: true
178         constraints:
179         - valid_values:
180           - DMAAP_message_router
181           - SOMETHING_ELSE
182           - REST
183       data_format:
184         type: string
185         required: true
186         constraints:
187         - valid_values:
188           - JSON
189           - YAML
190           - JMS
191           - all valid values should be added here
192       event_format:
193         type: string
194         description: 'examples for event_format: Ves_specification, LinkUp, VnfConfigured,
195           etc.'
196         required: true
197       event_format_version:
198         type: string
199         description: 'examples for event_format_version: 5.28.4, 7.30.1, etc.'
200         required: false
201       config_keys:
202         type: list
203         required: false
204         entry_schema:
205           type: string
206           constraints:
207           - valid_values:
208             - all valid values should be added here
209             - if not specified, events of any config key may be generated
210             - 'examples for config_key: ves-measurement, ves-syslog, tca_handle_out,
211               etc.'
212     version: 0.0.1
213     derived_from: tosca.capabilities.Root
214 node_types:
215   org.onap.DynamicConfig:
216     properties:
217       application_name:
218         type: string
219         description: Value used to tie the config to an application ? should we be
220           using a relationship here instead?
221         required: true
222       application_version:
223         type: string
224         required: true
225       application_provider:
226         type: string
227         required: false
228       data_types:
229         type: object
230         required: false
231       schema:
232         type: object
233         required: false
234     version: 0.0.1
235     derived_from: tosca.nodes.Root
236   org.onap.APP:
237     properties:
238       application_name:
239         type: string
240         description: Human readable name for the application Product
241         required: false
242       provider:
243         type: string
244         description: Provider of the application and of the descriptor
245         required: true
246       application_version:
247         type: string
248         description: Software version of the application
249         required: true
250       blueprint_id:
251         type: string
252         description: A reference to the app blueprint
253         required: false
254       monitoring_policy:
255         type: string
256         description: A reference to the monitoring policy
257         required: false
258     requirements:
259     - receive:
260         capability: org.onap.EventProducer
261         relationship: org.onap.PropagateEvent
262         occurrences:
263         - 0.0
264         - UNBOUNDED
265         type: string
266         type_version: 0.0.0
267         version: 0.0.0
268     - send:
269         capability: org.onap.EventConsumer
270         relationship: org.onap.PropagateEvent
271         occurrences:
272         - 0.0
273         - UNBOUNDED
274         type: string
275         type_version: 0.0.0
276         version: 0.0.0
277     version: 0.0.1
278     derived_from: tosca.nodes.Root
279   org.onap.EventRelay:
280     properties:
281       event_format:
282         type: string
283         description: 'examples for event_format: Ves_specification, etc.'
284         required: true
285       event_format_version:
286         type: string
287         description: 'examples for event_format_version: 5.28.4, 7.30.1, etc.'
288         required: true
289       config_keys:
290         type: list
291         required: false
292         entry_schema:
293           type: string
294           constraints:
295           - valid_values:
296             - all valid values should be added here
297             - if not specified, events of any config key is relayed
298             - 'examples for config_key: ves-measurement, ves-syslog, tca_handle_out,
299               etc.'
300       supported_carrier_protocols:
301         type: map
302         description: 'A map describing supported carrier protocols and translations.
303           The tuples define what protocol combinations are supported on the producer
304           and consumer side: e.g. { REST: REST, DMAAP: REST, DMAAP: DMAAP}'
305         required: true
306         key_schema:
307           type: string
308           constraints:
309           - valid_values:
310             - DMAAP_message_router
311             - SOMETHING_ELSE
312             - REST
313             - all valid values should be added here
314         entry_schema:
315           type: string
316           constraints:
317           - valid_values:
318             - DMAAP_message_router
319             - SOMETHING_ELSE
320             - REST
321             - all valid values should be added here
322       supported_data_formats:
323         type: map
324         description: 'Is a map describing supported data formats and translation.
325           The tuples define what protocol combinations are supported on the producer
326           and consumer side: e.g. { JSON: JSON, JMS: JSON, YAML:YAML }'
327         required: true
328         key_schema:
329           type: string
330           constraints:
331           - valid_values:
332             - JSON
333             - JMS
334             - YAML
335             - etc
336             - all valid values should be added here
337         entry_schema:
338           type: string
339           constraints:
340           - valid_values:
341             - JSON
342             - JMS
343             - YAML
344             - etc
345             - all valid values should be added here
346     requirements:
347     - receive:
348         capability: org.onap.EventProducer
349         relationship: org.onap.PropagateEvent
350         occurrences:
351         - 0.0
352         - UNBOUNDED
353         type: string
354         type_version: 0.0.0
355         version: 0.0.0
356     - send:
357         capability: org.onap.EventConsumer
358         relationship: org.onap.PropagateEvent
359         occurrences:
360         - 0.0
361         - UNBOUNDED
362         type: string
363         type_version: 0.0.0
364         version: 0.0.0
365     version: 0.0.1
366     derived_from: tosca.nodes.Root
367 relationship_types:
368   org.onap.PropagateEvent:
369     properties:
370       config_keys:
371         type: list
372         description: The relationship type used on requirements to org.onap.EventProducer
373           and org.onap.EventConsumer capabilities. Filters events by specific config_keys
374           to be transferred by this relationship. That is, any event with a specific
375           config_key found in the list is transferred. If list is not defined or is
376           empty, events with all config_keys are transferred.
377         required: false
378         entry_schema:
379           type: string
380     version: 0.0.1
381     derived_from: tosca.relationships.Root
382 topology_template:
383   inputs:
384     pm_subscription_topic:
385       type: string
386     pm_subscription_response_topic:
387       type: string
388     pm_subscription_handler_blueprint_id:
389       type: string
390     pm_subscription_operational_policy_id:
391       type: string
392     pm_subscription_cds_blueprint_id:
393       type: string
394     enable_tls:
395       type: string
396   node_templates:
397     org.onap.PM_Subscription_Handler:
398       type: org.onap.APP
399       type_version: 0.0.0
400       properties:
401         application_name: PM Subscription Handler
402         provider: Ericsson
403         application_version: 1.0.0
404         artifact_id:
405           get_input: pm_subscription_handler_blueprint_id
406           description: Is this a reference to the DCAE Cloudify Blueprint that is
407             already stored(or will be stored before CL configuration & instatiation)
408             in DCAE Inventory?
409         artifact_config:
410           enable_tls:
411             get_input: enable_tls
412           pmsh_publish_topic_name:
413             get_input: pm_subscription_topic
414       capabilities:
415         pm-subscription-event-publisher:
416           properties:
417             carrier_protocol_type: DMAAP_message_router
418             data_format: JSON
419             event_format: pm-subscription-event-format
420             event_format_version: 1.0.0
421           attributes:
422             type: org.onap.EventProducer
423           occurrences:
424           - 0.0
425           - UNBOUNDED
426           type: string
427           type_version: 0.0.0
428           version: 0.0.0
429         pm-subscription-event-receiver:
430           properties:
431             carrier_protocol_type: DMAAP_message_router
432             data_format: JSON
433             event_format: pm-subscription-event-response-format
434             event_format_version: 1.0.0
435             relationships:
436             - type: tosca.relationships.DependsOn
437             - description: any ideas on a better realtionship ? or is it better to
438                 just use the root realtionship ?
439             - target: org.onap.PM_Monitoring_Policy
440           attributes:
441             type: org.onap.EventConsumer
442           occurrences:
443           - 0.0
444           - UNBOUNDED
445           type: string
446           type_version: 0.0.0
447           version: 0.0.0
448       version: 0.0.0
449     org.onap.PM_Monitoring_Policy:
450       type: org.onap.DynamicConfig
451       type_version: 0.0.0
452       properties:
453         application_name: PM Subscription Handler
454         application_version: 1.0.0
455         provider: Ericsson
456         data_types:
457           measurementType:
458             type: string
459           DN:
460             type: string
461           nfFilter:
462             properties:
463               nfNames:
464                 type: list
465                 entry_schema: string
466               modelInvariantIDs:
467                 type: list
468                 entry_schema:
469                   type: string
470               modelVersionIDs:
471                 type: list
472                 entry_schema:
473                   type: string
474           measurementGroup:
475             properties:
476               masurementTypes:
477                 type: list
478                 entry_schema:
479                   type: measurementType
480               managedObjectDNsBasic:
481                 type: list
482                 entry_schema:
483                   type: DN
484         schema:
485           subscription:
486             subscriptionName:
487               type: string
488               required: true
489             administrativeState:
490               type: string
491               required: true
492             filebasedGP:
493               type: integer
494               required: true
495             fileLocation:
496               type: string
497               required: true
498             nfFilter:
499               type: nfFilter
500             measurementGroups:
501               type: list
502               entry_schema:
503                 type: measurementGroup
504       version: 0.0.0
505       description: Should I be showing a dependency between PM Subscription Handler
506         and the PM Monitoring Policy
507     org.onap.PM_Policy:
508       type: org.onap.APP
509       type_version: 0.0.0
510       properties:
511         application_name: PM Subscription Operational Policy
512         provider: Ericsson
513         application_version: 1.0.0
514         artifact_id:
515           get_input: pm_subscription_operational_policy_id
516         artifact_config: NOT_DEFINED
517       requirements:
518       - receive_0:
519           capability: pm-subscription-event-publisher
520           node: org.onap.PM_Subscription_Handler
521           relationship: NOT_DEFINED
522           properties:
523             config_keys:
524             - topic_name:
525                 get_input: pm_subscription_topic
526           type: string
527           type_version: 0.0.0
528           version: 0.0.0
529       - send_0:
530           capability: cds-rest-receive
531           node: org.onap.CDS
532           type: string
533           type_version: 0.0.0
534           version: 0.0.0
535       - receive_1:
536           capability: cds-rest-response
537           node: org.onap.CDS
538           type: string
539           type_version: 0.0.0
540           version: 0.0.0
541       - send_1:
542           capability: pm-subscription-event-receiver
543           node: org.onap.PM_Subscription_Handler
544           relationship: NOT_DEFINED
545           properties:
546             config_keys:
547             - topic_name:
548                 get_input: pm_subscription_response_topic
549           type: string
550           type_version: 0.0.0
551           version: 0.0.0
552       capabilities:
553         pm-subscription-response-event-publisher:
554           properties:
555             type: org.onap.EventProducer
556             carrier_protocol_type: DMAAP_message_router
557             data_format: JSON
558             event_format: pm-subscription-event-response-format
559             event_format_version: 1.0.0
560           occurrences:
561           - 0.0
562           - UNBOUNDED
563           type: string
564           type_version: 0.0.0
565           version: 0.0.0
566       version: 0.0.0
567     org.onap.PM_CDS_Blueprint:
568       type: org.onap.APP
569       type_version: 0.0.0
570       properties:
571         application_name: PM Subscription CDS Blueprint
572         provider: Ericsson
573         application_version: 1.0.0
574         artifact_id:
575           get_input: pm_subscription_cds_blueprint_id
576       capabilities:
577         cds-rest-receive:
578           properties:
579             type: org.onap.EventConsumer
580             protocol_type: REST
581             data_format: JSON
582             event_format: cds_action_format
583             event_format_version: 1.0.0
584             responding_capability: cds-rest-response
585           occurrences:
586           - 0.0
587           - UNBOUNDED
588           type: string
589           type_version: 0.0.0
590           version: 0.0.0
591         cds-rest-response:
592           properties:
593             type: org.onap.EventProducer
594             protocol_type: REST
595             data_format: JSON
596             event_format: cds_action_response_format
597             event_format_version: 1.0.0
598           occurrences:
599           - 0.0
600           type: string
601           type_version: 0.0.0
602           version: 0.0.0
603       version: 0.0.0
604     org.onap.controlloop0:
605       type: org.onap.APP
606       type_version: 0.0.0
607       properties:
608         application_name: Test Control Loop
609         provider: Ericsson
610         application_version: 1.0.0
611         status: NOT_DEPLOYED
612       version: 0.0.0
613 version: 0.0.0
614