2 ======================================
4 This is the repository for VES Collector for Open DCAE.
6 Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages into DCAE. The collector verifies the source (when authentication is enabled) and validates the events against VES schema before distributing to DMAAP MR topics for downstream system to subscribe. The VESCollector also provides configurable event transformation function and event distribution to DMAAP MR topics.
8 The collector supports individual events or eventbatch posted to collector end-point(s) and post them to interface/bus for other application to subscribe.
11 ### Build Instructions
13 This project is organized as a mvn project and has "org.onap.dcaegen2" as parent project. The build generate a jar and package into docker container.
16 git clone ssh://vv770d@gerrit.onap.org:29418/dcaegen2/collectors/ves
21 VES Collector is a Spring Boot application
27 Build the image (it will go into your local docker repository)
32 Run the image using docker
34 docker run -p 8080:8080 -p 8443:8443 <container_id>
37 Run the image using docker-compose.yml
42 ### Generate auth credential
44 Library to generate new cryptographic password is stored in dcaegen2/sdk -"security/crypt-password"
46 or download artifact from:
48 https://nexus.onap.org/#nexus-search;quick~crypt-password
52 java -jar crypt-password-<version>.jar password_to_crypt
55 ### Mechanism to validate Certificate Subject DN value
56 When application is in certOnly or certBasicAuth mode then certificates are also validated by regexp in certSubjectMatcher.properties, only SubjectDn field in certificate description are checked.
57 Default regexp value is .* means that we approve all SubjectDN values.
59 ### Environment variables in Docker Container
60 Most of the configuration of how VESCollector should be started and managed is done through environment variables.
61 Some of them are set during the image build process and some of them are defined manually or by
62 a particular deployment system.
64 Variables set manually / coming from deployment system:
66 - DMAAPHOST - should contain an address to DMaaP, so that event publishing can work
67 - CBSPOLLTIMER - it should be put in here if we want to automatically fetch configuration from CBS.
68 - CONSUL_PROTOCOL - Consul protocol by default set to **http**, if it is need to change it then that can be set to different value
69 - CONSUL_HOST - used with conjunction with CBSPOLLTIMER, should be a host address (without port! e.g my-ip-or-host) where Consul service lies
70 - CBS_PROTOCOL - Config Binding Service protocol by default set to **http**, if it is need to change it then that can be set to different value
71 - CONFIG_BINDING_SERVICE - used with conjunction with CBSPOLLTIMER, should be a name of CBS as it is registered in Consul
72 - HOSTNAME - used with conjunction with CBSPOLLTIMER, should be a name of VESCollector application as it is registered in CBS catalog
74 ### Docker file system layout
75 The main directory where all code resides in docker container
76 looks like this and is located in /opt/app/VESCollector
78 <host>:/opt/app/VESCollector# ls
79 Dockerfile bin etc lib logs specs
81 - bin contains sh scripts (path here is denoted by env var $SCRIPTS_PATH)
82 - etc contains various application configuration, most notably it reflects 'etc' directory from repository
83 - lib contains all libraries that are pulled into the app during maven build
84 - logs contains all application logs, especially collector.log file which is a main log file denoted by $MAIN_LOG_FILE variable
85 - specs contains json schemas specs for ves-collector
87 ## Managing application in Docker container
88 Scripts directory contain .sh scripts that are used to start & stop & configure the VESCollector application
89 inside the docker image.
90 These scripts are packaged inside the docker image by a mvn assembly & docker plugins.
92 ## How the application starts inside container
93 General flow goes like this
94 - Docker image is build, and it points docker-entry.sh as the entrypoint.
95 - Docker-entry point, depending on the deployment type,
96 configures a bunch of things and starts the application in a separate process
97 and loops indefinitely to hold the docker container process.
100 For R1 - image/version pushed to nexus3
102 nexus3.onap.org:10003/snapshots/onap/org.onap.dcaegen2.collectors.ves.vescollector:<version>
107 VESCollector in DCAE will be deployed as mS via DCAEGEN2 controller. A blueprint will be generated (CLAMP/SDC) which will fetch the docker image and install on the dockerhost identified. VESCollector on startup will query the configbindingService for updated configuration and starts the service. When configuration change is detected by DCAEGEN2 controller (via policy flow) - then contoller will notify Collector to fetch new configuration again.
109 For testing purpose, the docker image includes preset configuration which can be ran without DCAEGEN2 platform.
113 ### Consul - Dynamic configuration
116 Application properties like /etc/collector.properties and Dmaap configuration /etc/DmaapConfig.json are updated frequently by configuration stored in Consul(CBS) http://<kubernetes_host_ip>:30270/ui/#/dc1/kv/<vescollector_SCN>
117 Configuration stored in Consul have bigger priority and always will override local configuration so all configuration modification should be done using Consul update on corresponding kv store.
118 Frequently how often configuration will be fetch from Consul server is manageable in /etc/collector.properties property "collector.dynamic.config.update.frequency={time in minutes}".
120 Sample configuration of VESCollector K-V store can be found under /dpo/data-formats/ConsulConfig.json
125 For R1 as only measurement and faults are expected in ONAP, configuration are preset currently sto support these two topics only.
129 1) Get the VESCollector image from Nexus
130 docker pull nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:latest
131 2) Start the container (change the DMAAPHOST environment value to running DMAAP instance host)
132 docker run -d -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST='10.0.0.174' nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
133 3) Login into container and tail /opt/app/VESCollector/logs/collector.log
134 4) Simulate event into VEScollector (can be done from different vm or same)
135 curl -i -X POST -d @measurement.txt --header "Content-Type: application/json" https://localhost:8443/eventListener/v5 -k
136 or curl -i -X POST -d @measurement.txt --header "Content-Type: application/json" http://localhost:8080/eventListener/v5 -k
137 Note: If DMAAPHOST provided is invalid, you will see exception around publish on the collector.logs (collector queues and attempts to resend the event hence exceptions reported will be periodic). If you don’t want to see the error, publish to dmaap can be disabled by changing either “collector.dmaap.streamid” on etc/collector.properties OR by modifying the “name” defined on etc/DmaapConfig.json.
139 Any changes to property within container requires collector restart
140 cd /opt/app/VESCollector/
141 ./bin/appController.sh stop
142 ./bin/appController.sh start
144 5) If DMAAP instance (and DMAAPHOST passed during VESCollector startup) and VES input is valid, then events will be pushed to below topics depending on the domain
145 Fault :http://<dmaaphost>:3904/events/unauthenticated.SEC_FAULT_OUTPUT
146 Measurement : http://<dmaaphost>:3904/events/unauthenticated.SEC_MEASUREMENT_OUTPUT
147 6) When test is done – do ensure to remove the container (docker rm -f <containerid>) to avoid port conflict
150 Authentication is set by default to "noauth" (via auth.method property) on the container; below are the steps for enabling HTTPS/authentication for VESCollector.
152 1) Login to the container
153 2) Open /opt/app/VESCollector/etc/collector.properties and edit below properties
154 a) Comment below property (with authentication enabled, standard http should be disabled)
155 collector.service.port=8080
156 b) Enable basic-authentication
157 auth.method=basicAuth
158 Note: The actual credentials is stored part of header.authlist parameter. This is list of userid,password values. Default configuration has below set
159 sample1,$2a$10$pgjaxDzSuc6XVFEeqvxQ5u90DKJnM/u7TJTcinAlFJVaavXMWf/Zi|vdnsagg,$2a$10$C45JhiRSY.qXTBfzWST3Q.AmwKlPRMc67c33O0U9hOH8KSGaweN4m
160 where password maps to same value as username.
161 Password is generated by crypt-password tool (https://nexus.onap.org/#nexus-search;quick~crypt-password)
162 3) Restart the collector
163 cd /opt/app/VESCollector
164 ./bin/appController.sh stop
165 ./bin/appController.sh start
166 4) Exit from container and ensure tcp port on VM is not hanging on finwait – you can execute “netstat -an | grep 8443” . If under FIN_WAIT2, wait for server to release.
167 5) Simulate via curl (Note - username/pwd will be required)
168 Example of successfull POST:
169 vv770d@osdcae-dev-16:~$ curl -i -u 'sample1:sample1' -X POST -d @volte.txt --header "Content-Type: application/json" https://localhost:8443/eventListener/v5 -k
171 Server: Apache-Coyote/1.1
172 X-Rathravane: ~ software is craft ~
173 Content-Type: application/json;charset=ISO-8859-1
175 Date: Thu, 21 Sep 2017 22:23:49 GMT
178 Example of authentication failure:
179 vv770d@osdcae-dev-16:~$ curl -i -X POST -d @volte.txt --header "Content-Type: application/json" https://localhost:8443/eventListener/v5 -k
180 HTTP/1.1 401 Unauthorized
181 Server: Apache-Coyote/1.1
182 X-Rathravane: ~ software is craft ~
183 Content-Type: application/json;charset=ISO-8859-1
185 Date: Thu, 21 Sep 2017 22:20:43 GMT
187 {"requestError":{"GeneralException":{"MessagID":"\"POL2000\"","text":"\"Unauthorized user\""}}}
189 Note: In general support for HTTPS also require certificate/keystore be installed on target VM with FS mapped into the container for VESCollector to load. For demo and testing purpose - a self signed certificate is included within docker build. When deployed via DCAEGEN2 platform - these configuration will be overridden dynamically to map to required path/certificate name. This will be exercised post R1 though.
192 A client's certificate verification is disabled on the container by default; below are the steps for enabling mutual TLS authentication for VESCollector.
194 1) Login to the container
195 2) Open /opt/app/VESCollector/etc/collector.properties and edit below properties
196 a) Comment below property (with authentication enabled, standard http should be disabled)
197 collector.service.port=8080
198 b) Enable a client's certificate verification
199 auth.method=certOnly (only certificate verification)
201 auth.method=certBasicAuth ( certificate verification with basic auth verification )
202 3) Restart the collector
203 cd /opt/app/VESCollector
204 ./bin/appController.sh stop
205 ./bin/appController.sh start
206 4) Exit from container and ensure tcp port on VM is not hanging on finwait – you can execute “netstat -an | grep 8443” . If under FIN_WAIT2, wait for server to release.
207 5) In order for VESCollector to accept a connection from a client, the client has to use TLS certificate signed by CA that is present in VESCollector truststore. If a default VESCollector truststore is used then a client's certificate may be generated using following steps:
208 a) Generate a client's private key
209 openssl genrsa -out client.key 2048
210 b) Create the signing
211 openssl req -new -key client.key -out client.csr
212 c) Create the client's certificate (CA key password should be obtained from [VESCollectorRepository]/certs/password)
213 openssl x509 -req -in client.csr -CA [VESCollectorRepository]/certs/rootCA.crt -CAkey [VESCollectorRepository]/certs/rootCA.key -CAcreateserial -out client.crt -days 500 -sha256
214 6) Simulate via curl (assuming that the certificate was created via step 5)
215 Example of successfull POST:
216 curl -i -X POST -d @event.json --header "Content-Type: application/json" https://localhost:8443/eventListener/v7 -k --cert client.crt --key client.key
220 Content-Type: application/json
222 Date: Wed, 21 Nov 2018 11:37:58 GMT
224 Example of authentication failure (without a client's certificate):
225 curl -i -X POST -d @event.json --header "Content-Type: application/json" https://localhost:8443/eventListener/v7 -k
226 curl: (35) error:14094412:SSL routines:ssl3_read_bytes:sslv3 alert bad certificate