Merge "Added policyNodes, db, tls support"
[dcaegen2/platform.git] / mod / bpgenerator / TestCases / ves / componentSpecs / ves.json
1 {
2   "self": {
3     "version": "1.5.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-other"  
28       },
29       {
30         "format": "VES_specification",
31         "version": "5.28.4",
32         "type": "message router",
33         "config_key": "ves-heartbeat-secondary" 
34       },
35       {
36         "format": "VES_specification",
37         "version": "7.30.0",
38         "type": "message router",
39         "config_key": "ves-pnfRegistration" 
40       },
41       {
42         "format": "VES_specification",
43         "version": "7.30.0",
44         "type": "message router",
45         "config_key": "ves-notification" 
46       }
47     ]
48   },
49   "services": {
50     "calls": [],
51     "provides": [
52       {
53         "route": "/eventListener/v1",
54         "verb": "POST",
55         "request": {
56           "format": "VES_specification",
57           "version": "4.27.2"
58         },
59         "response": {
60           "format": "ves.coll.response",
61           "version": "1.0.0"
62         }
63       },
64       {
65         "route": "/eventListener/v2",
66         "verb": "POST",
67         "request": {
68           "format": "VES_specification",
69           "version": "4.27.2"
70         },
71         "response": {
72           "format": "ves.coll.response",
73           "version": "1.0.0"
74         }
75       },
76       {
77         "route": "/eventListener/v3",
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/v4",
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/v5",
102         "verb": "POST",
103         "request": {
104           "format": "VES_specification",
105           "version": "5.28.4"
106         },
107         "response": {
108           "format": "ves.coll.response",
109           "version": "1.0.0"
110         }
111       },
112       {
113         "route": "/eventListener/v7",
114         "verb": "POST",
115         "request": {
116           "format": "VES_specification",
117           "version": "7.30.0"
118         },
119         "response": {
120           "format": "ves.coll.response",
121           "version": "1.0.0"
122         }
123       }
124     ]
125   },
126   "parameters": [
127     {
128       "name": "collector.service.port",
129       "value": 8080,
130       "description": "standard http port collector will open for listening;",
131       "sourced_at_deployment": false,
132       "policy_editable": false,
133       "designer_editable": false
134     },
135     {
136       "name": "collector.service.secure.port",
137       "value": 8443,
138       "description": "secure http port collector will open for listening ",
139       "sourced_at_deployment": false,
140       "policy_editable": false,
141       "designer_editable": true
142     },
143     {
144       "name": "collector.keystore.file.location",
145       "value": "/opt/app/dcae-certificate/keystore.jks",
146       "description": "fs location of keystore file in vm",
147       "sourced_at_deployment": false,
148       "policy_editable": false,
149       "designer_editable": false
150     },
151     {
152       "name": "collector.keystore.passwordfile",
153       "value": "/opt/app/dcae-certificate/.password",
154       "description": "location of keystore password file in vm",
155       "sourced_at_deployment": false,
156       "policy_editable": false,
157       "designer_editable": false
158     },
159     {
160       "name": "collector.truststore.file.location",
161       "value": "/opt/app/dcae-certificate/truststore.jks",
162       "description": "fs location of truststore file in vm",
163       "sourced_at_deployment": false,
164       "policy_editable": false,
165       "designer_editable": false
166     },
167     {
168       "name": "collector.truststore.passwordfile",
169       "value": "/opt/app/dcae-certificate/.trustpassword",
170       "description": "location of truststore password file in vm",
171       "sourced_at_deployment": false,
172       "policy_editable": false,
173       "designer_editable": false
174     },
175     {
176       "name": "collector.dmaap.streamid",
177       "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",
178       "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",
179       "sourced_at_deployment": true,
180       "policy_editable": false,
181       "designer_editable": false
182     },
183     {
184       "name": "auth.method",
185       "value": "noAuth",
186       "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),",
187       "sourced_at_deployment": false,
188       "policy_editable": false,
189       "designer_editable": false
190     },
191     {
192       "name": "header.authlist",
193       "value": "sample1,$2a$10$pgjaxDzSuc6XVFEeqvxQ5u90DKJnM/u7TJTcinAlFJVaavXMWf/Zi|userid1,$2a$10$61gNubgJJl9lh3nvQvY9X.x4e5ETWJJ7ao7ZhJEvmfJigov26Z6uq|userid2,$2a$10$G52y/3uhuhWAMy.bx9Se8uzWinmbJa.dlm1LW6bYPdPkkywLDPLiy",
194       "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",
195       "policy_editable": false,
196       "sourced_at_deployment": true,
197       "designer_editable": true
198     },
199     {
200       "name": "collector.schema.checkflag",
201       "value": 1,
202       "description": "Schema check validation flag. When enabled, collector will validate input VES events against VES Schema defined on collector.schema.file ",
203       "sourced_at_deployment": false,
204       "policy_editable": false,
205       "designer_editable": false
206     },
207     {
208       "name": "collector.schema.file",
209       "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\"}",
210       "description": "VES schema file name per version used for validation",
211       "designer_editable": true,
212       "sourced_at_deployment": false,
213       "policy_editable": false
214     },
215     {
216       "name": "event.transform.flag",
217       "value": 1,
218       "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",
219       "sourced_at_deployment": false,
220       "policy_editable": false,
221       "designer_editable": false
222     },
223     {
224       "name": "tomcat.maxthreads",
225       "value": "200",
226       "description": "Tomcat control for concurrent request",
227       "sourced_at_deployment": false,
228       "policy_editable": false,
229       "designer_editable": false
230     }
231   ],
232   "auxilary": {
233     "healthcheck": {
234       "type": "http",
235       "interval": "15s",
236       "timeout": "1s",
237       "endpoint": "/healthcheck"
238     },
239     "volumes": [
240       {
241         "container": {
242           "bind": "/opt/app/dcae-certificate"
243         },
244         "host": {
245           "path": "/opt/app/dcae-certificate"
246         }
247       },
248       {
249         "container": {
250           "bind": "/opt/app/VESCollector/logs"
251         },
252         "host": {
253           "path": "/opt/logs/DCAE/VESCollector/logs"
254         }
255       },
256       {
257         "container": {
258           "bind": "/opt/app/VESCollector/etc"
259         },
260         "host": {
261           "path": "/opt/logs/DCAE/VESCollector/etc"
262         }
263       }
264     ],
265     "ports": [
266       "8080:8080",
267       "8443:8443"
268     ]
269   },
270   "artifacts": [
271     {
272       "type": "docker image",
273       "uri": "nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:latest"
274     }
275   ]
276 }