dpo/spec/vescollector-componentspec.json

   1 {
   2         "self": {
   3                 "version": "1.2.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         },
 133         "services": {
 134                 "calls": [],
 135                 "provides": [
 136                         {
 137                                 "route": "/eventListener/v1",
 138                                 "verb": "POST",
 139                                 "request": {
 140                                         "format": "VES_specification",
 141                                         "version": "4.27.2"
 142                                 },
 143                                 "response": {
 144                                         "format": "ves.coll.response",
 145                                         "version": "1.0.0"
 146                                 }
 147                         },
 148                         {
 149                                 "route": "/eventListener/v2",
 150                                 "verb": "POST",
 151                                 "request": {
 152                                         "format": "VES_specification",
 153                                         "version": "4.27.2"
 154                                 },
 155                                 "response": {
 156                                         "format": "ves.coll.response",
 157                                         "version": "1.0.0"
 158                                 }
 159                         },
 160                         {
 161                                 "route": "/eventListener/v3",
 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/v4",
 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/v5",
 186                                 "verb": "POST",
 187                                 "request": {
 188                                         "format": "VES_specification",
 189                                         "version": "5.28.4"
 190                                 },
 191                                 "response": {
 192                                         "format": "ves.coll.response",
 193                                         "version": "1.0.0"
 194                                 }
 195                         }
 196                 ]
 197         },
 198         "parameters": [
 199                 {
 200                         "name": "collector.service.port",
 201                         "value": -1,
 202                         "description": "standard http port"
 203                 },
 204                 {
 205                         "name": "collector.service.secure.port",
 206                         "value": 8443,
 207                         "description": "secure port "
 208                 },
 209                 {
 210                         "name": "collector.keystore.file.location",
 211                         "value": "/opt/app/dcae-certificate/keystore.jks",
 212                         "description": "fs location of keystore in vm"
 213                 },
 214                 {
 215                         "name": "collector.keystore.passwordfile",
 216                         "value": "/opt/app/dcae-certificate/.password",
 217                         "description": "location of keystore password file in vm"
 218                 },
 219                 {
 220                         "name": "collector.keystore.alias",
 221                         "value": "dynamically generated",
 222                         "description": "alias to access the keystore"
 223                 },
 224                 {
 225                         "name": "collector.inputQueue.maxPending",
 226                         "value": 8096,
 227                         "description": "Maximum queue limit before publish"
 228                 },
 229                 {
 230                         "name": "collector.dmaap.streamid",
 231                         "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",
 232                         "description": "domain-streamid mapping"
 233                 },
 234                 {
 235                         "name": "header.authflag",
 236                         "value": 1,
 237                         "description": "Basic Authentication flag"
 238                 },
 239                 {
 240                         "name": "header.authlist",
 241                         "value": "sample1,c2FtcGxlMQ==|userid1,base64encodepwd1|userid2,base64encodepwd2",
 242                         "description": "List of id and base64 encoded pwd",
 243                         "sourced_at_deployment":true
 244                 },
 245                 {
 246                         "name": "collector.schema.checkflag",
 247                         "value": 1,
 248                         "description": "Schema check validation flag"
 249                 },
 250                 {
 251                         "name": "collector.schema.file",
 252                         "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.json\"}",
 253                         "description": "validation schema file name per version"
 254                 },
 255                 {
 256                         "name": "event.transform.flag",
 257                         "value": 1,
 258                         "description": "flag to enable tranformation rules defined under eventTransform.json"
 259                 },
 260                 {
 261                         "name": "tomcat.maxthreads",
 262                         "value": "200",
 263                         "description": "Tomcat control for concurrent request"
 264                 }
 265         ],
 266         "auxilary": {
 267                 "healthcheck": {
 268                         "type": "https",
 269                         "interval": "15s",
 270                         "timeout": "1s",
 271                         "endpoint": "/healthcheck"
 272                 },
 273                 "volumes": [
 274                         {
 275                                 "container": {
 276                                         "bind": "/opt/app/dcae-certificate"
 277                                 },
 278                                 "host": {
 279                                         "path": "/opt/app/dcae-certificate"
 280                                 }
 281                         },
 282                         {
 283                                 "container": {
 284                                         "bind": "/opt/app/VESCollector/logs"
 285                                 },
 286                                 "host": {
 287                                         "path": "/opt/data/DCAE/VESCollector/logs"
 288                                 }
 289                         }
 290                 ],
 291                 "ports": [
 292                         "8443:8443"
 293                 ]
 294         },
 295         "artifacts": [
 296                 {
 297                         "type": "docker image",
 298                        "uri": "nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1"
 299
 300
 301                 }
 302         ]
 303 }
 304