summaryrefslogtreecommitdiffstats
path: root/dpo/spec/vescollector-componentspec.json
blob: 5c3e4d9b820f2bb8d332ce9f5f55a844b14d3b40 (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
{
  "self": {
    "version": "1.7.4",
    "name": "dcae-ves-collector",
    "description": "Collector for receiving VES events through restful interface",
    "component_type": "docker"
  },
  "streams": {
    "subscribes": [],
    "publishes": [
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-fault"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-measurement"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-syslog"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-heartbeat"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-other"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-mobileflow"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-statechange"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-thresholdCrossingAlert"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-voicequality"
      },
      {
        "format": "VES_specification",
        "version": "5.28.4",
        "type": "message router",
        "config_key": "ves-sipsignaling"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-pnfRegistration"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-notification"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-perf3gpp"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-3gpp-fault-supervision"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-3gpp-provisioning"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-3gpp-heartbeat"
      },
      {
        "format": "VES_specification",
        "version": "7.30.2",
        "type": "message router",
        "config_key": "ves-3gpp-performance-assurance"
      }
    ]
  },
  "services": {
    "calls": [],
    "provides": [
      {
        "route": "/eventListener/v1",
        "verb": "POST",
        "request": {
          "format": "VES_specification",
          "version": "4.27.2"
        },
        "response": {
          "format": "ves.coll.response",
          "version": "1.0.0"
        }
      },
      {
        "route": "/eventListener/v2",
        "verb": "POST",
        "request": {
          "format": "VES_specification",
          "version": "4.27.2"
        },
        "response": {
          "format": "ves.coll.response",
          "version": "1.0.0"
        }
      },
      {
        "route": "/eventListener/v3",
        "verb": "POST",
        "request": {
          "format": "VES_specification",
          "version": "4.27.2"
        },
        "response": {
          "format": "ves.coll.response",
          "version": "1.0.0"
        }
      },
      {
        "route": "/eventListener/v4",
        "verb": "POST",
        "request": {
          "format": "VES_specification",
          "version": "4.27.2"
        },
        "response": {
          "format": "ves.coll.response",
          "version": "1.0.0"
        }
      },
      {
        "route": "/eventListener/v5",
        "verb": "POST",
        "request": {
          "format": "VES_specification",
          "version": "5.28.4"
        },
        "response": {
          "format": "ves.coll.response",
          "version": "1.0.0"
        }
      },
      {
        "route": "/eventListener/v7",
        "verb": "POST",
        "request": {
          "format": "VES_specification",
          "version": "7.30.2"
        },
        "response": {
          "format": "ves.coll.response",
          "version": "1.0.0"
        }
      }
    ]
  },
  "parameters": [
    {
      "name": "collector.service.port",
      "value": 8080,
      "description": "standard http port collector will open for listening;",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.service.secure.port",
      "value": 8443,
      "description": "secure http port collector will open for listening ",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": true
    },
    {
      "name": "collector.keystore.file.location",
      "value": "/opt/app/dcae-certificate/cert.jks",
      "description": "fs location of keystore file in vm",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.keystore.passwordfile",
      "value": "/opt/app/dcae-certificate/jks.pass",
      "description": "location of keystore password file in vm",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.truststore.file.location",
      "value": "/opt/app/dcae-certificate/trust.jks",
      "description": "fs location of truststore file in vm",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.truststore.passwordfile",
      "value": "/opt/app/dcae-certificate/trust.pass",
      "description": "location of truststore password file in vm",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.dmaap.streamid",
      "value": "fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|measurement=ves-measurement|mobileFlow=ves-mobileflow|other=ves-other|stateChange=ves-statechange|thresholdCrossingAlert=ves-thresholdCrossingAlert|voiceQuality=ves-voicequality|sipSignaling=ves-sipsignaling|notification=ves-notification|pnfRegistration=ves-pnfRegistration|perf3gpp=ves-perf3gpp|stndDefined=ves-other",
      "description": "domain-to-streamid mapping used by VESCollector to distributes events based on domain. Both primary and secondary config_key are included for resilency (multiple streamid can be included commma separated). The streamids MUST match to topic config_keys. For single site without resiliency deployment - configkeys with -secondary suffix can be removed",
      "sourced_at_deployment": true,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "auth.method",
      "value": "noAuth",
      "description": "Property to manage application mode, possible configurations: noAuth - default option - no security (http) , certOnly - auth by certificate (https), basicAuth - auth by basic auth username and password (https),certBasicAuth - auth by certificate and basic auth username / password (https),",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "header.authlist",
      "value": "sample1,$2a$10$pgjaxDzSuc6XVFEeqvxQ5u90DKJnM/u7TJTcinAlFJVaavXMWf/Zi|userid1,$2a$10$61gNubgJJl9lh3nvQvY9X.x4e5ETWJJ7ao7ZhJEvmfJigov26Z6uq|userid2,$2a$10$G52y/3uhuhWAMy.bx9Se8uzWinmbJa.dlm1LW6bYPdPkkywLDPLiy",
      "description": "List of id and base 64 encoded password.For each onboarding VNF - unique userid and password should be assigned and communicated to VNF owner. Password value should be base64 encoded in config here",
      "policy_editable": false,
      "sourced_at_deployment": true,
      "designer_editable": true
    },
    {
      "name": "collector.schema.checkflag",
      "value": 1,
      "description": "Schema check validation flag. When enabled, collector will validate input VES events against VES Schema defined on collector.schema.file ",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.schema.file",
      "value": "{\"v1\":\"./etc/CommonEventFormat_27.2.json\",\"v2\":\"./etc/CommonEventFormat_27.2.json\",\"v3\":\"./etc/CommonEventFormat_27.2.json\",\"v4\":\"./etc/CommonEventFormat_27.2.json\",\"v5\":\"./etc/CommonEventFormat_28.4.1.json\",\"v7\":\"./etc/CommonEventFormat_30.2_ONAP.json\"}",
      "description": "VES schema file name per version used for validation",
      "designer_editable": true,
      "sourced_at_deployment": false,
      "policy_editable": false
    },
    {
      "name": "event.transform.flag",
      "value": 1,
      "description": "flag to enable tranformation rules defined under eventTransform.json; this is applicable when event tranformation rules preset should be activated for transforming <VES5.4 events to 5.4",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "tomcat.maxthreads",
      "value": "200",
      "description": "Tomcat control for concurrent request",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.externalSchema.checkflag",
      "value": 1,
      "description": "Schema stndDefined validation flag. When enabled, collector will validate stndDefined fields in stndDefined domain events against mapped local schemas listed in file from property collector.externalSchema.mappingFileLocation.",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": true
    },
    {
      "name": "collector.externalSchema.schemasLocation",
      "value": "./etc/externalRepo/",
      "description": "External schemas repository. Path to schemas storage directory.",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "collector.externalSchema.mappingFileLocation",
      "value": "./etc/externalRepo/schema-map.json",
      "description": "Path to JSON file containing mapping of externally located stndDefined schemas to local schema files.",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "event.externalSchema.schemaRefPath",
      "value": "$.event.stndDefinedFields.schemaReference",
      "description": "An internal path from validated JSON. Defines which field is taken as public schema reference, which is later mapped.",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    },
    {
      "name": "event.externalSchema.stndDefinedDataPath",
      "value": "$.event.stndDefinedFields.data",
      "description": "An internal path from validated JSON. Defines which field of event will be validated during stndDefined validation.",
      "sourced_at_deployment": false,
      "policy_editable": false,
      "designer_editable": false
    }
  ],
  "auxilary": {
    "healthcheck": {
      "type": "http",
      "interval": "15s",
      "timeout": "1s",
      "endpoint": "/healthcheck"
    },
    "volumes": [
      {
        "container": {
          "bind": "/opt/app/dcae-certificate"
        },
        "host": {
          "path": "/opt/app/dcae-certificate"
        }
      },
      {
        "container": {
          "bind": "/opt/app/VESCollector/logs"
        },
        "host": {
          "path": "/opt/logs/DCAE/VESCollector/logs"
        }
      },
      {
        "container": {
          "bind": "/opt/app/VESCollector/etc"
        },
        "host": {
          "path": "/opt/logs/DCAE/VESCollector/etc"
        }
      }
    ],
    "ports": [
      "8080:0",
      "8443:0"
    ],
    "log_info": {
	"log_directory": "/opt/app/VESCollector/logs/"
     },
    "tls_info":{
	"cert_directory":"/opt/app/dcae-certificate/",
	"use_tls":true
     }
  },
  "artifacts": [
    {
      "type": "docker image",
      "uri": "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:latest"
    }
  ]
}