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