From 5deddeb4892243627ad342a41d4dcef0f7280a29 Mon Sep 17 00:00:00 2001 From: Vijay VK Date: Tue, 7 Aug 2018 00:44:41 +0100 Subject: VES 7.0.1 updates Initial commit to include the support for below - VES 7.1 API - updated spec and data-format - Response code update per new spec - springfox for swagger doc - New topic defaults Todo - Swagger instrumention to include necessary annotation - Event Transformation 7.x to 5.x - VES7.x response header - AAF cert integration Change-Id: I9bc2223fa362b35ae8a7105acd651fe524a403c5 Signed-off-by: VENKATESH KUMAR Issue-ID: DCAEGEN2-600 --- dpo/spec/vescollector-componentspec.json | 178 +++++++++++++++++++++++++++---- 1 file changed, 160 insertions(+), 18 deletions(-) (limited to 'dpo/spec') diff --git a/dpo/spec/vescollector-componentspec.json b/dpo/spec/vescollector-componentspec.json index 32144e2f..3c588fb1 100644 --- a/dpo/spec/vescollector-componentspec.json +++ b/dpo/spec/vescollector-componentspec.json @@ -1,6 +1,6 @@ { "self": { - "version": "1.2.0", + "version": "1.3.0", "name": "dcae-ves-collector", "description": "Collector for receiving VES events through restful interface", "component_type": "docker" @@ -67,6 +67,90 @@ "version": "5.28.4", "type": "message router", "config_key": "ves-sipsignaling" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-fault-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-measurement-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-syslog-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-heartbeat-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-other-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-mobileflow-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-statechange-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-thresholdCrossingAlert-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-voicequality-secondary" + }, + { + "format": "VES_specification", + "version": "5.28.4", + "type": "message router", + "config_key": "ves-sipsignaling-secondary" + }, + { + "format": "VES_specification", + "version": "7.30.0", + "type": "message router", + "config_key": "ves-pnfRegistration" + }, + { + "format": "VES_specification", + "version": "7.30.0", + "type": "message router", + "config_key": "ves-pnfRegistration-secondary" + }, + { + "format": "VES_specification", + "version": "7.30.0", + "type": "message router", + "config_key": "ves-notification" + }, + { + "format": "VES_specification", + "version": "7.30.0", + "type": "message router", + "config_key": "ves-notification-secondary" } ] }, @@ -132,6 +216,18 @@ "format": "ves.coll.response", "version": "1.0.0" } + }, + { + "route": "/eventListener/v7", + "verb": "POST", + "request": { + "format": "VES_specification", + "version": "7.30.0" + }, + "response": { + "format": "ves.coll.response", + "version": "1.0.0" + } } ] }, @@ -139,68 +235,106 @@ { "name": "collector.service.port", "value": -1, - "description": "standard http port" + "description": "standard http port collector will open for listening; this will be disabled when header.authflag is set to 1", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": false }, { "name": "collector.service.secure.port", "value": 8443, - "description": "secure port " + "description": "secure http port collector will open for listening ", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": true }, { "name": "collector.keystore.file.location", "value": "/opt/app/dcae-certificate/keystore.jks", - "description": "fs location of keystore in vm" + "description": "fs location of keystore file in vm", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": false }, { "name": "collector.keystore.passwordfile", "value": "/opt/app/dcae-certificate/.password", - "description": "location of keystore password file in vm" + "description": "location of keystore password file in vm", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": false }, { "name": "collector.keystore.alias", "value": "dynamically generated", - "description": "alias to access the keystore" + "description": "alias to access the keystore; collector will identify this based on keystore and password file", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": false }, { "name": "collector.inputQueue.maxPending", "value": 8096, - "description": "Maximum queue limit before publish" + "description": "Maximum queue limit across domains collector will queue before event is published", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": false }, { "name": "collector.dmaap.streamid", - "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", - "description": "domain-streamid mapping" + "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", + "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", + "sourced_at_deployment": true, + "policy_editable": false, + "designer_editable": false }, { "name": "header.authflag", "value": 1, - "description": "Basic Authentication flag" + "description": "Basic Authentication flag; when enabled only secure port will be supported.", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": false }, { "name": "header.authlist", "value": "sample1,c2FtcGxlMQ==|userid1,base64encodepwd1|userid2,base64encodepwd2", - "description": "List of id and base64 encoded pwd", - "sourced_at_deployment":true + "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", + "policy_editable": false, + "sourced_at_deployment": true, + "designer_editable": true }, { "name": "collector.schema.checkflag", "value": 1, - "description": "Schema check validation flag" + "description": "Schema check validation flag. When enabled, collector will validate input VES events against VES Schema defined on collector.schema.file ", + "sourced_at_deployment": false, + "policy_editable": false, + "designer_editable": false }, { "name": "collector.schema.file", - "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\"}", - "description": "validation schema file name per version" + "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\"}", + "description": "VES schema file name per version used for validation", + "designer_editable": true, + "sourced_at_deployment": false, + "policy_editable": false }, { "name": "event.transform.flag", "value": 1, - "description": "flag to enable tranformation rules defined under eventTransform.json" + "description": "flag to enable tranformation rules defined under eventTransform.json; this is applicable when event tranformation rules preset should be activated for transforming