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         },
  73         "services": {
  74                 "calls": [],
  75                 "provides": [
  76                         {
  77                                 "route": "/eventListener/v1",
  78                                 "verb": "POST",
  79                                 "request": {
  80                                         "format": "VES_specification",
  81                                         "version": "4.27.2"
  82                                 },
  83                                 "response": {
  84                                         "format": "ves.coll.response",
  85                                         "version": "1.0.0"
  86                                 }
  87                         },
  88                         {
  89                                 "route": "/eventListener/v2",
  90                                 "verb": "POST",
  91                                 "request": {
  92                                         "format": "VES_specification",
  93                                         "version": "4.27.2"
  94                                 },
  95                                 "response": {
  96                                         "format": "ves.coll.response",
  97                                         "version": "1.0.0"
  98                                 }
  99                         },
 100                         {
 101                                 "route": "/eventListener/v3",
 102                                 "verb": "POST",
 103                                 "request": {
 104                                         "format": "VES_specification",
 105                                         "version": "4.27.2"
 106                                 },
 107                                 "response": {
 108                                         "format": "ves.coll.response",
 109                                         "version": "1.0.0"
 110                                 }
 111                         },
 112                         {
 113                                 "route": "/eventListener/v4",
 114                                 "verb": "POST",
 115                                 "request": {
 116                                         "format": "VES_specification",
 117                                         "version": "4.27.2"
 118                                 },
 119                                 "response": {
 120                                         "format": "ves.coll.response",
 121                                         "version": "1.0.0"
 122                                 }
 123                         },
 124                         {
 125                                 "route": "/eventListener/v5",
 126                                 "verb": "POST",
 127                                 "request": {
 128                                         "format": "VES_specification",
 129                                         "version": "5.28.4"
 130                                 },
 131                                 "response": {
 132                                         "format": "ves.coll.response",
 133                                         "version": "1.0.0"
 134                                 }
 135                         }
 136                 ]
 137         },
 138         "parameters": [
 139                 {
 140                         "name": "collector.service.port",
 141                         "value": -1,
 142                         "description": "standard http port"
 143                 },
 144                 {
 145                         "name": "collector.service.secure.port",
 146                         "value": 8443,
 147                         "description": "secure port "
 148                 },
 149                 {
 150                         "name": "collector.keystore.file.location",
 151                         "value": "/opt/app/dcae-certificate/keystore.jks",
 152                         "description": "fs location of keystore in vm"
 153                 },
 154                 {
 155                         "name": "collector.keystore.passwordfile",
 156                         "value": "/opt/app/dcae-certificate/.password",
 157                         "description": "location of keystore password file in vm"
 158                 },
 159                 {
 160                         "name": "collector.keystore.alias",
 161                         "value": "dynamically generated",
 162                         "description": "alias to access the keystore"
 163                 },
 164                 {
 165                         "name": "collector.inputQueue.maxPending",
 166                         "value": 8096,
 167                         "description": "Maximum queue limit before publish"
 168                 },
 169                 {
 170                         "name": "collector.dmaap.streamid",
 171                         "value": "fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|mobileFlow=ves-mobileflow|other=ves-other|stateChange=ves-statechange|thresholdCrossingAlert=ves-thresholdCrossingAlert|voiceQuality=ves-voicequality|sipSignaling=ves-sipsignaling",
 172                         "description": "domain-streamid mapping"
 173                 },
 174                 {
 175                         "name": "header.authflag",
 176                         "value": 1,
 177                         "description": "Basic Authentication flag"
 178                 },
 179                 {
 180                         "name": "header.authlist",
 181                         "value": "sample1,c2FtcGxlMQ==|userid1,base64encodepwd1|userid2,base64encodepwd2",
 182                         "description": "List of id and base64 encoded pwd",
 183                         "sourced_at_deployment":true
 184                 },
 185                 {
 186                         "name": "collector.schema.checkflag",
 187                         "value": 1,
 188                         "description": "Schema check validation flag"
 189                 },
 190                 {
 191                         "name": "collector.schema.file",
 192                         "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\"}",
 193                         "description": "validation schema file name per version"
 194                 },
 195                 {
 196                         "name": "event.transform.flag",
 197                         "value": 1,
 198                         "description": "flag to enable tranformation rules defined under eventTransform.json"
 199                 },
 200                 {
 201                         "name": "tomcat.maxthreads",
 202                         "value": "200",
 203                         "description": "Tomcat control for concurrent request"
 204                 }
 205         ],
 206         "auxilary": {
 207                 "healthcheck": {
 208                         "type": "https",
 209                         "interval": "15s",
 210                         "timeout": "1s",
 211                         "endpoint": "/healthcheck"
 212                 },
 213                 "volumes": [
 214                         {
 215                                 "container": {
 216                                         "bind": "/opt/app/dcae-certificate"
 217                                 },
 218                                 "host": {
 219                                         "path": "/opt/app/dcae-certificate"
 220                                 }
 221                         },
 222                         {
 223                                 "container": {
 224                                         "bind": "/opt/app/VESCollector/logs"
 225                                 },
 226                                 "host": {
 227                                         "path": "/opt/logs/DCAE/VESCollector/logs"
 228                                 }
 229                         }
 230                 ],
 231                 "ports": [
 232                         "8443:8443"
 233                 ]
 234         },
 235         "artifacts": [
 236                 {
 237                         "type": "docker image",
 238                         "uri": "nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1"
 239                 }
 240         ]
 241 }