diff options
| author |   Zlatko Murgoski <zlatko.murgoski@nokia.com> | 2019-07-09 10:25:56 +0200 |
|---|---|---|
| committer | Zlatko Murgoski <zlatko.murgoski@nokia.com> | 2019-07-09 12:09:19 +0200 |
| commit | ea8618348e120370e232bc0673a81a22d1d106bb (patch) | |
| tree | fb59c5fbedcc51a786e5c2af08d481d9b6db18e8 /README.md | |
| parent | a87bdbbd5496e08cfad5a6297e111a027123ea59 (diff) | |
VES Collecotr - update documentation
https://jira.onap.org/browse/DCAEGEN2-1656
Issue-ID: DCAEGEN2-1618
Signed-off-by: Zlatko Murgoski <zlatko.murgoski@nokia.com>
Change-Id: I5cf0eb5a82ff259c13a091002c2b8eebdac46b43
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 18 insertions, 4 deletions
@@ -18,10 +18,20 @@ mvn clean install ``` ### Running Locally +VES Collector is a Spring Boot application +``` +mvn spring-boot:run + +``` Build the image (it will go into your local docker repository) ``` mvn clean package + +``` +Run the image using docker +``` +docker run -p 8080:8080 -p 8443:8443 <container_id> ``` Run the image using docker-compose.yml @@ -29,11 +39,11 @@ Run the image using docker-compose.yml docker-compose up ``` -### Generate auth credential +### Generate auth credential Library to generate new cryptographic password is stored in dcaegen2/sdk -"security/crypt-password" -or download artifact from: +or download artifact from: https://nexus.onap.org/#nexus-search;quick~crypt-password @@ -42,6 +52,10 @@ How to use: java -jar crypt-password-<version>.jar password_to_crypt ``` +### Mechanism to validate Certificate Subject DN value +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. +Default regexp value is .* means that we approve all SubjectDN values. + ### Environment variables in Docker Container Most of the configuration of how VESCollector should be started and managed is done through environment variables. Some of them are set during the image build process and some of them are defined manually or by @@ -62,7 +76,7 @@ The main directory where all code resides in docker container looks like this and is located in /opt/app/VESCollector ``` <host>:/opt/app/VESCollector# ls -Dockerfile bin etc lib logs specs tomcat.8080 +Dockerfile bin etc lib logs specs ``` - bin contains sh scripts (path here is denoted by env var $SCRIPTS_PATH) - etc contains various application configuration, most notably it reflects 'etc' directory from repository @@ -85,7 +99,7 @@ and loops indefinitely to hold the docker container process. ### Release images For R1 - image/version pushed to nexus3 ``` -nexus3.onap.org:10003/snapshots/onap/org.onap.dcaegen2.collectors.ves.vescollector 1.1 +nexus3.onap.org:10003/snapshots/onap/org.onap.dcaegen2.collectors.ves.vescollector:<version> ``` ### Deployment |