Update README of CertServiceClient

[oom/platform/cert-service.git] / certServiceClient / README.md

diff --git a/certServiceClient/README.md b/certServiceClient/README.md
index 092eb32..d1650a7 100644 (file)
--- a/certServiceClient/README.md
+++ b/certServiceClient/README.md
@@ -5,11 +5,6 @@
 mvn clean package
 ```
     
-### Building Docker image manually
-Go to the certServiceClient subfolder and execute following statement (1.0.0-SNAPSHOT is related to a current project.version parameter):
-```
-docker build --build-arg VERSION=1.0.0-SNAPSHOT -t onap/org.onap.aaf.certservice.aaf-certservice-client .
-```
     
 ### Install the package into the local repository
 ```
@@ -21,39 +16,18 @@ mvn clean install
 mvn clean install -P docker
 ```   
 
-### Running Docker container local
+### Nexus container image
 ```
-docker run --name aaf-certservice-client onap/org.onap.aaf.certservice.aaf-certservice-client
+nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest
 ```
 
-### Running Docker container from nexus
-```
-docker run --name aaf-certservice-client nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:1.0.0
-```
+### Running local client application as standalone docker container
+CertService API and client must be running in same network.
+
+You need certificate and trust anchors (in JKS format) to connect to CertService API via HTTPS. Information how to generate truststore and keystore files you can find in CertService main README.
+
+Information how to run you can find in CertService main README and official documentation, see [Read The Docs](https://onap-doc.readthedocs.io/projects/onap-aaf-certservice/en/latest/sections/usage.html)
 
-### Running client as standalone docker container
-```
-AAFCERT_CLIENT_IMAGE=nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest
-DOCKER_ENV_FILE= <path to envfile>
-NETWORK_CERT_SERVICE= <docker network of cert service>
- 
-docker run --env-file $DOCKER_ENV_FILE --network $NETWORK_CERT_SERVICE $AAFCERT_CLIENT_IMAGE
-```
-Sample Environment file:
-```aidl
-#Client envs
-REQUEST_TIMEOUT=1000
-OUTPUT_PATH=/var/log
-CA_NAME=RA
-#Csr config envs
-COMMON_NAME=onap.org
-ORGANIZATION=Linux-Foundation
-ORGANIZATION_UNIT=ONAP
-LOCATION=San-Francisco
-STATE=California
-COUNTRY=US
-SANS=example.com:example2.com
-```
 
 ### Logs locally
 
@@ -69,11 +43,12 @@ docker logs aaf-certservice-client
 ```
 0      Success
 1      Invalid client configuration
-2      Invalid CSR data 
-3      Failed key pair generation
-4      Failed CSR generation
-5      API return unsuccessful response
-6      Problem with Http Client connection
-7      Failed PKCS12 conversion
-8      Failed Private Key to PEM Encoding
-```
\ No newline at end of file
+2      Invalid CSR configuration 
+3      Fail in key pair generation
+4      Fail in  CSR generation
+5      CertService HTTP unsuccessful response
+6      Internal HTTP Client connection problem
+7      Fail in PKCS12 conversion
+8      Fail in Private Key to PEM Encoding
+9      Wrong TLS configuration
+10     File could not be created