diff options
| author |   Vijay VK <vv770d@att.com> | 2019-05-23 22:02:50 +0100 |
|---|---|---|
| committer | VENKATESH KUMAR <vv770d@att.com> | 2019-05-23 17:03:20 -0400 |
| commit | edaf8b1d69fa97862bd246dc61c1e4e77a01b5be (patch) | |
| tree | e0a5f257e641e41e6a809a038fe6acec9e1c33d6 /docs/sections/services/ves-http | |
| parent | f9e4344e9c9834face106b6c153ede020ff5410f (diff) | |
Fix doc issues
Change-Id: I711a40a64a1d47b50f0923ba67b02ad121ace5b4
Signed-off-by: VENKATESH KUMAR <vv770d@att.com>
Issue-ID: DCAEGEN2-1505
Diffstat (limited to 'docs/sections/services/ves-http')
| -rw-r--r-- | docs/sections/services/ves-http/architecture.rst | 8 | ||||
| -rw-r--r-- | docs/sections/services/ves-http/installation.rst | 4 | ||||
| -rw-r--r-- | docs/sections/services/ves-http/tls-authentication.rst | 4 |
3 files changed, 10 insertions, 6 deletions
diff --git a/docs/sections/services/ves-http/architecture.rst b/docs/sections/services/ves-http/architecture.rst index 29077afe..41f3e8f1 100644 --- a/docs/sections/services/ves-http/architecture.rst +++ b/docs/sections/services/ves-http/architecture.rst @@ -7,13 +7,13 @@ VES Architecture .. image:: ./ves-deployarch.png VES Processing Flow -=================== +------------------- .. image:: ./VES-processingFlow.png VES Schema Validation -===================== +--------------------- VES Collector is configured to support below VES Version; the corresponding API uses VES schema definition for event validation. @@ -30,7 +30,7 @@ Schema definition files are contained within VES collector gerrit repo - https:/ Features Supported -================== +------------------ - VES collector deployed as docker containers - Acknowledgement to sender with appropriate response code (both successful and failure) - Authentication of the events posted to collector (support 4 types of authentication setting) @@ -45,7 +45,7 @@ The collector can receive events via standard HTTP port (8080) or secure port (8 Dynamic configuration fed into Collector via DCAEPlatform -========================================================= +--------------------------------------------------------- - Outbound Dmaap/UEB topic - Schema version to be validated against diff --git a/docs/sections/services/ves-http/installation.rst b/docs/sections/services/ves-http/installation.rst index 9a627df3..b39b007d 100644 --- a/docs/sections/services/ves-http/installation.rst +++ b/docs/sections/services/ves-http/installation.rst @@ -4,6 +4,10 @@ Installation ============ +VESCollector is installed via cloudify blueprint by DCAE bootstrap process on typical ONAP installation. +As the service is containerized, it can be started on stand-alone mode also. + + To run VES Collector container on standalone mode, following parameters are required ``docker run -d -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST='10.0.11.1' nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2`` diff --git a/docs/sections/services/ves-http/tls-authentication.rst b/docs/sections/services/ves-http/tls-authentication.rst index b5226dc5..ad8d8d22 100644 --- a/docs/sections/services/ves-http/tls-authentication.rst +++ b/docs/sections/services/ves-http/tls-authentication.rst @@ -1,8 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -Certificates as authentication method for PNFs/VNFs -=================================================== +Authentication Types +==================== VES supports mutual TLS authentication via X.509 certificates. If VES is deployed via docker image then VES configuration can be modified by editing */opt/app/VESCollector/etc/collector.properties* which is present on the docker container. VES detects changes made to the mentioned file automatically and restarts the application. |