dpo/spec/vescollector-componentspec.json

   1 {
   2         "self": {
   3                 "version": "1.3.0",
   4                 "name": "dcae-ves-collector",
   5                 "description": "Collector for receiving VES events through restful interface",
   6                 "component_type": "docker"
   7         },
   8         "streams": {
   9                 "subscribes": [],
  10                 "publishes": [
  11                         {
  12                                 "format": "VES_specification",
  13                                 "version": "5.28.4",
  14                                 "type": "message router",
  15                                 "config_key": "ves-fault"
  16                         },
  17                         {
  18                                 "format": "VES_specification",
  19                                 "version": "5.28.4",
  20                                 "type": "message router",
  21                                 "config_key": "ves-measurement"
  22                         },
  23                         {
  24                                 "format": "VES_specification",
  25                                 "version": "5.28.4",
  26                                 "type": "message router",
  27                                 "config_key": "ves-syslog"
  28                         },
  29                         {
  30                                 "format": "VES_specification",
  31                                 "version": "5.28.4",
  32                                 "type": "message router",
  33                                 "config_key": "ves-heartbeat"
  34                         },
  35                         {
  36                                 "format": "VES_specification",
  37                                 "version": "5.28.4",
  38                                 "type": "message router",
  39                                 "config_key": "ves-other"
  40                         },
  41                         {
  42                                 "format": "VES_specification",
  43                                 "version": "5.28.4",
  44                                 "type": "message router",
  45                                 "config_key": "ves-mobileflow"
  46                         },
  47                         {
  48                                 "format": "VES_specification",
  49                                 "version": "5.28.4",
  50                                 "type": "message router",
  51                                 "config_key": "ves-statechange"
  52                         },
  53                         {
  54                                 "format": "VES_specification",
  55                                 "version": "5.28.4",
  56                                 "type": "message router",
  57                                 "config_key": "ves-thresholdCrossingAlert"
  58                         },
  59                         {
  60                                 "format": "VES_specification",
  61                                 "version": "5.28.4",
  62                                 "type": "message router",
  63                                 "config_key": "ves-voicequality"
  64                         },
  65                         {
  66                                 "format": "VES_specification",
  67                                 "version": "5.28.4",
  68                                 "type": "message router",
  69                                 "config_key": "ves-sipsignaling"
  70                         },
  71                         {
  72                                 "format": "VES_specification",
  73                                 "version": "5.28.4",
  74                                 "type": "message router",
  75                                 "config_key": "ves-fault-secondary"
  76                         },
  77                         {
  78                                 "format": "VES_specification",
  79                                 "version": "5.28.4",
  80                                 "type": "message router",
  81                                 "config_key": "ves-measurement-secondary"
  82                         },
  83                         {
  84                                 "format": "VES_specification",
  85                                 "version": "5.28.4",
  86                                 "type": "message router",
  87                                 "config_key": "ves-syslog-secondary"
  88                         },
  89                         {
  90                                 "format": "VES_specification",
  91                                 "version": "5.28.4",
  92                                 "type": "message router",
  93                                 "config_key": "ves-heartbeat-secondary"
  94                         },
  95                         {
  96                                 "format": "VES_specification",
  97                                 "version": "5.28.4",
  98                                 "type": "message router",
  99                                 "config_key": "ves-other-secondary"
 100                         },
 101                         {
 102                                 "format": "VES_specification",
 103                                 "version": "5.28.4",
 104                                 "type": "message router",
 105                                 "config_key": "ves-mobileflow-secondary"
 106                         },
 107                         {
 108                                 "format": "VES_specification",
 109                                 "version": "5.28.4",
 110                                 "type": "message router",
 111                                 "config_key": "ves-statechange-secondary"
 112                         },
 113                         {
 114                                 "format": "VES_specification",
 115                                 "version": "5.28.4",
 116                                 "type": "message router",
 117                                 "config_key": "ves-thresholdCrossingAlert-secondary"
 118                         },
 119                         {
 120                                 "format": "VES_specification",
 121                                 "version": "5.28.4",
 122                                 "type": "message router",
 123                                 "config_key": "ves-voicequality-secondary"
 124                         },
 125                         {
 126                                 "format": "VES_specification",
 127                                 "version": "5.28.4",
 128                                 "type": "message router",
 129                                 "config_key": "ves-sipsignaling-secondary"
 130                         },
 131                         {
 132                                 "format": "VES_specification",
 133                                 "version": "7.30.0",
 134                                 "type": "message router",
 135                                 "config_key": "ves-pnfRegistration"
 136                         },
 137                         {
 138                                 "format": "VES_specification",
 139                                 "version": "7.30.0",
 140                                 "type": "message router",
 141                                 "config_key": "ves-pnfRegistration-secondary"
 142                         },
 143                         {
 144                                 "format": "VES_specification",
 145                                 "version": "7.30.0",
 146                                 "type": "message router",
 147                                 "config_key": "ves-notification"
 148                         },
 149                         {
 150                                 "format": "VES_specification",
 151                                 "version": "7.30.0",
 152                                 "type": "message router",
 153                                 "config_key": "ves-notification-secondary"
 154                         }
 155                 ]
 156         },
 157         "services": {
 158                 "calls": [],
 159                 "provides": [
 160                         {
 161                                 "route": "/eventListener/v1",
 162                                 "verb": "POST",
 163                                 "request": {
 164                                         "format": "VES_specification",
 165                                         "version": "4.27.2"
 166                                 },
 167                                 "response": {
 168                                         "format": "ves.coll.response",
 169                                         "version": "1.0.0"
 170                                 }
 171                         },
 172                         {
 173                                 "route": "/eventListener/v2",
 174                                 "verb": "POST",
 175                                 "request": {
 176                                         "format": "VES_specification",
 177                                         "version": "4.27.2"
 178                                 },
 179                                 "response": {
 180                                         "format": "ves.coll.response",
 181                                         "version": "1.0.0"
 182                                 }
 183                         },
 184                         {
 185                                 "route": "/eventListener/v3",
 186                                 "verb": "POST",
 187                                 "request": {
 188                                         "format": "VES_specification",
 189                                         "version": "4.27.2"
 190                                 },
 191                                 "response": {
 192                                         "format": "ves.coll.response",
 193                                         "version": "1.0.0"
 194                                 }
 195                         },
 196                         {
 197                                 "route": "/eventListener/v4",
 198                                 "verb": "POST",
 199                                 "request": {
 200                                         "format": "VES_specification",
 201                                         "version": "4.27.2"
 202                                 },
 203                                 "response": {
 204                                         "format": "ves.coll.response",
 205                                         "version": "1.0.0"
 206                                 }
 207                         },
 208                         {
 209                                 "route": "/eventListener/v5",
 210                                 "verb": "POST",
 211                                 "request": {
 212                                         "format": "VES_specification",
 213                                         "version": "5.28.4"
 214                                 },
 215                                 "response": {
 216                                         "format": "ves.coll.response",
 217                                         "version": "1.0.0"
 218                                 }
 219                         },
 220                         {
 221                                 "route": "/eventListener/v7",
 222                                 "verb": "POST",
 223                                 "request": {
 224                                         "format": "VES_specification",
 225                                         "version": "7.30.0"
 226                                 },
 227                                 "response": {
 228                                         "format": "ves.coll.response",
 229                                         "version": "1.0.0"
 230                                 }
 231                         }
 232                 ]
 233         },
 234         "parameters": [
 235                 {
 236                         "name": "collector.service.port",
 237                         "value": -1,
 238                         "description": "standard http port collector will open for listening; this will be disabled when header.authflag is set to 1",
 239                         "sourced_at_deployment": false,
 240                         "policy_editable": false,
 241                         "designer_editable": false
 242                 },
 243                 {
 244                         "name": "collector.service.secure.port",
 245                         "value": 8443,
 246                         "description": "secure http port collector will open for listening ",
 247                         "sourced_at_deployment": false,
 248                         "policy_editable": false,
 249                         "designer_editable": true
 250                 },
 251                 {
 252                         "name": "collector.keystore.file.location",
 253                         "value": "/opt/app/dcae-certificate/keystore.jks",
 254                         "description": "fs location of keystore file in vm",
 255                         "sourced_at_deployment": false,
 256                         "policy_editable": false,
 257                         "designer_editable": false
 258                 },
 259                 {
 260                         "name": "collector.keystore.passwordfile",
 261                         "value": "/opt/app/dcae-certificate/.password",
 262                         "description": "location of keystore password file in vm",
 263                         "sourced_at_deployment": false,
 264                         "policy_editable": false,
 265                         "designer_editable": false
 266                 },
 267                 {
 268                         "name": "collector.keystore.alias",
 269                         "value": "dynamically generated",
 270                         "description": "alias to access the keystore; collector will identify this based on keystore and password file",
 271                         "sourced_at_deployment": false,
 272                         "policy_editable": false,
 273                         "designer_editable": false
 274                 },
 275                 {
 276                         "name": "collector.inputQueue.maxPending",
 277                         "value": 8096,
 278                         "description": "Maximum queue limit across domains collector will queue before event is published",
 279                         "sourced_at_deployment": false,
 280                         "policy_editable": false,
 281                         "designer_editable": false
 282                 },
 283                 {
 284                         "name": "collector.dmaap.streamid",
 285                         "value": "fault=ves-fault,ves-fault-secondary|syslog=ves-syslog,ves-syslog-secondary|heartbeat=ves-heartbeat,ves-heartbeat-secondary|measurementsForVfScaling=ves-measurement,ves-measurement-secondary|mobileFlow=ves-mobileflow,ves-mobileflow-secondary|other=ves-other,ves-other-secondary|stateChange=ves-statechange,ves-statechange-secondary|thresholdCrossingAlert=ves-thresholdCrossingAlert,ves-thresholdCrossingAlert-secondary|voiceQuality=ves-voicequality,ves-voicequality-secondary|sipSignaling=ves-sipsignaling,ves-sipsignaling-secondary|notification=ves-notification,ves-notification-secondary|pnfRegistration=ves-pnfRegistration,ves-pnfRegistration-secondary",
 286                         "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",
 287                         "sourced_at_deployment": true,
 288                         "policy_editable": false,
 289                         "designer_editable": false
 290                 },
 291                 {
 292                         "name": "header.authflag",
 293                         "value": 1,
 294                         "description": "Basic Authentication flag; when enabled only secure port will be supported.",
 295                         "sourced_at_deployment": false,
 296                         "policy_editable": false,
 297                         "designer_editable": false
 298                 },
 299                 {
 300                         "name": "header.authlist",
 301                         "value": "sample1,c2FtcGxlMQ==|userid1,base64encodepwd1|userid2,base64encodepwd2",
 302                         "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",
 303                         "policy_editable": false,
 304                         "sourced_at_deployment": true,
 305                         "designer_editable": true
 306                 },
 307                 {
 308                         "name": "collector.schema.checkflag",
 309                         "value": 1,
 310                         "description": "Schema check validation flag. When enabled, collector will validate input VES events against VES Schema defined on collector.schema.file ",
 311                         "sourced_at_deployment": false,
 312                         "policy_editable": false,
 313                         "designer_editable": false
 314                 },
 315                 {
 316                         "name": "collector.schema.file",
 317                         "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.json\"}",
 318                         "description": "VES schema file name per version used for validation",
 319                         "designer_editable": true,
 320                         "sourced_at_deployment": false,
 321                         "policy_editable": false
 322                 },
 323                 {
 324                         "name": "event.transform.flag",
 325                         "value": 1,
 326                         "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",
 327                         "sourced_at_deployment": false,
 328                         "policy_editable": false,
 329                         "designer_editable": false
 330                 },
 331                 {
 332                         "name": "tomcat.maxthreads",
 333                         "value": "200",
 334                         "description": "Tomcat control for concurrent request",
 335                         "sourced_at_deployment": false,
 336                         "policy_editable": false,
 337                         "designer_editable": false
 338                 }
 339         ],
 340         "auxilary": {
 341                 "healthcheck": {
 342                         "type": "https",
 343                         "interval": "15s",
 344                         "timeout": "1s",
 345                         "endpoint": "/healthcheck"
 346                 },
 347                 "volumes": [
 348                         {
 349                                 "container": {
 350                                         "bind": "/opt/app/dcae-certificate"
 351                                 },
 352                                 "host": {
 353                                         "path": "/opt/app/dcae-certificate"
 354                                 }
 355                         },
 356                         {
 357                                 "container": {
 358                                         "bind": "/opt/app/VESCollector/logs"
 359                                 },
 360                                 "host": {
 361                                         "path": "/opt/logs/DCAE/VESCollector/logs"
 362                                 }
 363                         },
 364                         {
 365                                 "container": {
 366                                         "bind": "/opt/app/VESCollector/etc"
 367                                 },
 368                                 "host": {
 369                                         "path": "/opt/logs/DCAE/VESCollector/etc"
 370                                 }
 371                         }
 372                 ],
 373                 "ports": [
 374                         "8443:8443"
 375                 ]
 376         },
 377         "artifacts": [
 378                 {
 379                         "type": "docker image",
 380                         "uri": "nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3"
 381                 }
 382         ]
 383 }