docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component.json

   1 {
   2         "owner": "mS-Developer",
   3         "spec": {
   4                 "self": {
   5                         "version": "1.5.4",
   6                         "name": "dcae-ves-collector",
   7                         "description": "Collector for receiving VES events through restful interface",
   8                         "component_type": "docker"
   9                 },
  10                 "streams": {
  11                         "subscribes": [],
  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": "7.30.1",
  76                                         "type": "message router",
  77                                         "config_key": "ves-pnfRegistration"
  78                                 },
  79                                 {
  80                                         "format": "VES_specification",
  81                                         "version": "7.30.1",
  82                                         "type": "message router",
  83                                         "config_key": "ves-notification"
  84                                 },
  85                                 {
  86                                         "format": "VES_specification",
  87                                         "version": "7.30.1",
  88                                         "type": "message router",
  89                                         "config_key": "ves-perf3gpp"
  90                                 }
  91                         ]
  92                 },
  93                 "services": {
  94                         "calls": [],
  95                         "provides": [
  96                                 {
  97                                         "route": "/eventListener/v1",
  98                                         "verb": "POST",
  99                                         "request": {
 100                                                 "format": "VES_specification",
 101                                                 "version": "4.27.2"
 102                                         },
 103                                         "response": {
 104                                                 "format": "ves.coll.response",
 105                                                 "version": "1.0.0"
 106                                         }
 107                                 },
 108                                 {
 109                                         "route": "/eventListener/v2",
 110                                         "verb": "POST",
 111                                         "request": {
 112                                                 "format": "VES_specification",
 113                                                 "version": "4.27.2"
 114                                         },
 115                                         "response": {
 116                                                 "format": "ves.coll.response",
 117                                                 "version": "1.0.0"
 118                                         }
 119                                 },
 120                                 {
 121                                         "route": "/eventListener/v3",
 122                                         "verb": "POST",
 123                                         "request": {
 124                                                 "format": "VES_specification",
 125                                                 "version": "4.27.2"
 126                                         },
 127                                         "response": {
 128                                                 "format": "ves.coll.response",
 129                                                 "version": "1.0.0"
 130                                         }
 131                                 },
 132                                 {
 133                                         "route": "/eventListener/v4",
 134                                         "verb": "POST",
 135                                         "request": {
 136                                                 "format": "VES_specification",
 137                                                 "version": "4.27.2"
 138                                         },
 139                                         "response": {
 140                                                 "format": "ves.coll.response",
 141                                                 "version": "1.0.0"
 142                                         }
 143                                 },
 144                                 {
 145                                         "route": "/eventListener/v5",
 146                                         "verb": "POST",
 147                                         "request": {
 148                                                 "format": "VES_specification",
 149                                                 "version": "5.28.4"
 150                                         },
 151                                         "response": {
 152                                                 "format": "ves.coll.response",
 153                                                 "version": "1.0.0"
 154                                         }
 155                                 },
 156                                 {
 157                                         "route": "/eventListener/v7",
 158                                         "verb": "POST",
 159                                         "request": {
 160                                                 "format": "VES_specification",
 161                                                 "version": "7.30.1"
 162                                         },
 163                                         "response": {
 164                                                 "format": "ves.coll.response",
 165                                                 "version": "1.0.0"
 166                                         }
 167                                 }
 168                         ]
 169                 },
 170                 "parameters": [
 171                         {
 172                                 "name": "collector.service.port",
 173                                 "value": 8080,
 174                                 "description": "standard http port collector will open for listening;",
 175                                 "sourced_at_deployment": false,
 176                                 "policy_editable": false,
 177                                 "designer_editable": false
 178                         },
 179                         {
 180                                 "name": "collector.service.secure.port",
 181                                 "value": 8443,
 182                                 "description": "secure http port collector will open for listening ",
 183                                 "sourced_at_deployment": false,
 184                                 "policy_editable": false,
 185                                 "designer_editable": true
 186                         },
 187                         {
 188                                 "name": "collector.keystore.file.location",
 189                                 "value": "/opt/app/dcae-certificate/cert.jks",
 190                                 "description": "fs location of keystore file in vm",
 191                                 "sourced_at_deployment": false,
 192                                 "policy_editable": false,
 193                                 "designer_editable": false
 194                         },
 195                         {
 196                                 "name": "collector.keystore.passwordfile",
 197                                 "value": "/opt/app/dcae-certificate/jks.pass",
 198                                 "description": "location of keystore password file in vm",
 199                                 "sourced_at_deployment": false,
 200                                 "policy_editable": false,
 201                                 "designer_editable": false
 202                         },
 203                         {
 204                                 "name": "collector.truststore.file.location",
 205                                 "value": "/opt/app/dcae-certificate/trust.jks",
 206                                 "description": "fs location of truststore file in vm",
 207                                 "sourced_at_deployment": false,
 208                                 "policy_editable": false,
 209                                 "designer_editable": false
 210                         },
 211                         {
 212                                 "name": "collector.truststore.passwordfile",
 213                                 "value": "/opt/app/dcae-certificate/trust.pass",
 214                                 "description": "location of truststore password file in vm",
 215                                 "sourced_at_deployment": false,
 216                                 "policy_editable": false,
 217                                 "designer_editable": false
 218                         },
 219                         {
 220                                 "name": "collector.dmaap.streamid",
 221                                 "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",
 222                                 "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",
 223                                 "sourced_at_deployment": true,
 224                                 "policy_editable": false,
 225                                 "designer_editable": false
 226                         },
 227                         {
 228                                 "name": "auth.method",
 229                                 "value": "noAuth",
 230                                 "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),",
 231                                 "sourced_at_deployment": false,
 232                                 "policy_editable": false,
 233                                 "designer_editable": false
 234                         },
 235                         {
 236                                 "name": "header.authlist",
 237                                 "value": "sample1,$2a$10$pgjaxDzSuc6XVFEeqvxQ5u90DKJnM/u7TJTcinAlFJVaavXMWf/Zi|userid1,$2a$10$61gNubgJJl9lh3nvQvY9X.x4e5ETWJJ7ao7ZhJEvmfJigov26Z6uq|userid2,$2a$10$G52y/3uhuhWAMy.bx9Se8uzWinmbJa.dlm1LW6bYPdPkkywLDPLiy",
 238                                 "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",
 239                                 "policy_editable": false,
 240                                 "sourced_at_deployment": true,
 241                                 "designer_editable": true
 242                         },
 243                         {
 244                                 "name": "collector.schema.checkflag",
 245                                 "value": 1,
 246                                 "description": "Schema check validation flag. When enabled, collector will validate input VES events against VES Schema defined on collector.schema.file ",
 247                                 "sourced_at_deployment": false,
 248                                 "policy_editable": false,
 249                                 "designer_editable": false
 250                         },
 251                         {
 252                                 "name": "collector.schema.file",
 253                                 "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.1.1.json\"}",
 254                                 "description": "VES schema file name per version used for validation",
 255                                 "designer_editable": true,
 256                                 "sourced_at_deployment": false,
 257                                 "policy_editable": false
 258                         },
 259                         {
 260                                 "name": "event.transform.flag",
 261                                 "value": 1,
 262                                 "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",
 263                                 "sourced_at_deployment": false,
 264                                 "policy_editable": false,
 265                                 "designer_editable": false
 266                         },
 267                         {
 268                                 "name": "tomcat.maxthreads",
 269                                 "value": "200",
 270                                 "description": "Tomcat control for concurrent request",
 271                                 "sourced_at_deployment": false,
 272                                 "policy_editable": false,
 273                                 "designer_editable": false
 274                         }
 275                 ],
 276                 "auxilary": {
 277                         "healthcheck": {
 278                                 "type": "http",
 279                                 "interval": "15s",
 280                                 "timeout": "1s",
 281                                 "endpoint": "/healthcheck"
 282                         },
 283                         "volumes": [
 284                                 {
 285                                         "container": {
 286                                                 "bind": "/opt/app/dcae-certificate"
 287                                         },
 288                                         "host": {
 289                                                 "path": "/opt/app/dcae-certificate"
 290                                         }
 291                                 },
 292                                 {
 293                                         "container": {
 294                                                 "bind": "/opt/app/VESCollector/logs"
 295                                         },
 296                                         "host": {
 297                                                 "path": "/opt/logs/DCAE/VESCollector/logs"
 298                                         }
 299                                 },
 300                                 {
 301                                         "container": {
 302                                                 "bind": "/opt/app/VESCollector/etc"
 303                                         },
 304                                         "host": {
 305                                                 "path": "/opt/logs/DCAE/VESCollector/etc"
 306                                         }
 307                                 }
 308                         ],
 309                         "ports": [
 310                                 "8080:0",
 311                                 "8443:0"
 312                         ],
 313                         "log_info": {
 314                                 "log_directory": "/opt/app/VESCollector/logs/"
 315                         },
 316                         "tls_info": {
 317                                 "cert_directory": "/opt/app/dcae-certificate/",
 318                                 "use_tls": true
 319                         }
 320                 },
 321                 "artifacts": [
 322                         {
 323                                 "type": "docker image",
 324                                 "uri": "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:latest"
 325                         }
 326                 ]
 327         }
 328 }