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
  11                 ],
  12                 "publishes": [
  13                         {
  14                                 "format": "VES_specification",
  15                                 "version": "5.28.4",
  16                                 "type": "message router",
  17                                 "config_key": "ves_fault"
  18                         },
  19                         {
  20                                 "format": "VES_specification",
  21                                 "version": "5.28.4",
  22                                 "type": "message router",
  23                                 "config_key": "ves_measurement"
  24                         },
  25                         {
  26                                 "format": "VES_specification",
  27                                 "version": "5.28.4",
  28                                 "type": "message router",
  29                                 "config_key": "ves_syslog"
  30                         },
  31                         {
  32                                 "format": "VES_specification",
  33                                 "version": "5.28.4",
  34                                 "type": "message router",
  35                                 "config_key": "ves_heartbeat"
  36                         },
  37                         {
  38                                 "format": "VES_specification",
  39                                 "version": "5.28.4",
  40                                 "type": "message router",
  41                                 "config_key": "ves_other"
  42                         },
  43                         {
  44                                 "format": "VES_specification",
  45                                 "version": "5.28.4",
  46                                 "type": "message router",
  47                                 "config_key": "ves_mobileflow"
  48                         },
  49                         {
  50                                 "format": "VES_specification",
  51                                 "version": "5.28.4",
  52                                 "type": "message router",
  53                                 "config_key": "ves_statechange"
  54                         },
  55                         {
  56                                 "format": "VES_specification",
  57                                 "version": "5.28.4",
  58                                 "type": "message router",
  59                                 "config_key": "ves_thresholdCrossingAlert"
  60                         },
  61                         {
  62                                 "format": "VES_specification",
  63                                 "version": "5.28.4",
  64                                 "type": "message router",
  65                                 "config_key": "ves_voicequality"
  66                         },
  67                         {
  68                                 "format": "VES_specification",
  69                                 "version": "5.28.4",
  70                                 "type": "message router",
  71                                 "config_key": "ves_sipsignaling"
  72                         },
  73                         {
  74                                 "format": "VES_specification",
  75                                 "version": "5.28.4",
  76                                 "type": "message router",
  77                                 "config_key": "ves_fault_secondary"
  78                         },
  79                         {
  80                                 "format": "VES_specification",
  81                                 "version": "5.28.4",
  82                                 "type": "message router",
  83                                 "config_key": "ves_measurement_secondary"
  84                         },
  85                         {
  86                                 "format": "VES_specification",
  87                                 "version": "5.28.4",
  88                                 "type": "message router",
  89                                 "config_key": "ves_syslog_secondary"
  90                         },
  91                         {
  92                                 "format": "VES_specification",
  93                                 "version": "5.28.4",
  94                                 "type": "message router",
  95                                 "config_key": "ves_heartbeat_secondary"
  96                         },
  97                         {
  98                                 "format": "VES_specification",
  99                                 "version": "5.28.4",
 100                                 "type": "message router",
 101                                 "config_key": "ves_other_secondary"
 102                         },
 103                         {
 104                                 "format": "VES_specification",
 105                                 "version": "5.28.4",
 106                                 "type": "message router",
 107                                 "config_key": "ves_mobileflow_secondary"
 108                         },
 109                         {
 110                                 "format": "VES_specification",
 111                                 "version": "5.28.4",
 112                                 "type": "message router",
 113                                 "config_key": "ves_statechange_secondary"
 114                         },
 115                         {
 116                                 "format": "VES_specification",
 117                                 "version": "5.28.4",
 118                                 "type": "message router",
 119                                 "config_key": "ves_thresholdCrossingAlert_secondary"
 120                         },
 121                         {
 122                                 "format": "VES_specification",
 123                                 "version": "5.28.4",
 124                                 "type": "message router",
 125                                 "config_key": "ves_voicequality_secondary"
 126                         },
 127                         {
 128                                 "format": "VES_specification",
 129                                 "version": "5.28.4",
 130                                 "type": "message router",
 131                                 "config_key": "ves_sipsignaling_secondary"
 132                         }
 133                 ]
 134         },
 135         "services": {
 136                 "calls": [],
 137                 "provides": [
 138                         {
 139                                 "route": "/eventListener/v1",
 140                                 "verb": "POST",
 141                                 "request": {
 142                                         "format": "VES_specification",
 143                                         "version": "4.27.2"
 144                                 },
 145                                 "response": {
 146                                         "format": "ves.coll.response",
 147                                         "version": "1.0.0"
 148                                 }
 149                         },
 150                         {
 151                                 "route": "/eventListener/v2",
 152                                 "verb": "POST",
 153                                 "request": {
 154                                         "format": "VES_specification",
 155                                         "version": "4.27.2"
 156                                 },
 157                                 "response": {
 158                                         "format": "ves.coll.response",
 159                                         "version": "1.0.0"
 160                                 }
 161                         },
 162                         {
 163                                 "route": "/eventListener/v3",
 164                                 "verb": "POST",
 165                                 "request": {
 166                                         "format": "VES_specification",
 167                                         "version": "4.27.2"
 168                                 },
 169                                 "response": {
 170                                         "format": "ves.coll.response",
 171                                         "version": "1.0.0"
 172                                 }
 173                         },
 174                         {
 175                                 "route": "/eventListener/v4",
 176                                 "verb": "POST",
 177                                 "request": {
 178                                         "format": "VES_specification",
 179                                         "version": "4.27.2"
 180                                 },
 181                                 "response": {
 182                                         "format": "ves.coll.response",
 183                                         "version": "1.0.0"
 184                                 }
 185                         },
 186                         {
 187                                 "route": "/eventListener/v5",
 188                                 "verb": "POST",
 189                                 "request": {
 190                                         "format": "VES_specification",
 191                                         "version": "5.28.4"
 192                                 },
 193                                 "response": {
 194                                         "format": "ves.coll.response",
 195                                         "version": "1.0.0"
 196                                 }
 197                         }
 198
 199                 ]
 200         },
 201         "parameters": [
 202                 {
 203                         "name": "collector.service.port",
 204                         "value": -1,
 205                         "description": "standard http port"
 206                 },
 207                 {
 208                         "name": "collector.service.secure.port",
 209                         "value": 8443,
 210                         "description": "secure port "
 211                 },
 212                 {
 213                         "name": "collector.keystore.file.location",
 214                         "value": "/opt/app/dcae-certificate/keystore.jks",
 215                         "description": "fs location of keystore in vm"
 216                 },
 217                 {
 218                         "name": "collector.keystore.passwordfile",
 219                         "value": "/opt/app/dcae-certificate/.password",
 220                         "description": "location of keystore password file in vm"
 221                 },
 222                 {
 223                         "name": "collector.keystore.alias",
 224                         "value": "dynamically generated",
 225                         "description": "alias to access the keystore"
 226                 },
 227                 {
 228                         "name": "collector.inputQueue.maxPending",
 229                         "value": 8096,
 230                         "description": "Maximum queue limit before publish"
 231                 },
 232                 {
 233                         "name": "collector.dmaap.streamid",
 234                         "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",
 235                         "description": "domain-streamid mapping"
 236                 },
 237                 {
 238                         "name": "header.authflag",
 239                         "value": 1,
 240                         "description": "Basic Authentication flag"
 241                 },
 242                 {
 243                         "name": "header.authlist",
 244                         "value": "userid1,base64encodepwd1|userid2,base64encodepwd2",
 245                         "description": "List of id and base64 encoded pwd"
 246                 },
 247                 {
 248                         "name": "collector.schema.checkflag",
 249                         "value": 1,
 250                         "description": "Schema check validation flag"
 251                 },
 252                 {
 253                         "name": "collector.schema.file",
 254                         "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\"}",
 255                         "description": "validation schema file name per version"
 256                 },
 257                 {
 258                         "name": "event.transform.flag",
 259                         "value": 1,
 260                         "description": "flag to enable tranformation rules defined under eventTransform.json"
 261                 },
 262                 {
 263                         "name": "tomcat.maxthreads",
 264                         "value": "200",
 265                         "description": "Tomcat control for concurrent request"
 266                 }
 267         ],
 268         "auxilary": {
 269                 "healthcheck": {
 270                         "type": "http",
 271                         "interval": "15s",
 272                         "timeout": "1s",
 273                         "endpoint": "/healthcheck"
 274                 },
 275                             "ports": [
 276                               "8443:8443"
 277                             ]
 278         },
 279         "artifacts": [
 280                 {
 281                         "type": "docker image",
 282                         "uri": "nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1"
 283                 }
 284         ]
 285 }
 286