aboutsummaryrefslogtreecommitdiffstats
path: root/trustStoreMerger/README.md
diff options
context:
space:
mode:
authorPiotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com>2020-09-08 11:41:48 +0200
committerPiotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com>2020-09-10 14:02:35 +0200
commit3597a5aa1cd89d8af552e7e3853d7730189d7a1f (patch)
treef5a75a3773da8382a8c9cfef2d422ef8f8cb7acd /trustStoreMerger/README.md
parentc22f36d5847b75e436a0acbe370a9e1c96008b1d (diff)
Update readme
- Add descrption copier env functionality Issue-ID: DCAEGEN2-2253 Signed-off-by: Piotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com> Change-Id: If83fbae1fb4ff37f5abbf4e53155e33fd798bb0f
Diffstat (limited to 'trustStoreMerger/README.md')
-rw-r--r--trustStoreMerger/README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/trustStoreMerger/README.md b/trustStoreMerger/README.md
index dff8a145..5a2c2b47 100644
--- a/trustStoreMerger/README.md
+++ b/trustStoreMerger/README.md
@@ -26,12 +26,18 @@ Exemplary config.env file with necessary envs
```
TRUSTSTORES_PATHS=/var/certs/truststore.jks:/var/certs/truststore.pem
TRUSTSTORES_PASSWORDS_PATHS=/var/certs/truststoreJks.pass:
+KEYSTORE_SOURCE_PATHS=/var/certs/external/keystore.jks:/var/certs/external/keystore.pass
+KEYSTORE_DESTINATION_PATHS=/var/certs/cert.jks:/var/certs/jks.pass
```
TRUSTSTORES_PATHS env indicates paths (separated by ":") where truststores files are located.
TRUSTSTORES_PASSWORDS_PATHS env indicates paths (separated by ":") where files with passwords to truststores are located.
PEM is not protected by password so its value should be empty
+KEYSTORE_SOURCE_PATHS env (optional) indicates paths (separated by ":") where files to copy are located.
+
+KEYSTORE_DESTINATION_PATHS env (optional) indicates paths (separated by ":") to files which should be replaced. Before keystore files override, destination files will be copied with addition of .bak extension.
+
Execute below command in order to run app as docker container
```
docker run \
@@ -42,9 +48,10 @@ onap/org.onap.oom.platform.cert-service.oom-truststore-merger:latest
```
Before run replace <src_path> with absolute path where you located truststores to merge (eg. /certs/resources/)
-Output from merger (when pointed more than one truststore to merge in TRUSTSTORES_PATHS env) success execution should be:
+Output from merger (when pointed more than one truststore to merge in TRUSTSTORES_PATHS env and provided optional envs) success execution should be:
1. Created backup file (with .bak ext) of first truststore pointed in TRUSTSTORES_PATHS env
-2. First truststore pointed in TRUSTSTORES_PATHS env contains merged certificates from all truststores mentioned in TRUSTSTORES_PATHS env
+2. Keystores files listed in KEYSTORE_SOURCE_PATHS env overrides corresponding to them files defined in KEYSTORE_DESTINATION_PATHS env.
+3. Keystores listed in KEYSTORE_SOURCE_PATHS env are in locations taken from KEYSTORE_DESTINATION_PATHS env. Files listed in KEYSTORE_DESTINATION_PATHS env before application run, still exist with appended .bak extension.
Remove docker container:
```
@@ -75,3 +82,6 @@ docker logs oom-merger
9 Missing truststore certificates in provided file
10 Alias conflict detected
11 Cannot save truststore file
+12 Cannot copy keystore file
+13 Keystore file does not exist
+99 Application exited abnormally