blob: 5994255bb2a8c747f0c8dd33069d8419daa85a69 [file] [log] [blame]
Vijay VK86cd8932018-10-23 16:35:29 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4VES Architecture
5===================
6
7.. image:: ./ves-deployarch.png
8
9VES Processing Flow
10===================
11
12.. image:: ./VES-processingFlow.png
13
14
15VES Schema Validation
16=====================
17
18VES Collector is configured to support below VES Version; the corresponding API uses VES schema definition for event validation.
19
Vijay VKf6659fc2018-11-02 05:07:27 +010020=========== ================ ==================================
21VES Version API version Schema Definition
22=========== ================ ==================================
23VES 1.2 eventListener/v1 CommonEventFormat_Vendors_v25.json
24VES 4.1 eventListener/v4 CommonEventFormat_27.2.json
25VES 5.4 eventListener/v5 CommonEventFormat_28.4.1.json
26VES 7.0 eventListener/v7 CommonEventFormat_30.0.1.json
27=========== ================ ==================================
Vijay VK86cd8932018-10-23 16:35:29 +010028
29Schema definition files are contained within VES collector gerrit repo - https://git.onap.org/dcaegen2/collectors/ves/tree/etc
30
31
32Features Supported
33==================
34- VES collector deployed as docker containers
35- Acknowledged the sender with appropriate response code (both successful and failure)
36- Authentication of the events posted to collector
37- Support single or batch JSON events input
38- Schema validation (against standard VES definition)
39- Multiple schema support and backward compatibility
40- Configurable event transformation
41- Configurable suppression
42- Publish events into Dmaap Topic (with/without AAF)
43
44The collector can receive events via standard HTTP port (8080) or secure port (8443). Depending on the install/configuration either one or both can be supported (ports are also modifiable).
45
46
47Dynamic configuration fed into Collector via DCAEPlatform
48=========================================================
49
50- Outbound Dmaap/UEB topic
51- Schema version to be validated against
52- Authentication account for VNF
53
54POST requests result in standard HTTP status codes:
55
56200-299 Success
57400-499 Client request has a problem (data error)
58500-599 Collector service has a problem
59
60